The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Table 3-1 provides a summary of the proxy commands. Each command is described in detail in the section that is listed.
http://host/command.bwt?command=start&type=proxy&name=proxyName
&source=id@host&srctype=device&mediatype=codec
&quality=qualNum&framerate=rateNum&width=widthNum&height=heightNum
&bitrate=rateNum&username=name&password=password
&resolution=resVal&format=format&udp=udpNum&multicast=multicastIPAddress
Starts a proxy process on a media server that establishes a connection to a media source (such as an IP camera, an encoder, or another proxy) and writes media data to shared memory.
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. •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." |
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[proxy name] or -1 or output>
[proxy name] Successful completion of the URL command
-1 Error in execution of the URL command
The video source can be an IP camera, an encoding device, or another proxy. Parent-child proxies can be nested indefinitely as resources permit.
Some encoding devices may not support all available bitrate, framerate, resolution, or quality settings. Be sure to use settings supported by your encoding device. For more information about the supported settings for the encoding device, see "Supported Media Devices."
The following example starts a video proxy using the required fields. The proxy named basicProxy runs on the host named vsms.cisco.com, the video source is video input 1 of the device with IP address 192.168.200.20:
http://vsms.cisco.com/command.bwt?command=start&type=proxy&name=basicProxy
&srctype=c&type=jpeg&source=1@192.168.200.20
http://host/command.bwt?command=update&type=proxy&name=proxyName
&source=id@host&srctype=device&mediatype=codec&framerate=rateNum
&width=widthNum&height=heightNum&bitrate=rateNum&username=name
&password=password&resolution=resVal&format=format
Updates an existing proxy with different parameter values. For example, updating a proxy to a different source seamlessly changes the feed being viewed by all clients.
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. •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 •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. |
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[proxy name] or -1 or output>
[proxy name] Successful completion of the URL command
-1 Error in execution of the URL command
The following example updates the proxy named Front_Office on vsms.cisco.com to use a framerate of 10 frames per second:
http://vsms.cisco.com/command.bwt?command=update&source=1@camera.cisco.com&type=proxy&srct ype=proxy&name=Front_Office&framerate=10
http://host/command.bwt?command=stop&type=proxy&name=proxyName
Stops a running proxy and all archives accessing the media data written to shared memory by the proxy.
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[proxy name] or -1 or output>
[proxy name] Successful completion of the URL command
-1 Error in execution of the URL command
The following example stops the proxy named officeCam and any archives running against that proxy on the VSMS host.
http://vsms.cisco.com/command.bwt?command=stop&type=proxy&name=officeCam
http://host/video.jpg?source=proxyName&framerate=rateNum
Displays JPEG frames from a proxy. This command only applies to MPJEG video streams.
The following example views the JPEG frames from the MJPEG proxy named officeCam.
http://vsms.cisco.com/video.jpg?source=officeCam&framerate=0
http://host/info.bwt?type=proxy&name=proxyName&display=dispFormat
Displays a list of all proxies running on a VSMS host.
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[Proxy List] or -1 or output>
[Proxy List] Successful completion of the URL command
-1 Error in execution of the URL command
Listing All Running Proxies
The following example retrieves a list in SSV format of all running proxies on the host named vsms.cisco.com:
http://vsms.cisco.com/info.bwt?type=proxy&display=ssv
Listing A Single Proxy
The following example retrieves the details in TEXT format of a proxy named officeCam running proxies on the host named vsms.cisco.com:
http://vsms.cisco.com/info.bwt?type=proxy&name=officeCam&display=text
http://host/info.bwt?type=proxy&name=proxyName&property=source
Retrieves device information for a proxy, The return value is in plain text format can be in one of the following media sources:
•Video input number of an IP camera or encoder
•Video input number and feed number (separated by an underscore) of an IP camera or encoder
•Name of a parent proxy
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[name@address:port] or -1 or output>
[name@address:port] Successful completion of the URL command
-1 Error in execution of the URL command
The following example retrieves device information for proxy 1036:
http://vsms.cisco.com/info.bwt?type=proxy&name=1036&property=source
http://host/info.bwt?type=proxy&name=proxyName&property=mediatype
Retrieves the encoding media type value for a proxy.
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[Media type] or -1 or output>
[Media type] Successful completion of the URL command
-1 Error in execution of the URL command
The following example retrieves the encoding media type value for the proxy named officeCam:
http://vsms.cisco.com/info.bwt?type=proxy&name=officeCam&property=mediatype
http://host/info.bwt?type=proxy&name=proxyName&property=rate
Retrieves the framerate value for a JPEG proxy or the bitrate value for an MPEG proxy. The return value is in plain text format.
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[framerate | bitrate] or -1 or output>
[framerate | bitrate] Successful completion of the URL command
-1 Error in execution of the URL command
The following example retrieves the bitrate or framerate value, which depends on the encoding media type (MJPEG or MPEG), for the proxy named officeCam:
http://vsms.cisco.com/info.bwt?type=proxy&name=officeCam&property=rate
http://host/info.bwt?type=proxy&name=proxyName&property=quality
Retrieves the quality value for an MJPEG proxy. The return value is in plain text format.
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[1-100] or -1 or output>
[1-100] Successful completion of the URL command
-1 Error in execution of the URL command
Error String: <error-message>
The following example retrieves the quality value for the proxy named fooProxy:
http://vsms.cisco.com/info.bwt?type=proxy&name=fooProxy&property=quality
http://host/info.bwt?type=proxy&name=proxyName&property=width
Retrieves the width in pixels for a video proxy. The return value is in plain text format.
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[Pixel width] or -1 or output>
[Pixel width] Successful completion of the URL command
-1 Error in execution of the URL command
The following example retrieves the video width in pixels for the proxy named officeCam:
http://vsms.cisco.com/info.bwt?type=proxy&name=officeCam&property=width
http://host/info.bwt?type=proxy&name=proxyName&property=height
Retrieves the height in pixels for a video proxy. The return value is in plain text format.
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[Pixel height] or -1 or output>
[Pixel height] Successful completion of the URL command
-1 Error in execution of the URL command
The following example retrieves the video height in pixels for proxy 1036:
http://vsms.cisco.com/info.bwt?type=proxy&name=1036&property=height
http://host/info.bwt?type=proxy&name=proxyName&property=model
Retrieves the model number for a proxy media source. The return value is in plain text format.
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[1-200] or -1 or output>
[1-200] Successful completion of the URL command
-1 Error in execution of the URL command
The following example retrieves the model number for proxy 1036:
http://vsms.cisco.com/info.bwt?type=proxy&name=1036&property=model
http://host/info.bwt?type=proxy&name=proxyName&property=status
Retrieves the status (running, stopped, or suspended) for a proxy. The return value is in plain text format and can be one of the following reserved keywords:
•Running—Proxy is running normally
•Stopped—Failed due to an error. A proxy stopped by a stop proxy command would not be listed here
•Suspended—Proxy is in a postponed state
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[Running | Stopped | Suspended] or -1 or output>
[Running | Stopped | Suspended] Successful completion of the URL command
-1 Error in execution of the URL command
The following example retrieves the status for proxy 1036:
http://vsms.cisco.com/info.bwt?type=proxy&name=1036&property=status
http://host/info.bwt?type=proxy&name=proxyName&property=device
Retrieves the current device information for a proxy. The return value is in plain text format.
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[Device name] or -1 or output>
[Device name] Successful completion of the URL command
-1 Error in execution of the URL command
The following example retrieves the current device information for proxy 1036:
http://vsms.cisco.com/info.bwt?type=proxy&name=1036&property=device
http://host/info.bwt?type=framesize&name=proxyName
Retrieves the frame size of a proxy. The return value is in plain text format.
A standard HTTP/1.x header followed by:
Content-Type: text/plain
Return Code: <[Device name] or -1 or output>
[Device name] Successful completion of the URL command
-1 Error in execution of the URL command
The following example retrieves the current device information for proxy 1036:
http://vsms.cisco.com/info.bwt?type=proxy&name=1036&property=device