Cisco Video Surveillance Manager API Reference, Release 6.3.2

Start Proxy

Starts a proxy process on a media server that establishes a connection to a media source and writes media data to shared memory.

Update Proxy

Updates an existing proxy with different parameter values.

Stop Proxy

Stops a running proxy and all archives accessing the media data written to shared memory by the proxy.

View JPEG Frames

Displays JPEG frames from a proxy.

List All Proxies

Displays a list of all proxies running on a VSMS host.

Get Proxy Source

Retrieves the media source value for a proxy,

Get Proxy Media Type

Retrieves the media type value for a proxy.

Get Proxy Framerate or Bitrate

Retrieves the framerate value for a JPEG proxy or the bitrate value for an MPEG or audio proxy.

Get MJPEG Proxy Quality

Retrieves the quality value for a JPEG proxy.

Get Proxy Video Width

Retrieves the width in pixels for a video proxy.

Get Proxy Video Height

Retrieves the height in pixels for a video proxy.

Get Proxy Model

Retrieves the model ID value for a proxy media source.

Get Proxy Status

Retrieves the status value for a proxy.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

command=start

Start command. The start keyword associates the command with a start action, in this case a start proxy action. The start keyword is a reserved value.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

source=id@host

Video source where id@host specifies the channel number and IP address of a video source. The id value can be one of the following:

•Video input number of the IP camera or encoder. Valid values are 1 to 64.

•Video input number and feed number (separated by an underscore) of the IP camera or encoder. This option applies only to video sources that support dual streaming. Valid input number values are 1 to 64. Valid feed number values are 1 and 2.

•Name of the parent proxy. This option applies only to parent-child proxy configurations. The valid value is an alphanumeric string containing 1 to 256 of the following characters:

–Digits (0 to 9)

–Upper case letters (A to Z)

–Lower case letters (a to z)

–Underscore (_)

–Hyphen (-)

The reserved value is -1.

For example:

–10.10.10.1

–1@10.10.10.1

–1_1@10.10.10.1.

The host value is the IP address or hostname (hostname.domain) for the video source. You can optionally specify a port number with the IP address or hostname. For example, to specify port 8080, use host:8080. If no port number is specified, port 80 is used by default.

Note For child proxies, the parent proxy name becomes the source.

srctype=device

Source type where device specifies the device to use as the media source for the proxy, such as a parent proxy, an encoder, or an IP camera. If the source is a parent proxy, the device value is proxy. For all other devices (encoders and IP cameras), the valid device values are listed in the Keyword column of Table B-1 in "Supported Media Devices."

mediatype=codec

Media type where codec specifies the codec used to encode the media. Valid codec values include the following reserved keywords:

•mjpeg

•mpeg2

•mpeg4

•h264

Note For more information about the supported devices for each media type, see "Supported Media Devices."

quality=qualNum

Quality of the feed where qualNum specifies the compression ratio (the quality of the JPEG feed), which depends on the device and media type. 200 is the highest possible quality. The range of valid values for the qualNum value is 1 to 200; the default value is 50.

framerate=rateNum

Framerate where rateNum specifies the maximum number of MJPEG frames transmitted per second. The default value is 5.

Note A child proxy cannot have a higher framerate value than the parent proxy.

width=widthNum

Width where widthNum specifies the width of the video feed in pixels, as supported by the device.

height=heightNum

Height where heightNum specifies the height of the video feed in pixels, as supported by the device.

bitrate=rateNum

Bitrate where rateNum specifies the Kilobytes transmitted per second for a video feed (applicable to non-MJPEG feeds). The minimum, maximum, and actual bitrates are device-dependent.

username=name

Username where name is the user name for an administrative user account of an encoding device, if required for authentication.

password=password

Password where password is the password for an administrative user account of an encoding device, if required for authentication.

resolution=resVal

Resolution where resVal specifies a predefined video width and height to use for the proxy, from the device.xml file. Valid resVal values include the following reserved keywords:

•cif—Common intermediate format (CIF). For example, 352 x 240 for NTSC or 352 x 288 for PAL.

•qcif—Quarter CIF. For example, 176 x 120 for NTSC or 176 x 144 for PAL.

•2cif—2 x CIF. For example, 704 x 240 for NTSC or 704 x 288 for PAL.

•4cif—4 x CIF. For example, 704 x 480 for NTSC or 704 x 576 for PAL.

•d1—Sony D-1. For example, 720 x 480 for NTSC or
720 x 576 for PAL.

•1M—1 megapixel. For example, 1024 x 768 for NTSC.

•2M—2 megapixel. For example, 1280 x 960 for NTSC.

•3M—3 megapixel. For example, 1280 x 1024 for NTSC.

•4M—4 megapixel. For example, 2272 x 1704 for NTSC.

•5M—5 megapixel. For example, 2560 x 1920 for NTSC.

format=format

Format where format specifies the video standard to use when determining the width and height of the video. Valid format values include the following reserved keywords:

•ntsc—Used mostly in the United States, Canada, and portions of South America and specifies 525 lines per frame with a 60 Hz refresh rate.

•pal—Used mostly in Europe, China, and Australia and specifies 625 lines per frame with a 50 Hz refresh rate.

udp=udpNum

Transport protocol where udpNum enables the TCP or UDP protocol for streams. Valid udpNum values are 0 (TCP) and 1 (UDP).

multicast=multicastIPAddress

Multicast host name where multicastIPAddress is the IP address or hostname (hostname.domain) of the device originating the multicast stream. To start or join a multicast stream, specify the multicast group name.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

command=update

Update command. The update keyword associates the command with an update action. The update keyword is a reserved value.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

source=id@host

Video source where id@host specifies the channel number and IP address of a video source. The id value can be one of the following:

•Video input number of the IP camera or encoder. Valid values are 1 to 64.

•Video input number and feed number (separated by an underscore) of the IP camera or encoder. This option applies only to video sources that support dual streaming. Valid input number values are 1 to 64. Valid feed number values are 1 and 2.

•Name of the parent proxy. This option applies only to parent-child proxy configurations. The valid value is an alphanumeric string containing 1 to 256 of the following characters:

–Digits (0 to 9)

–Upper case letters (A to Z)

–Lower case letters (a to z)

–Underscore (_)

–Hyphen (-)

The reserved value is -1.

For example:

–10.10.10.1

–1@10.10.10.1

–1_1@10.10.10.1.

The host value is the IP address or hostname (hostname.domain) for the video source. You can optionally specify a port number with the IP address or hostname. For example, to specify port 8080, use host:8080. If no port number is specified, port 80 is used by default.

Note For child proxies, the parent proxy name becomes the source.

srctype=device

Source type where device specifies the device to use as the media source for the proxy, such as a parent proxy, an encoder, or an IP camera. If the source is a parent proxy, the device value is proxy. For all other devices (encoders and IP cameras), the valid device values are listed in the Keyword column of Table B-1 in "Supported Media Devices."

mediatype=codec

Media type where codec specifies the codec used to encode the media. Valid codec values include the following reserved keywords:

•mjpeg

•mpeg2

•mpeg4

•h264

Note For more information about the supported devices for each media type, see "Supported Media Devices."

framerate=rateNum

Framerate where rateNum specifies the maximum number of MJPEG frames transmitted per second. The default value is 5.

Note A child proxy cannot have a higher framerate value than the parent proxy.

width=widthNum

Width where widthNum specifies the width of the video feed in pixels, as supported by the device.

height=heightNum

Height where heightNum specifies the height of the video feed in pixels, as supported by the device.

bitrate=rateNum

Bitrate where rateNum specifies the Kilobytes transmitted per second for a video feed (applicable to non-MJPEG feeds). The minimum, maximum, and actual bitrates are device-dependent.

username=name

Username where name is the user name for an administrative user account of an encoding device, if required for authentication.

password=password

Password where password is the password for an administrative user account of an encoding device, if required for authentication.

resolution=resVal

Resolution where resVal specifies a predefined video width and height to use for the proxy, from the device.xml file. Valid resVal values include the following reserved keywords:

•cif—Common intermediate format (CIF). For example, 352 x 240 for NTSC or 352 x 288 for PAL.

•qcif—Quarter CIF. For example, 176 x 120 for NTSC or 176 x 144 for PAL.

•2cif—2 x CIF. For example, 704 x 240 for NTSC or 704 x 288 for PAL.

•4cif—4 x CIF. For example, 704 x 480 for NTSC or 704 x 576 for PAL.

•d1—Sony D-1. For example, 720 x 480 for NTSC or
720 x 576 for PAL.

•1M—1 megapixel. For example, 1024 x 768 for NTSC.

•2M—2 megapixel. For example, 1280 x 960 for NTSC.

•3M—3 megapixel. For example, 1280 x 1024 for NTSC.

•4M—4 megapixel. For example, 2272 x 1704 for NTSC.

•5M—5 megapixel. For example, 2560 x 1920 for NTSC.

format=format

Format where format specifies the video standard to use when determining the width and height of the video. Valid format values include the following reserved keywords:

•ntsc—Used mostly in the United States, Canada, and portions of South America and specifies 525 lines per frame with a 60 Hz refresh rate.

•pal—Used mostly in Europe, China, and Australia and specifies 625 lines per frame with a 50 Hz refresh rate.

username=name

Username where the name value is the user name for an administrative user account of an encoding device.

Note The name value is required to do Camera Controls and Events Setup, and when user authentication is enabled for a device.

password=password

Password where the password value is the password for an administrative user account of an encoding device.

Note The password value is required to do Camera Controls and Events Setup, and when user authentication is enabled for a device.

format=format

Format where the format value specifies the video standard to use when determining the resolution of the video. Valid format values include the following reserved keywords:

•ntsc—Used mostly in the United States, Canada, and portions of South America and specifies 525 lines per frame with a 60 Hz refresh rate.

•pal—Used mostly in Europe, China, and Australia and specifies 625 lines per frame with a 50 Hz refresh rate.

Note The actual video size is determined by the resolution , format, and device driver settings for the source type (unless you specify the width and height).

The default format value is ntsc.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

command=stop

Stop command. The stop keyword associates the command with a stop action. The stop keyword is a reserved value.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

source=proxyName

Source proxy where proxyName specifies the proxy name for the MJPEG media source. The valid value is an alphanumeric string containing 1 to 256 of the following characters:

–Digits (0 to 9)

–Upper case letters (A to Z)

–Lower case letters (a to z)

–Underscore (_)

–Hyphen (-)

The reserved value is -1.

framerate=rateNum

Framerate where rateNum specifies the maximum number of MJPEG frames transmitted per second. The default value is 5.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

display=dispFormat

Displayformat where dispFormat specifies the format to use when displaying the list of running proxies. Valid dispFormat values include the following keywords:

•html—Hypertext markup language format

•text—Plain text format

•ssv—Space-separated value format

The default dispFormat value is html.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

property=source

Source property. The source keyword requests the source value for the specified proxy. The source keyword is a reserved value.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

property=mediatype

Media type property. The mediatype keyword requests the media type value for the specified proxy. The mediatype keyword is a reserved value.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

property=rate

Rate property. The rate keyword requests the the framerate or bitrate value for the specified proxy. The rate keyword is a reserved value.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

property=quality

Quality property. The quality keyword requests the quality value for the MJPEG proxy. The quality keyword is a reserved value.

Note This command only works for MJPEG proxies. For other media type proxies, an error is returned (-1).

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

property=width

Width property. The width keyword requests the width in pixels of the video stream. The width keyword is a reserved value.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

property=height

Height property. The height keyword requests the height in pixels of the video stream. The height keyword is a reserved value.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

property=model

Model property. The model keyword requests the model number of the device for the specified proxy. The model number is the unique proxy ID associated with the device. The model keyword is a reserved value.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

property=status

Status property. The status keyword requests the current status of the specified proxy. The status keyword is a reserved value.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

type=proxy

Proxy type. The proxy keyword specifies the proxy command type. The proxy keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.

property=device

Device property. The device keyword requests the device information for the specified proxy. The device keyword is a reserved value.

host

IP address or hostname (hostname.domain) where VSMS is running.

By default, VSMS runs on port 80 (HTTP), however, you can use an alternate port, such as port 8080. For example, to specify port 8080, use host:8080.

type=framesize

Frame size type. The framesize keyword requests the frame size for the proxy. The framesize keyword is a reserved value.

name=proxyName

Proxy name where proxyName specifies the name of the proxy instance and the name of the source for a child proxy.
The valid value for proxyName is an alphanumeric string containing 1 to 256 of the following characters:

•Digits (0 to 9)

•Upper case letters (A to Z)

•Lower case letters (a to z)

•Underscore (_)

•Hyphen (-)

The reserved proxyName value is -1.

Note Each proxy must have a unique name on a given VSMS host.