xStatus
xStatus
Description of the xStatus commands for Cisco TelePresence System Codec C90 with software version TC5.0
Revision: D1464707
The xStatus commands holds information about the current state of the codec, such as connected calls, the status of the gatekeeper registration, connected inputs and output sources. The commands are case-insensitive.
- Writing xStatus ? on the command line will list the top level status.
- Writing xStatus will list all status and the current values.
- To only list out parts of the statuses write xStatus followed by one or more parts of the status paths.
Returned information: The valuespace of the information that is returned, when you issue a command, is explained in the "Valuespace of the result returned" field.
String: The syntax of a string is <S: 0, 255>, which means that the length of this string can be from 0 to 255 characters.
Integer: The syntax of an integer is <0..100>, which means that this value can go from 0 to 100.
Troubleshooting: Check that the spelling and syntax is right. Check also that the values are valid, that all the required information is included, and that the command is valid for your product.
Read more about the Application Programmer Interface (API) in the API Guide for the codec. All specifications are subject to change without prior notice. We recommend you visit our web site regularly for updated versions of the user documentation. Go to: http://www.cisco.com/go/telepresence/docs and navigate to TelePresence Solutions Platform > TelePresence Integrator Products and select the Cisco TelePresence System Integrator C Series.
All contents are Copyright 2010 Cisco Systems, Inc. All rights reserved.
The xStatus Audio commands
Shows the top level overview of the audio status. The identities of the LocalInput, RemoteInput, LocalOutput and RemoteOutput are used when querying additional information.
Example:
xStatus Audio
*s Audio Microphones Mute: Off
*s Audio Volume: 60
*s Audio Input LocalInput 1 Name: "Microphone"
*s Audio Input LocalInput 1 MixerMode: "GainShared"
*s Audio Input LocalInput 1 Mute: "Off"
*s Audio Input LocalInput 1 Channels: 1
*s Audio Input LocalInput 1 AGC: "On"
*s Audio Input LocalInput 1 Connector: "Microphone.1"
*s Audio Input LocalInput 1 Connector: "Microphone.2"
*s Audio Input LocalInput 1 Connector: "Microphone.3"
*s Audio Input LocalInput 1 Connector: "Microphone.4"
*s Audio Input LocalInput 1 Connector: "Microphone.5"
*s Audio Input LocalInput 1 Connector: "Microphone.6"
*s Audio Input LocalInput 1 Connector: "Microphone.7"
*s Audio Input LocalInput 1 Connector: "Microphone.8"
*s Audio Input LocalInput 2 Name: "PC input"
*s Audio Input LocalInput 2 MixerMode: "Fixed"
*s Audio Input LocalInput 2 Mute: "Off"
*s Audio Input LocalInput 2 Channels: 2
*s Audio Input LocalInput 2 AGC: "Off"
*s Audio Input LocalInput 2 Connector: "Line.1"
*s Audio Input LocalInput 2 Connector: "Line.2"
*s Audio Input LocalInput 3 Name: "DVD input"
*s Audio Input LocalInput 3 MixerMode: "Fixed"
*s Audio Input LocalInput 3 Mute: "Off"
*s Audio Input LocalInput 3 Channels: 2
*s Audio Input LocalInput 3 AGC: "Off"
*s Audio Input LocalInput 3 Connector: "Line.3"
*s Audio Input LocalInput 3 Connector: "Line.4"
*s Audio Input LocalInput 4 Name: "DVD input"
*s Audio Input LocalInput 4 MixerMode: "Fixed"
*s Audio Input LocalInput 4 Mute: "Off"
*s Audio Input LocalInput 4 Channels: 2
*s Audio Input LocalInput 4 AGC: "Off"
*s Audio Input LocalInput 4 Connector: "HDMI.3"
*s Audio Input LocalInput 4 Connector: "HDMI.4"
*s Audio Input RemoteInput 8 CallId: 3
*s Audio Input RemoteInput 8 AGC: "Off"
*s Audio Output LocalOutput 5 Name: "Loudspeaker"
*s Audio Output LocalOutput 5 Loudspeaker: "On"
*s Audio Output LocalOutput 5 Channels: 2
*s Audio Output LocalOutput 5 Connector: "Line.1"
*s Audio Output LocalOutput 5 Connector: "Line.2"
*s Audio Output LocalOutput 5 Connector: "HDMI.1"
*s Audio Output LocalOutput 5 Connector: "Line.5"
*s Audio Output LocalOutput 5 Connector: "Line.6"
*s Audio Output LocalOutput 5 Input 2 Gain: 0
*s Audio Output LocalOutput 5 Input 3 Gain: 0
*s Audio Output LocalOutput 5 Input 8 Gain: 0
*s Audio Output LocalOutput 6 Name: "Recorder"
*s Audio Output LocalOutput 6 Loudspeaker: "Off"
*s Audio Output LocalOutput 6 Channels: 2
*s Audio Output LocalOutput 6 Connector: "Line.3"
*s Audio Output LocalOutput 6 Connector: "Line.4"
*s Audio Output LocalOutput 6 Connector: "HDMI.3"
*s Audio Output LocalOutput 6 Input 1 Gain: 0
*s Audio Output LocalOutput 6 Input 2 Gain: 0
*s Audio Output LocalOutput 6 Input 4 Gain: 0
*s Audio Output RemoteOutput 9 CallId: 3
*s Audio Output RemoteOutput 9 Input 1 Gain: 0
*s Audio Output RemoteOutput 9 Input 2 Gain: 0
*s Audio Output RemoteOutput 9 Input 3 Gain: 0
*s Audio Module 1 Type: Unknown
*s Audio Module 1 SoftwareID: ""
*s Audio Module 1 HardwareID: ""
*s Audio Module 1 Connector: ""
** end
Shows the microphones mute mode.
Value space of the result returned:
<On/Off>
Example:
xStatus Audio Microphones Mute
*s Audio Microphones Mute: Off
** end
Shows the volume level (dB) of the loudspeaker output.
Value space of the result returned:
<0..100>
Example:
xStatus Audio Volume
*s Audio Volume: 70
** end
Shows the name of the local input. A local input is a mix of input connectors. You can run the command xStatus Audio Input LocalInput to find the identity [1..n] of the input.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus Audio Input LocalInput 1 Name
*s Audio Input LocalInput 1 Name: "Microphone"
** end
Shows how the local input connectors have been mixed together. You can run the command xStatus Audio Input LocalInput to find the identity [1..n] of the input.
Auto: The microphone with the strongest speaker is active and the others are strongly attenuated.
Fixed: The input connector signals are mixed together with equal gains.
GainShared: The microphones are given a normalized gain factor relative to the strongest speaker before being mixed together.
Value space of the result returned:
<Auto/Fixed/GainShared>
Example:
xStatus Audio Input LocalInput 1 MixerMode
*s Audio Input LocalInput 1 MixerMode: "Auto"
** end
Shows the mute mode for the local inputs. A local input is a mix of input connectors.
You can run the command xStatus Audio Input LocalInput to find the identity [1..n] of the input.
Value space of the result returned:
<On/Off>
Example:
xStatus Audio Input LocalInput 1 Mute
*s Audio Input LocalInput 1 Mute: "Off"
** end
States if the local input channels are mixed into into a mono signal (1) or stereo signal (2).
You can run the command xStatus Audio Input LocalInput to find the identity [1..n] of the input.
Value space of the result returned:
<1..2>
Example:
xStatus Audio Input LocalInput 1 Channels
*s Audio Input LocalInput 1 Channels: 1
** end
Shows the AGC (Automatic Gain Control) mode on the local input.
You can run the command xStatus Audio Input LocalInput to find the identity [1..n] of the input.
Value space of the result returned:
<On/Off>
Example:
xStatus Audio Input LocalInput 1 AGC
*s Audio Input LocalInput 1 AGC: "On"
** end
Lists the connectors that are attached to the local input.
You can run the command xStatus Audio Input LocalInput to find the identity [1..n] of the input.
Value space of the result returned:
<Microphone.1/../Microphone.8/Line.1/../Line.4/HDMI.1/../HDMI.4>
Example:
xStatus Audio Input LocalInput 1 Connector
*s Audio Input LocalInput 1 Connector: "Microphone.1"
** end
Shows the CallId for the remote audio input.
You can run the command xStatus Audio Input RemoteInput to find the identity [1..n] of the input.
Value space of the result returned:
<0..65534>
Example:
xStatus Audio Input RemoteInput 8 CallId
*s Audio Input RemoteInput 8 CallId: 28
** end
Shows the AGC (Automatic Gain Control) mode on the remote input.
You can run the command xStatus Audio Input RemoteInput to find the identity [1..n] of the input.
Value space of the result returned:
<On/Off>
Example:
xStatus Audio Input RemoteInput 8 AGC
*s Audio Input RemoteInput 8 AGC: "Off"
** end
Shows the name of the local output.
You can run the command xStatus Audio Output LocalOutput to find the identity [1..n] of the output.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus Audio Output LocalOutput 4 Name
*s Audio Output LocalOutput 4 Name: "MyLocalOutput1"
** end
Shows the Loudspeaker mode on the local output. If one or more of the output connectors that are attached to the local output are connected to a loudspeaker, then this signal should be a reference signal to the echo canceller and Loudspeaker should be set to On.
You can run the command xStatus Audio Output LocalOutput to find the identity [1..n] of the output.
Value space of the result returned:
<On/Off>
Example:
xStatus Audio Output LocalOutput 4 Loudspeaker
*s Audio Output LocalOutput 4 Loudspeaker: "Off"
** end
States if the local output channels are mixed into into a mono signal (1) or stereo signal (2).
You can run the command xStatus Audio Output LocalOutput to find the identity [1..n] of the output.
Value space of the result returned:
<1..2>
Example:
xStatus Audio Output LocalOutput 4 Channels
*s Audio Output LocalOutput 4 Channels: "1"
** end
Lists the connectors that are attached to the local output.
You can run the command xStatus Audio Output LocalOutput to find the identity [1..n] of the output.
Value space of the result returned:
<Line.1/../Line.4/HDMI.1/../HDMI.4>
Example:
xStatus Audio Output LocalOutput 4 Connector
*s Audio Output LocalOutput 4 Connector: "Line.1"
** end
Shows the gain (dB) on the input, when it is connected to the local output. Range from -54 dB to 15 dB, where -54 dB equals Off.
You can run the command xStatus Audio Output LocalOutput to find the identity [1..n] of the output and input.
Value space of the result returned:
<-54..15>
Example:
xStatus Audio Output LocalOutput 4 Input 2 Gain
*s Audio Output LocalOutput 4 Input 2 Gain: 0
** end
Shows the CallId for the remote audio output.
You can run the command xStatus Audio Output RemoteOutput to find the identity [1..n] of the output.
Value space of the result returned:
<1..65534>
Example:
xStatus Audio Output RemoteOutput 9 CallId
*s Audio Output RemoteOutput 9 CallId: 28
** end
Shows the gain (dB) on the input, when input is connected to the remote output. Range from -54 dB to 15 dB, where -54 dB equals Off.
You can run the command xStatus Audio Output RemoteOutput to find the identity [1..n] of the output and input.
Value space of the result returned:
<-54..15>
Example:
xStatus Audio Output RemoteOutput 9 Input 1 Gain
*s Audio Output RemoteOutput 9 Input 1 Gain: 0
** end
Shows the audio module type. If the module type is DigitalNAM (Digital Natural Audio Module) you can also read the SoftwareId and HardwareId.
Value space of the result returned:
<DigitalNAM/Unknown>
Example:
xStatus Audio Module 0 Type
*s Audio Module 0 Type: DigitalNAM
** end
Shows the SoftwareID of the DNAM dsp software.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus Audio Module 0 SoftwareID
*s Audio Module 0 SoftwareID: "114"
** end
Shows the DNAM HardwareID.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus Audio Module 0 HardwareID
*s Audio Module 0 HardwareID: "B40F69"
** end
Shows which audio output connector the audio module is attached to.
Value space of the result returned:
<Line_out.1/Line_out.3>
Example:
xStatus Audio Module 0 Connector
*s Audio Module 0 Connector: "Line_out.1"
** end
The xStatus Call commands
Shows the top level overview of the call status. The call identity is used when query for additional information about the call.
Example:
xStatus Call
*s Call 27 Status: Connected
*s Call 27 Direction: Outgoing
*s Call 27 Protocol: "sip"
*s Call 27 CallType: Video
*s Call 27 RemoteNumber: "firstname.lastname@company.com"
*s Call 27 CallbackNumber: "sip:firstname.lastname@company.com"
*s Call 27 DisplayName: "Firstname Lastname"
*s Call 27 TransmitCallRate: 3968
*s Call 27 ReceiveCallRate: 4000
*s Call 27 Encryption Type: "None"
*s Call 27 PlacedOnHold: False
*s Call 27 Duration: 2354
** end
Shows the status of a call. You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<Dialling/Connecting/Ringing/Connected/Idle>
Example:
xStatus Call 27 Status
*s Call 27 Status: Connected
** end
States the direction of the call initiation. You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<Incoming/Outgoing>
Example:
xStatus Call 27 Direction
*s Call 27 Direction: Outgoing
** end
Shows the call protocol of the incoming or outgoing call. You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<H323/SIP>
Example:
xStatus Call 27 Protocol
*s Call 27 Protocol: "h323"
** end
Shows the call type of the incoming or outgoing call. You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<Video/Audio>
Example:
xStatus Call 27 CallType
*s Call 27 CallType: Video
** end
Shows the remote (far end) number or URI of an incoming or outgoing call. You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Call 27 RemoteNumber
*s Call 27 RemoteNumber: "5585232"
** end
Shows the remote (far end) number or URI of an incoming or outgoing call, including the call protocol, for call back. You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Call 27 CallbackNumber
*s Call 27 CallbackNumber: "h323:firstname.lastname@company.com"
** end
Shows the name of the remote (far end) participant in an incoming or outgoing call. You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Call 27 DisplayName
*s Call 27 DisplayName: "firstname.lastname@company.com"
** end
Shows the transmit bandwidth in the call in kilobits per second (kbps). You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<Integer value>
Example:
xStatus Call 27 TransmitCallRate
*s Call 27 TransmitCallRate: 768
** end
Shows the receive bandwidth in the call in kilobits per second (kbps). You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<Integer value>
Example:
xStatus Call 27 ReceiveCallRate
*s Call 27 ReceiveCallRate: 4000
** end
Shows the encryption type of the call. You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<None/Aes-128>
Example:
xStatus Call 27 Encryption Type
*s Call 27 Encryption Type: "None"
** end
Shows the placed on hold status of the call. You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<True/False>
Example:
xStatus Call 27 PlacedOnHold
*s Call 27 PlacedOnHold: False
** end
Shows the duration of a call (in seconds). You can run the command xStatus Call to find the call identity.
Value space of the result returned:
<Integer value>
Example:
xStatus Call 27 Duration
*s Call 27 Duration: 2354
** end
The xStatus Camera commands
Shows the top level overview of the camera status.
Example:
xStatus Camera
*s Camera 1 Connected: True
*s Camera 1 HardwareID: "50000000"
*s Camera 1 Manufacturer: "TANDBERG"
*s Camera 1 Model: "PrecisionHD 1080p 12X"
*s Camera 1 SoftwareID: "S01718-4.0FINAL [ID:40063] 2010-10-20"
*s Camera 1 SerialNumber: "B1AB26B00010"
*s Camera 1 IpAddress: ""
*s Camera 1 MacAddress: ""
*s Camera 1 Position Pan: 412
*s Camera 1 Position Tilt: 106
*s Camera 1 Position Zoom: 828
*s Camera 1 Position Focus: 4597
*s Camera 1 Capabilities Options: "ptzf"
-
- //the list is continued with Camera 2-7//
** end
Shows if the camera is connected or not.
Value space of the result returned:
<True/False>
Example:
xStatus Camera 1 Connected
*s Camera 1 Connected: True
** end
Shows the hardware identity of the camera.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Camera 1 HardwareID
*s Camera 1 HardwareID: "50000000"
** end
Shows the manufacturer of the camera.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Camera 1 Manufacturer
*s Camera 1 Manufacturer: "TANDBERG"
** end
Shows the camera model.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Camera 1 Model
*s Camera 1 Model: "PrecisionHD 1080p 12X"
** end
Shows the software identity of the camera.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Camera 1 SoftwareID
*s Camera 1 SoftwareID: "S01718-4.0FINAL [ID:40063] 2010-10-20"
** end
Shows the camera serial number.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Camera 1 SerialNumber
*s Camera 1 SerialNumber: "B1AB26B00010"
** end
Shows the camera IP address.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Camera 1 IpAddress
*s Camera 1 IpAddress: ""
** end
Shows the MAC (Media Access Control) address for the camera.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Camera 1 MacAddress
*s Camera 1 MacAddress: ""
** end
Shows the current pan (move left and right) position of the camera. The value range depends on camera type.
Value space of the result returned:
<-65535..65535>
Example:
xStatus Camera 1 Position Pan
*s Camera 1 Position Pan: 412
** end
Shows the current tilt (move up and down) position of the camera. The value range depends on camera type.
Value space of the result returned:
<-65535..65535>
Example:
xStatus Camera 1 Position Tilt
*s Camera 1 Position Tilt: 106
** end
Shows the current zoom (zoom in and out) position of the camera. The value range depends on camera type.
Value space of the result returned:
<0..65535>
Example:
xStatus Camera 1 Position Zoom
*s Camera 1 Position Zoom: 828
** end
Shows the current focus position of the camera. The value range depends on camera type.
Value space of the result returned:
<0..65535>
Example:
xStatus Camera 1 Position Focus
*s Camera 1 Position Focus: 4597
** end
Shows the camera capabilities (ptzf = pan, tilt, zoom, focus).
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Camera 1 Capabilities Options
*s Camera 1 Capabilities Options: "ptzf"
** end
In Flip mode (vertical flip) the image can be flipped upside down.
Value space of the result returned:
<Auto/On/Off>
Example:
xStatus Camera 1 Flip
*s Camera 1 Flip: "Off"
** end
The xStatus Conference commands
Shows the top level overview of the conference status. The identity of the Conference Site can only be read during a call.
Example:
xStatus Conference
*s Conference Presentation Mode: Off
*s Conference Presentation Protocol: ""
*s Conference Presentation Resolution Height: 0
*s Conference Presentation Resolution Width: 0
*s Conference Presentation SiteId: 0
*s Conference Presentation LocalSource: 0
*s Conference Site 26 MicrophonesMuted: True
*s Conference Site 26 Capabilities Presentation: False
** end
Shows the status of the secondary video stream.
Value space of the result returned:
<Off/Sending/Receiving>
Example:
xStatus Conference Presentation Mode
*s Conference Presentation Mode: Off
** end
Shows the video protocol used when transmitting the presentation.
Value space of the result returned:
<S: 0, 10>
Example:
xStatus Conference Presentation Protocol
*s Conference Presentation Protocol: "H264"
** end
Shows the height of the the presentation.
Value space of the result returned:
<0..3000>
Example:
xStatus Conference Presentation Resolution Height
*s Conference Presentation Resolution Height: 0
** end
Shows the width of the the presentation.
Value space of the result returned:
<0..4000>
Example:
xStatus Conference Presentation Resolution Width
*s Conference Presentation Resolution Width: 0
** end
Shows the identity of the system that sends the presentation.
Value space of the result returned:
<0..65535>
Example:
xStatus Conference Presentation SiteId
*s Conference Presentation SiteId: 0
** end
Shows the local video input source that is used when the presentation is sent from the local site.
Value space of the result returned:
<1..5>
Example:
xStatus Conference Presentation LocalSource
*s Conference Presentation LocalSource: 0
** end
Lists the audio mute status for other participants in the conference.
Value space of the result returned:
<True/False>
Example:
xStatus Conference Site 2 MicrophonesMuted
*s Conference Site 2 MicrophonesMuted: True
** end
Lists the presentation capabilities for other participants in the conference.
Value space of the result returned:
<True/False>
Example:
xStatus Conference Site 2 Capabilities Presentation
*s Conference Site 2 Capabilities Presentation: True
** end
The xStatus Diagnostics commands
Shows the top level overview of the diagnostics. The example shows the status for an ongoing call. The identities of the call and channels are used when querying additional information.
Example:
xStatus Diagnostics
*s Diagnostics Call 27 Channels IncomingAudioChannel 327 Netstat 1 Jitter: 0
*s Diagnostics Call 27 Channels IncomingAudioChannel 327 Netstat 1 Packets: 132505
*s Diagnostics Call 27 Channels IncomingAudioChannel 327 Netstat 1 Loss: 0
*s Diagnostics Call 27 Channels IncomingAudioChannel 327 Netstat 1 LastIntervalLost: 0
*s Diagnostics Call 27 Channels IncomingAudioChannel 327 Netstat 1 LastIntervalReceived: 84
*s Diagnostics Call 27 Channels IncomingAudioChannel 327 Netstat 1 Drop: 0
*s Diagnostics Call 27 Channels IncomingAudioChannel 327 Netstat 1 Bytes: 21200960
*s Diagnostics Call 27 Channels IncomingAudioChannel 327 Netstat 1 ChannelRate: 64000
*s Diagnostics Call 27 Channels IncomingAudioChannel 327 Netstat 1 MaxJitter: 0
*s Diagnostics Call 27 Channels IncomingVideoChannel 330 Netstat 1 Jitter: 6
*s Diagnostics Call 27 Channels IncomingVideoChannel 330 Netstat 1 Packets: 133166
*s Diagnostics Call 27 Channels IncomingVideoChannel 330 Netstat 1 Loss: 0
*s Diagnostics Call 27 Channels IncomingVideoChannel 330 Netstat 1 LastIntervalLost: 0
*s Diagnostics Call 27 Channels IncomingVideoChannel 330 Netstat 1 LastIntervalReceived: 148
*s Diagnostics Call 27 Channels IncomingVideoChannel 330 Netstat 1 Drop: 0
*s Diagnostics Call 27 Channels IncomingVideoChannel 330 Netstat 1 Bytes: 122301901
*s Diagnostics Call 27 Channels IncomingVideoChannel 330 Netstat 1 ChannelRate: 506000
*s Diagnostics Call 27 Channels IncomingVideoChannel 330 Netstat 1 MaxJitter: 9
*s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 Jitter: 0
*s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 Packets: 0
*s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 Loss: 0
*s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 LastIntervalLost: 0
*s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 LastIntervalReceived: 0
*s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 Drop: 0
*s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 Bytes: 0
*s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 ChannelRate: 0
*s Diagnostics Call 27 Channels IncomingDataChannel 335 Netstat 1 MaxJitter: 0
*s Diagnostics Call 27 Channels OutgoingAudioChannel 328 Netstat 1 Jitter: 0
*s Diagnostics Call 27 Channels OutgoingAudioChannel 328 Netstat 1 Packets: 0
*s Diagnostics Call 27 Channels OutgoingAudioChannel 328 Netstat 1 Loss: 0
*s Diagnostics Call 27 Channels OutgoingAudioChannel 328 Netstat 1 Drop: 0
*s Diagnostics Call 27 Channels OutgoingAudioChannel 328 Netstat 1 Bytes: 0
*s Diagnostics Call 27 Channels OutgoingAudioChannel 328 Netstat 1 ChannelRate: 0
*s Diagnostics Call 27 Channels OutgoingAudioChannel 328 Netstat 1 MaxJitter: 0
*s Diagnostics Call 27 Channels OutgoingVideoChannel 331 Netstat 1 Jitter: 4
*s Diagnostics Call 27 Channels OutgoingVideoChannel 331 Netstat 1 Packets: 123043
*s Diagnostics Call 27 Channels OutgoingVideoChannel 331 Netstat 1 Loss: 0
*s Diagnostics Call 27 Channels OutgoingVideoChannel 331 Netstat 1 Drop: 0
*s Diagnostics Call 27 Channels OutgoingVideoChannel 331 Netstat 1 Bytes: 94720991
*s Diagnostics Call 27 Channels OutgoingVideoChannel 331 Netstat 1 ChannelRate: 493000
*s Diagnostics Call 27 Channels OutgoingVideoChannel 331 Netstat 1 MaxJitter: 4
*s Diagnostics Call 27 Channels OutgoingDataChannel 336 Netstat 1 Jitter: 0
*s Diagnostics Call 27 Channels OutgoingDataChannel 336 Netstat 1 Packets: 0
*s Diagnostics Call 27 Channels OutgoingDataChannel 336 Netstat 1 Loss: 0
*s Diagnostics Call 27 Channels OutgoingDataChannel 336 Netstat 1 Drop: 0
*s Diagnostics Call 27 Channels OutgoingDataChannel 336 Netstat 1 Bytes: 0
*s Diagnostics Call 27 Channels OutgoingDataChannel 336 Netstat 1 ChannelRate: 0
*s Diagnostics Call 27 Channels OutgoingDataChannel 336 Netstat 1 MaxJitter: 0
** end
Shows the jitter at the present moment in the incoming/outgoing channel, as specified by RFC 3550.
Value space of the result returned:
<Integer value>
Example:
xStatus Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter
*s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Jitter: 0
** end
Shows the number of packets received/sent in the incoming/outgoing channels.
Value space of the result returned:
<Integer value>
Example:
xStatus Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Packets
*s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Packets: 405
** end
Shows the packets lost in the incoming/outgoing channels.
Value space of the result returned:
<Integer value>
Example:
xStatus Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Loss
*s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Loss: 96
** end
Shows the packets lost during the last interval for the incoming channels.
Value space of the result returned:
<Integer value>
Example:
xStatus Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalLost
*s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalLost: 0
** end
Shows the packets received during the last interval for the incoming channels.
Value space of the result returned:
<Integer value>
Example:
xStatus Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived
*s Diagnostics Call 27 Channels IncomingDataChannel 327 Netstat 1 LastIntervalReceived: 84
** end
Shows the packets dropped in the incoming/outgoing channel.
Value space of the result returned:
<Integer value>
Example:
xStatus Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Drop
*s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Drop: 0
** end
Shows the number of bytes received/sent in the incoming/outgoing channel.
Value space of the result returned:
<Integer value>
Example:
xStatus Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Bytes
*s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 Bytes: 129920
** end
Shows the bandwidth for the incoming/outgoing channel.
Value space of the result returned:
<Integer value>
Example:
xStatus Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 ChannelRate
*s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 ChannelRate: 128000
** end
Shows the maximum jitter that has been measured during last time interval (5 seconds).
Value space of the result returned:
<Integer value>
Example:
xStatus Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter
*s Diagnostics Call 27 Channels OutgoingDataChannel 327 Netstat 1 MaxJitter: 0
** end
The xStatus GPIO commands
Shows the current state of each GPIO pin. The default state is High (+12V). When activated the state is Low (0V).
Value space of the result returned:
<High/Low>
Example:
xStatus GPIO Pin 1 State
*s GPIO Pin 1 State: High
** end
The xStatus H323 commands
Shows the top level overview of the H323 status.
Example:
xStatus H323
*s H323 Gatekeeper Status: Registered
*s H323 Gatekeeper Address: "192.0.1.20"
*s H323 Gatekeeper Port: 1719
*s H323 Gatekeeper Reason: ""
** end
Shows the gatekeeper registration status.
Value space of the result returned:
<Registered/Inactive/Rejected>
Example:
xStatus H323 Gatekeeper Status
*s H323 Gatekeeper Status: Registered
** end
Displays the IP address of the gatekeeper where the system is registered.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus H323 Gatekeeper Address
*s H323 Gatekeeper Address: "192.0.1.20"
** end
Shows the port which is used when connecting to on the gatekeeper.
Value space of the result returned:
<Integer value>
Example:
xStatus H323 Gatekeeper Port
*s H323 Gatekeeper Port: 1719
** end
Shows the reason for rejected registration.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus H323 Gatekeeper Reason
*s H323 Gatekeeper Reason: ""
** end
The xStatus HttpFeedback commands
Shows the top level overview of the HTTP status.
Example:
xStatus HttpFeedback
*s HttpFeedback 1 URL: "http://tms.group.company.com/tms/public/feedback/code.aspx"
*s HttpFeedback 1 Expression: "/History/CallLog/History"
*s HttpFeedback 1 Expression: "/Status/Call[Status='connected']"
*s HttpFeedback 1 Expression: "/Status/H323/Gatekeeper"
*s HttpFeedback 1 Expression: "/Status/Ethernet"
*s HttpFeedback 1 Expression: "/Event/CallSuccessful"
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
-
- continues with HttpFeedback 2-4.
** end
Shows the URL (Uniform Resource Locator) of the HTTP server. There can be up to three HTTP servers, specified by the URL.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus HttpFeedback 1 URL
*s HttpFeedback 1 URL: "http://tms.company.com/tms/public/feedback/code.aspx"
** end
Shows the feedback from the HTTP server. There can be up to 15 expressions for each URL. See the xCommand HttpFeedback commands for more information.
Value space of the result returned:
<S: 0..256>
Example:
xStatus HttpFeedback 1 Expression
*s HttpFeedback 1 Expression: "/History/CallLog/History"
*s HttpFeedback 1 Expression: "/Status/Call[Status='connected']"
*s HttpFeedback 1 Expression: "/Status/H323/Gatekeeper"
*s HttpFeedback 1 Expression: "/Status/Ethernet"
*s HttpFeedback 1 Expression: "/Event/CallSuccessful"
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
*s HttpFeedback 1 Expression: ""
** end
The xStatus MediaChannels commands
Shows the top level overview of the media channel status. The example shows the status for an ongoing call. The identities of the call and channels are used when querying additional information.
Example:
xStatus MediaChannels
*s MediaChannels Call 4 IncomingAudioChannel 41 Encryption Status: Off
*s MediaChannels Call 4 IncomingAudioChannel 41 Audio Protocol: AACLD
*s MediaChannels Call 4 IncomingAudioChannel 41 Audio Mute: False
*s MediaChannels Call 4 IncomingAudioChannel 41 Audio Channels: 1
*s MediaChannels Call 4 IncomingAudioChannel 41 Transport RTP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 IncomingAudioChannel 41 Transport RTP Local Port: 16402
*s MediaChannels Call 4 IncomingAudioChannel 41 Transport RTP Remote IpAddress: "10.54.86.240"
*s MediaChannels Call 4 IncomingAudioChannel 41 Transport RTP Remote Port: 2334
*s MediaChannels Call 4 IncomingAudioChannel 41 Transport RTCP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 IncomingAudioChannel 41 Transport RTCP Local Port: 16403
*s MediaChannels Call 4 IncomingAudioChannel 41 Transport RTCP Remote IpAddress: "10.54.86.240"
*s MediaChannels Call 4 IncomingAudioChannel 41 Transport RTCP Remote Port: 2335
*s MediaChannels Call 4 IncomingVideoChannel 44 Encryption Status: Off
*s MediaChannels Call 4 IncomingVideoChannel 44 ChannelRole: Main
*s MediaChannels Call 4 IncomingVideoChannel 44 Video Protocol: H264
*s MediaChannels Call 4 IncomingVideoChannel 44 Video FrameRate: 30
*s MediaChannels Call 4 IncomingVideoChannel 44 Video ResolutionX: 1920
*s MediaChannels Call 4 IncomingVideoChannel 44 Video ResolutionY: 1080
*s MediaChannels Call 4 IncomingVideoChannel 44 Transport RTP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 IncomingVideoChannel 44 Transport RTP Local Port: 16404
*s MediaChannels Call 4 IncomingVideoChannel 44 Transport RTP Remote IpAddress: "10.54.86.240"
*s MediaChannels Call 4 IncomingVideoChannel 44 Transport RTP Remote Port: 2336
*s MediaChannels Call 4 IncomingVideoChannel 44 Transport RTCP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 IncomingVideoChannel 44 Transport RTCP Local Port: 16405
*s MediaChannels Call 4 IncomingVideoChannel 44 Transport RTCP Remote IpAddress: "10.54.86.240"
*s MediaChannels Call 4 IncomingVideoChannel 44 Transport RTCP Remote Port: 2337
*s MediaChannels Call 4 IncomingVideoChannel 47 Encryption Status: Off
*s MediaChannels Call 4 IncomingVideoChannel 47 ChannelRole: Presentation
*s MediaChannels Call 4 IncomingVideoChannel 47 Video Protocol: Off
*s MediaChannels Call 4 IncomingVideoChannel 47 Video FrameRate: 0
*s MediaChannels Call 4 IncomingVideoChannel 47 Video ResolutionX: 0
*s MediaChannels Call 4 IncomingVideoChannel 47 Video ResolutionY: 0
*s MediaChannels Call 4 IncomingVideoChannel 47 Transport RTP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 IncomingVideoChannel 47 Transport RTP Local Port: 16406
*s MediaChannels Call 4 IncomingVideoChannel 47 Transport RTP Remote IpAddress: ""
*s MediaChannels Call 4 IncomingVideoChannel 47 Transport RTP Remote Port: 0
*s MediaChannels Call 4 IncomingVideoChannel 47 Transport RTCP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 IncomingVideoChannel 47 Transport RTCP Local Port: 16407
*s MediaChannels Call 4 IncomingVideoChannel 47 Transport RTCP Remote IpAddress: ""
*s MediaChannels Call 4 IncomingVideoChannel 47 Transport RTCP Remote Port: 0
*s MediaChannels Call 4 IncomingVideoChannel 51 Encryption Status: Off
*s MediaChannels Call 4 IncomingVideoChannel 51 ChannelRole: Legacy
*s MediaChannels Call 4 IncomingVideoChannel 51 Video Protocol: Off
*s MediaChannels Call 4 IncomingVideoChannel 51 Video FrameRate: 0
*s MediaChannels Call 4 IncomingVideoChannel 51 Video ResolutionX: 0
*s MediaChannels Call 4 IncomingVideoChannel 51 Video ResolutionY: 0
*s MediaChannels Call 4 IncomingVideoChannel 51 Transport RTP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 IncomingVideoChannel 51 Transport RTP Local Port: 16410
*s MediaChannels Call 4 IncomingVideoChannel 51 Transport RTP Remote IpAddress: ""
*s MediaChannels Call 4 IncomingVideoChannel 51 Transport RTP Remote Port: 0
*s MediaChannels Call 4 IncomingVideoChannel 51 Transport RTCP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 IncomingVideoChannel 51 Transport RTCP Local Port: 16411
*s MediaChannels Call 4 IncomingVideoChannel 51 Transport RTCP Remote IpAddress: ""
*s MediaChannels Call 4 IncomingVideoChannel 51 Transport RTCP Remote Port: 0
*s MediaChannels Call 4 OutgoingAudioChannel 42 Encryption Status: Off
*s MediaChannels Call 4 OutgoingAudioChannel 42 Audio Protocol: AACLD
*s MediaChannels Call 4 OutgoingAudioChannel 42 Audio Channels: 1
*s MediaChannels Call 4 OutgoingAudioChannel 42 Transport RTP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 OutgoingAudioChannel 42 Transport RTP Local Port: 16402
*s MediaChannels Call 4 OutgoingAudioChannel 42 Transport RTP Remote IpAddress: "10.54.86.240"
*s MediaChannels Call 4 OutgoingAudioChannel 42 Transport RTP Remote Port: 2334
*s MediaChannels Call 4 OutgoingAudioChannel 42 Transport RTCP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 OutgoingAudioChannel 42 Transport RTCP Local Port: 16403
*s MediaChannels Call 4 OutgoingAudioChannel 42 Transport RTCP Remote IpAddress: "10.54.86.240"
*s MediaChannels Call 4 OutgoingAudioChannel 42 Transport RTCP Remote Port: 2335
*s MediaChannels Call 4 OutgoingVideoChannel 45 Encryption Status: Off
*s MediaChannels Call 4 OutgoingVideoChannel 45 ChannelRole: Main
*s MediaChannels Call 4 OutgoingVideoChannel 45 Video Protocol: H264NIL
*s MediaChannels Call 4 OutgoingVideoChannel 45 Video FrameRate: 60
*s MediaChannels Call 4 OutgoingVideoChannel 45 Video ResolutionX: 1280
*s MediaChannels Call 4 OutgoingVideoChannel 45 Video ResolutionY: 720
*s MediaChannels Call 4 OutgoingVideoChannel 45 Transport RTP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 OutgoingVideoChannel 45 Transport RTP Local Port: 16404
*s MediaChannels Call 4 OutgoingVideoChannel 45 Transport RTP Remote IpAddress: "10.54.86.240"
*s MediaChannels Call 4 OutgoingVideoChannel 45 Transport RTP Remote Port: 2336
*s MediaChannels Call 4 OutgoingVideoChannel 45 Transport RTCP Local IpAddress: "10.54.86.241"
*s MediaChannels Call 4 OutgoingVideoChannel 45 Transport RTCP Local Port: 16405
*s MediaChannels Call 4 OutgoingVideoChannel 45 Transport RTCP Remote IpAddress: "10.54.86.240"
*s MediaChannels Call 4 OutgoingVideoChannel 45 Transport RTCP Remote Port: 2337
*s MediaChannels Call 4 OutgoingVideoChannel 48 Encryption Status: Off
*s MediaChannels Call 4 OutgoingVideoChannel 48 ChannelRole: Presentation
*s MediaChannels Call 4 OutgoingVideoChannel 48 Video Protocol: Off
*s MediaChannels Call 4 OutgoingVideoChannel 48 Video FrameRate: 0
*s MediaChannels Call 4 OutgoingVideoChannel 48 Video ResolutionX: 0
*s MediaChannels Call 4 OutgoingVideoChannel 48 Video ResolutionY: 0
*s MediaChannels Call 4 OutgoingVideoChannel 48 Transport RTP Local IpAddress: ""
*s MediaChannels Call 4 OutgoingVideoChannel 48 Transport RTP Local Port: 0
*s MediaChannels Call 4 OutgoingVideoChannel 48 Transport RTP Remote IpAddress: ""
*s MediaChannels Call 4 OutgoingVideoChannel 48 Transport RTP Remote Port: 0
*s MediaChannels Call 4 OutgoingVideoChannel 48 Transport RTCP Local IpAddress: ""
*s MediaChannels Call 4 OutgoingVideoChannel 48 Transport RTCP Local Port: 0
*s MediaChannels Call 4 OutgoingVideoChannel 48 Transport RTCP Remote IpAddress: ""
*s MediaChannels Call 4 OutgoingVideoChannel 48 Transport RTCP Remote Port: 0
*s MediaChannels Call 4 OutgoingVideoChannel 52 Encryption Status: Off
*s MediaChannels Call 4 OutgoingVideoChannel 52 ChannelRole: Legacy
*s MediaChannels Call 4 OutgoingVideoChannel 52 Video Protocol: Off
*s MediaChannels Call 4 OutgoingVideoChannel 52 Video FrameRate: 0
*s MediaChannels Call 4 OutgoingVideoChannel 52 Video ResolutionX: 0
*s MediaChannels Call 4 OutgoingVideoChannel 52 Video ResolutionY: 0
*s MediaChannels Call 4 OutgoingVideoChannel 52 Transport RTP Local IpAddress: ""
*s MediaChannels Call 4 OutgoingVideoChannel 52 Transport RTP Local Port: 0
*s MediaChannels Call 4 OutgoingVideoChannel 52 Transport RTP Remote IpAddress: ""
*s MediaChannels Call 4 OutgoingVideoChannel 52 Transport RTP Remote Port: 0
*s MediaChannels Call 4 OutgoingVideoChannel 52 Transport RTCP Local IpAddress: ""
*s MediaChannels Call 4 OutgoingVideoChannel 52 Transport RTCP Local Port: 0
*s MediaChannels Call 4 OutgoingVideoChannel 52 Transport RTCP Remote IpAddress: ""
*s MediaChannels Call 4 OutgoingVideoChannel 52 Transport RTCP Remote Port: 0
** end
Shows the encryption status on the incoming channel.
Value space of the result returned:
<On/off>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Encryption Status
*s MediaChannels Call 27 IncomingAudioChannel 327 Encryption Status: Off
** end
Shows the audio algorithm for the incoming audio channel.
AACLD: The AAC-LD is a MPEG-4 Low Delay Audio Coder audio compression format.
G722: The G.722 algorithm is an ITU standard.
G7221: The G.722.1 algorithm is a licensed royalty-free ITU-T standard.
G711Mu: The G.711 Mu-law compression algorithm is used in North America and Japan.
G711A: The G.711 A-law compression algorithm is used in Europe and the rest of the world
Value space of the result returned:
<AACLD/G722/G7221/G711Mu/G711A>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol
*s MediaChannels Call 27 IncomingAudioChannel 327 Audio Protocol: AACLD
** end
Audio mute status of incoming audio.
Value space of the result returned:
<True/False>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Audio Mute
*s MediaChannels Call 27 IncomingAudioChannel 327 Audio Mute: True
** end
Shows the number of incoming audio channels.
Value space of the result returned:
<Integer value>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Audio Channels
*s MediaChannels Call 27 IncomingAudioChannel 327 Audio Channels: 1
** end
Shows the local IP address of the Real-time Transport Protocol (RTP) port for the incoming audio in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Local IpAddress
*s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Local IpAddress: "192.168.24.190"
** end
Shows the local UDP port number of the Real-time Transport Protocol (RTP) port for the incoming audio in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Local Port
*s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Local Port: 16404
** end
Shows the remote IP address of the Real-time Transport Protocol (RTP) port for the incoming audio in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote IpAddress
*s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote IpAddress: "192.168.136.130"
** end
Shows the remote UDP port number of the Real-time Transport Protocol (RTP) port for the incoming audio in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote Port
*s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTP Remote Port: 50932
** end
Shows the local IP address of the Real-time Transport Control Protocol (RTCP) port for the incoming audio in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Local IpAddress
*s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Local IpAddress: "192.168.24.190"
** end
Shows the local UDP port number of the Real-time Transport Control Protocol (RTCP) port for the incoming audio in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Local Port
*s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Local Port: 16405
** end
Shows the remote IP address of the Real-time Transport Control Protocol (RTCP) port for the incoming audio in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress
*s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote IpAddress: "192.168.136.130"
** end
Shows the remote UDP port number of the Real-time Transport Control Protocol (RTCP) port for the incoming audio in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote Port
*s MediaChannels Call 27 IncomingAudioChannel 327 Transport RTCP Remote Port: 50933
** end
Shows the encryption status on the incoming channel.
Value space of the result returned:
<On/Off>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Encryption Status
*s MediaChannels Call 27 IncomingVideoChannel 330 Encryption Status: Off
** end
Shows if the incoming channel is the main video channel or presentation channel.
Value space of the result returned:
<Main/Presentation>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 ChannelRole
*s MediaChannels Call 27 IncomingVideoChannel 330 ChannelRole: Main
** end
Shows the video algorithm for the incoming video channel.
H264: The H.264 algorithm is an ITU-T standard for video compression.
H263pp: The H.263pp algorithm is an ITU-T standard for video compression.
H263: The H.263 algorithm is an ITU-T standard for video compression.
H261: The H.261 algorithm is an ITU-T standard for video compression.
Value space of the result returned:
<H264/H263pp/H263/H261>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Video Protocol
*s MediaChannels Call 27 IncomingVideoChannel 330 Video Protocol: H264
** end
Shows the video frame rate of the incoming channel.
Value space of the result returned:
<Integer value>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Video FrameRate
*s MediaChannels Call 27 IncomingVideoChannel 330 Video FrameRate: 25
** end
Shows the width (resolution in direction X) of the incoming video.
Value space of the result returned:
<Integer value>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX
*s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionX: 768
** end
Shows the height (resolution in direction Y) of the incoming video.
Value space of the result returned:
<Integer value>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionY
*s MediaChannels Call 27 IncomingVideoChannel 330 Video ResolutionY: 448
** end
Shows the local IP address of the Real-time Transport Protocol (RTP) port for the incoming video in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Local IpAddress
*s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Local IpAddress: "192.168.24.190"
** end
Shows the local UDP port number of the Real-time Transport Protocol (RTP) port for the incoming video in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Local Port
*s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Local Port: 16404
** end
Shows the remote IP address of the Real-time Transport Protocol (RTP) port for the incoming video in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Remote IpAddress
*s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Remote IpAddress: "192.168.136.130"
** end
Shows the remote UDP port number of the Real-time Transport Protocol (RTP) port for the incoming video in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Remote Port
*s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTP Remote Port: 50932
** end
Shows the local IP address of the Real-time Transport Control Protocol (RTCP) port for the incoming video in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Local IpAddress
*s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Local IpAddress: "192.168.24.190"
** end
Shows the local UDP port number of the Real-time Transport Control Protocol (RTCP) port for the incoming video in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Local Port
*s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Local Port: 16405
** end
Shows the remote IP address of the Real-time Transport Control Protocol (RTCP) port for the incoming video in the media channel..
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Remote IpAddress
*s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Remote IpAddress: "192.168.136.130"
** end
Shows the remote UDP port number of the Real-time Transport Control Protocol (RTCP) port for the incoming video in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Remote Port
*s MediaChannels Call 27 IncomingVideoChannel 330 Transport RTCP Remote Port: 50933
** end
Shows the encryption status on the outgoing channel.
Value space of the result returned:
<On/Off>
Example:
xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Encryption Status
*s MediaChannels Call 27 OutgoingAudioChannel 328 Encryption Status: Off
** end
Shows the audio algorithm for the outgoing audio channel.
AACLD: The AAC-LD is a MPEG-4 Low Delay Audio Coder audio compression format.
G722: The G.722 algorithm is an ITU standard.
G7221: The G.722.1 algorithm is a licensed royalty-free ITU-T standard.
G711Mu: The G.711 Mu-law compression algorithm is used in North America and Japan.
G711A: The G.711 A-law compression algorithm is used in Europe and the rest of the world
Value space of the result returned:
<AACLD/G722/G7221/G711Mu/G711A>
Example:
xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Audio Protocol
*s MediaChannels Call 27 OutgoingAudioChannel 328 Audio Protocol: AACLD
** end
Shows the number of outgoing audio channels.
Value space of the result returned:
<Integer value>
Example:
xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels
*s MediaChannels Call 27 OutgoingAudioChannel 328 Audio Channels: 1
** end
Shows the local IP address of the Real-time Transport Protocol (RTP) port for the outgoing audio in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Local IpAddress
*s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Local IpAddress: "192.168.24.190"
** end
Shows the local UDP port number of the Real-time Transport Protocol (RTP) port for the outgoing audio in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Local Port
*s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Local Port: 16404
** end
Shows the remote IP address of the Real-time Transport Protocol (RTP) port for the outgoing audio in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Remote IpAddress
*s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Remote IpAddress: "192.168.136.130"
** end
Shows the remote UDP port number of the Real-time Transport Protocol (RTP) port for the outgoing audio in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Remote Port
*s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTP Remote Port: 50932
** end
Shows the local IP address of the Real-time Transport Control Protocol (RTCP) port for the outgoing audio in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local IpAddress
*s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local IpAddress: "192.168.24.190"
** end
Shows the local UDP port number of the Real-time Transport Control Protocol (RTCP) port for the outgoing audio in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local Port
*s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Local Port: 16405
** end
Shows the remote IP address of the Real-time Transport Control Protocol (RTCP) port for the outgoing audio in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Remote IpAddress
*s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Remote IpAddress: "192.168.136.130"
** end
Shows the remote UDP port number of the Real-time Transport Control Protocol (RTCP) port for the outgoing audio in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Remote Port
*s MediaChannels Call 27 OutgoingAudioChannel 328 Transport RTCP Remote Port: 50933
** end
Shows the encryption status on the outgoing channel.
Value space of the result returned:
<On/Off>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status
*s MediaChannels Call 27 OutgoingVideoChannel 331 Encryption Status: Off
** end
Shows if the outgoing channel is the main video channel or presentation channel.
Value space of the result returned:
<Main/Presentation>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 ChannelRole
*s MediaChannels Call 27 OutgoingVideoChannel 331 ChannelRole: Main
** end
Shows the video algorithm for the outgoing video channel.
H264: The H.264 algorithm is an ITU-T standard for video compression.
H263pp: The H.263pp algorithm is an ITU-T standard for video compression.
H263: The H.263 algorithm is an ITU-T standard for video compression.
H261: The H.261 algorithm is an ITU-T standard for video compression.
Value space of the result returned:
<H264/H263pp/H263/H261>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Video Protocol
*s MediaChannels Call 27 OutgoingVideoChannel 331 Video Protocol: "H264"
** end
Shows the video frame rate of the outgoing channel.
Value space of the result returned:
<Integer value>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate
*s MediaChannels Call 27 OutgoingVideoChannel 331 Video FrameRate: 30
** end
Shows the width (resolution in direction X) of the outgoing video.
Value space of the result returned:
<Integer value.>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Video ResolutionX
*s MediaChannels Call 27 OutgoingVideoChannel 331 Video ResolutionX: 768
** end
Shows the height (resolution in direction Y) of the outgoing video.
Value space of the result returned:
<Integer value.>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Video ResolutionY
*s MediaChannels Call 27 OutgoingVideoChannel 331 Video ResolutionY: 448
** end
Shows the local IP address of the Real-time Transport Protocol (RTP) port for the outgoing video in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Local IpAddress
*s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Local IpAddress: "192.168.24.190"
** end
Shows the local UDP port number of the Real-time Transport Protocol (RTP) port for the outgoing video in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Local Port
*s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Local Port: 16404
** end
Shows the remote IP address of the Real-time Transport Protocol (RTP) port for the outgoing video in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote IpAddress
*s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote IpAddress: "192.168.136.130"
** end
Shows the remote UDP port number of the Real-time Transport Protocol (RTP) port for the outgoing video in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote Port
*s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTP Remote Port: 50932
** end
Shows the local IP address of the Real-time Transport Control Protocol (RTCP) port for the outgoing video in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Local IpAddress
*s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Local IpAddress: "192.168.24.190"
** end
Shows the local UDP port number of the Real-time Transport Control Protocol (RTCP) port for the outgoing video in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Local Port
*s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Local Port: 16405
** end
Shows the remote IP address of the Real-time Transport Control Protocol (RTCP) port for the outgoing video in the media channel.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote IpAddress
*s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote IpAddress: "192.168.136.130"
** end
Shows the remote UDP port number of the Real-time Transport Control Protocol (RTCP) port for the outgoing video in the media channel.
Value space of the result returned:
<1..n>
Example:
xStatus MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote Port
*s MediaChannels Call 27 OutgoingVideoChannel 331 Transport RTCP Remote Port: 50933
** end
The xStatus Network commands
Shows the top level overview of the network status.
Example:
xStatus Network
*s Network 1 Ethernet MacAddress: "00:50:60:02:E7:D3"
*s Network 1 Ethernet Speed: "1000full"
*s Network 1 IPv4 Address: "192.0.2.149"
*s Network 1 IPv4 SubnetMask: "255.255.255.0"
*s Network 1 IPv4 Gateway: "192.0.2.10"
*s Network 1 IPv4 DNS Domain Name: "www.example.com www.example.int"
*s Network 1 IPv4 DNS Server 1 Address: "192.0.2.60"
*s Network 1 IPv4 DNS Server 2 Address: "192.0.2.61"
*s Network 1 IPv4 DNS Server 3 Address: ""
*s Network 1 IPv4 DNS Server 4 Address: ""
*s Network 1 IPv4 DNS Server 5 Address: ""
*s Network 1 IPv6 Address: ""
*s Network 1 IPv6 Gateway: ""
*s Network 1 IPv4 MTU: 1500
** end
Shows the MAC (Media Access Control) address for the ethernet interface.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Network 1 Ethernet MacAddress
*s Network 1 Ethernet MacAddress: "00:50:60:02:FD:C7"
** end
Shows the Ethernet speed in Mbps. The speed can be in full-duplex or half-duplex.
Value space of the result returned:
<10half/10full/100half/100full/1000full>
Example:
xStatus Network 1 Ethernet Speed
*s Network 1 Ethernet Speed: "100full"
** end
Shows the IPv4 address that uniquely identifies this system.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Network 1 IPv4 Address
*s Network 1 IPv4 Address: "192.0.2.149"
** end
Shows the subnet mask which determines which subnet an IPv4 address belongs to.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Network 1 IPv4 SubnetMask
*s Network 1 IPv4 SubnetMask: "255.255.255.0"
** end
Shows the address of the IPv4 gateway.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Network 1 IPv4 Gateway
*s Network 1 IPv4 Gateway: "192.0.2.10"
** end
Shows the domain name.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Network 1 IPv4 DNS Domain Name
*s Network 1 IPv4 DNS Domain Name: "www.example.com www.example.int"
** end
Shows the IP address of the DNS server.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Network 1 IPv4 DNS Server 1. Address
*s Network 1 IPv4 DNS Server 1 Address: "192.0.2.60"
** end
Shows the IPv6 address that uniquely identifies this system.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Network 1 IPv6 Address
*s Network 1 IPv6 Address: ""
** end
Shows the address of the IPv6 gateway.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Network 1 IPv6 Gateway
*s Network 1 IPv6 Gateway: ""
** end
Shows the MTU (Maximum Transmission Unit) size for the network.
Value space of the result returned:
<Integer value>
Example:
xStatus Network 1 MTU
*s Network 1 MTU: 1500
** end
The feedback will show the VLAN Voice ID; or Off if the VLAN Voice Mode is not enabled.
Value space of the result returned:
<Off/1..4094>
Example:
xStatus Network 1 VLAN Voice VlanId
*s Network 1 VLAN Voice VlanId: "Off"
** end
The xStatus Preset commands
Shows the top level overview of the camera presets status.
Example:
xStatus Preset
*s Preset 1 Defined: True
*s Preset 1 Type: All
*s Preset 1 Description: "Zoom in"
*s Preset 2 Defined: True
*s Preset 2 Type: All
*s Preset 2 Description: "Zoom out"
-
- //continues with Preset 3-15.//
** end
Shows if a camera preset is stored at this position.
Value space of the result returned:
<True/False>
Example:
xStatus Preset 1 Defined
*s Preset 1 Defined: True
** end
Shows the camera preset type.
Value space of the result returned:
<All/Camera>
Example:
xStatus Preset 1 Type
*s Preset 1 Type: All
** end
Lists the configured name for the specific preset.
Value space of the result returned:
<S: 0..100>
Example:
xStatus Preset 1 Description
*s Preset 1 Description: "Zoom in"
** end
The xStatus Provisioning commands
Shows the top level overview of the provisioning status.
Example:
xStatus Provisioning
*s Provisioning Status: Provisioned
*s Provisioning Reason: ""
*s Provisioning Software UpgradeStatus SessionId: ""
*s Provisioning Software UpgradeStatus LastChange: "2011-06-07T07:20:03Z"
*s Provisioning Software UpgradeStatus Status: None
*s Provisioning Software UpgradeStatus Phase: None
*s Provisioning Software UpgradeStatus Message: ""
*s Provisioning Software UpgradeStatus VersionId: ""
*s Provisioning Software UpgradeStatus URL: ""
*s Provisioning Software Current VersionId: ""
*s Provisioning Software Current URL: ""
*s Provisioning Software Current CompletedAt: "2011-06-07T07:20:03Z"
** end
Shows the status of the provisioning.
Failed: The provisioning failed.
AuthenticationFailed: The authentication failed.
Provisioned: The endpoint is provisioned.
Idle: The provisioning is not active.
NeedConfig: The endpoint needs to be configured.
Value space of the result returned:
<Failed/AuthenticationFailed/Provisioned/Idle/NeedConfig>
Example:
xStatus Provisioning Status
*s Provisioning Status: Provisioned
** end
Shows the cause when provisioning has failed.
Value space of the result returned:
<S: 0, 80>
Example:
xStatus Provisioning Reason
*s Provisioning Reason: ""
** end
Shows the ID of the session for the software upgrade.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus Provisioning Software UpgradeStatus SessionId
*s Provisioning Software UpgradeStatus SessionId: ""
** end
Shows the date and time for the latest software upgrade.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus Provisioning Software UpgradeStatus LastChange
*s Provisioning Software UpgradeStatus LastChange: "2011-06-07T07:20:03Z"
** end
Shows the status of the software upgrade.
Value space of the result returned:
<None/InProgress/Failed/Succeeded>
Example:
xStatus Provisioning Software UpgradeStatus Status
*s Provisioning Software UpgradeStatus Status: None
** end
Shows the phase of the software upgrade.
Value space of the result returned:
<None/DownloadPending/Downloading/Installing>
Example:
xStatus Provisioning Software UpgradeStatus Phase
*s Provisioning Software UpgradeStatus Phase: None
** end
Shows the system message for the software upgrade.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus Provisioning Software UpgradeStatus Message
*s Provisioning Software UpgradeStatus Message: ""
** end
Shows the version ID of the current software upgrade.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus Provisioning Software Current VersionId
*s Provisioning Software Current VersionId: ""
** end
Shows the URL from where the current software upgrade is uploaded.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus Provisioning Software Current URL
*s Provisioning Software Current URL: ""
** end
Shows date and time for when the current software upgrade was completed.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus Provisioning Software Current CompletedAt
*s Provisioning Software Current CompletedAt: "2011-06-07T07:20:03Z"
** end
The xStatus Security commands
Shows the FIPS mode status.
Value space of the result returned:
<On/Off>
Example:
xStatus Security FIPS Mode
*s Security FIPS Mode: "Off"
** end
The xStatus SIP commands
Shows the top level overview of the SIP status.
Example:
xStatus SIP
*s SIP Proxy 1 Status: Active
*s SIP Proxy 1 Address: "192.0.2.50"
*s SIP Proxy 1 Secure: True
*s SIP Proxy 1 Verified: False
*s SIP Registration 1 Status: Registered
*s SIP Registration 1 Reason: ""
*s SIP Registration 1 URI: "anyname@company.com"
*s SIP Registration 1 Authentication: Off
*s SIP Profile 1 Proxy 1 Status: Active
*s SIP Profile 1 Proxy 1 Address: "192.0.1.50"
*s SIP Profile 1 Secure: True
*s SIP Profile 1 Verified: False
*s SIP Profile 1 Authentication: Off
*s SIP Profile 1 Registration 1 Status: Registered
*s SIP Profile 1 Registration 1 Reason: ""
*s SIP Profile 1 Registration 1 URI: "anyname@company.com"
** end
Shows the status of the communication between the endpoint and the SIP Proxy server.
Active: The communication between the endpoint and the SIP Proxy is active.
DNSFailed: The attempt to establish communication to the DNS server failed.
Off: There is no communication between the endpoint and the SIP Proxy.
Timeout: The attempt to establish communication to the SIP Proxy timed out.
UnableTCP: The system is unable to use TCP as the transport method.
UnableTLS: The system is unable to use TLS as the transport method.
Unknown: The status of the communication is not known.
Value space of the result returned:
<Active/DNSFailed/Off/Timeout/UnableTCP/UnableTLS/Unknown>
Example:
xStatus SIP Proxy 1 Status
*s SIP Proxy 1 Status: Active
** end
Shows the address of the SIP Proxy that the system communicates with.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus SIP Proxy 1 Address
*s SIP Proxy 1 Address: "192.0.2.50"
** end
Shows the encryption status of the signalling with the SIP Proxy server.
Value space of the result returned:
<True/False>
Example:
xStatus SIP Proxy 1 Secure
*s SIP Proxy 1 Secure: True
** end
Not supported in this software version.
Value space of the result returned:
<True/False>
Example:
xStatus SIP Proxy 1 Verified
*s SIP Proxy 1 Verified: False
** end
Shows the status of the registration to the SIP Proxy Server.
Deregister: The system is in the process of de-registering to the SIP Proxy.
Failed: The system failed to register to the SIP Proxy.
Inactive: The system is not registered to any SIP Proxy.
Registered: The system is registered to the SIP Proxy.
Registering: The system is in the process of registering to the SIP Proxy.
Value space of the result returned:
<Deregister/Failed/Inactive/Registered/Registering>
Example:
xStatus SIP Registration 1 Status
*s SIP Registration 1 Status: Registered
** end
Shows a message to explain the reason why the SIP registration failed.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SIP Registration 1 Reason
*s SIP Registration 1 Reason: "404 Not Found"
** end
Shows the URI used for registration to the SIP Proxy server.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SIP Registration 1 URI
*s SIP Registration 1 URI: "firstname.lastname@company.com"
** end
Shows which authentication mechanism is used when registering to the SIP Proxy Server.
Digest: Uses the Digest access authentication method, as specified by RFC 2069.
NTLM: Uses the NTLM athentication method, which is a Microsoft athentication protocol.
Off: No authentication mechanism is used.
Value space of the result returned:
<Digest/NTLM/Off>
Example:
xStatus SIP Registration 1 Authentication
*s SIP Registration 1 Authentication: Off
** end
Shows the status of the communication between the endpoint and the SIP Proxy server.
Active: The communication between the endpoint and the SIP Proxy is active.
DNSFailed: The attempt to establish communication to the DNS server failed.
Off: There is no communication between the endpoint and the SIP Proxy.
Timeout: The attempt to establish communication to the SIP Proxy timed out.
UnableTCP: The system is unable to use TCP as the transport method.
UnableTLS: The system is unable to use TLS as the transport method.
Unknown: The status of the communication is not known.
Value space of the result returned:
<Active/DNSFailed/Off/Timeout/UnableTCP/UnableTLS/Unknown>
Example:
xStatus SIP Profile 1 Proxy 1 Status
*s SIP Profile 1 Proxy 1 Status: Active
** end
Shows the address of the SIP Proxy that the system communicates with.
Value space of the result returned:
<S: 0, 255>
Example:
xStatus SIP Profile 1 Proxy 1 Address
*s SIP Profile 1 Proxy 1 Address: "192.0.2.50"
** end
Shows the encryption status of the signalling with the SIP Proxy server.
Value space of the result returned:
<True/False>
Example:
xStatus SIP Profile 1 Secure
*s SIP Profile 1 Secure: True
** end
Not supported in this software version.
Value space of the result returned:
<True/False>
Example:
xStatus SIP Profile 1 Verified
*s SIP Profile 1 Verified: False
** end
Shows which authentication mechanism is used when registering to the SIP Proxy Server.
Digest: Uses the Digest access authentication method, as specified by RFC 2069.
NTLM: Uses the NTLM athentication method, which is a Microsoft athentication protocol.
Off: No authentication mechanism is used.
Value space of the result returned:
<Digest/NTLM/Off>
Example:
xStatus SIP Profile 1 Authentication
*s SIP Profile 1 Authentication: Off
** end
Shows the status of the registration to the SIP Proxy Server.
Deregister: The system is in the process of de-registering to the SIP Proxy.
Failed: The system failed to register to the SIP Proxy.
Inactive: The system is not registered to any SIP Proxy.
Registered: The system is registered to the SIP Proxy.
Registering: The system is in the process of registering to the SIP Proxy.
Value space of the result returned:
<Deregister/Failed/Inactive/Registered/Registering>
Example:
xStatus SIP Profile 1 Registration 1 Status
*s SIP Profile 1 Registration 1 Status: Registered
** end
Shows a message to explain the reason why the SIP registration failed.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SIP Profile 1 Registration 1 Reason
*s SIP Profile 1 Registration 1 Reason: "404 Not Found"
** end
Shows the URI used for registration to the SIP Proxy server.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SIP Profile 1 Registration 1 URI
*s SIP Profile 1 Registration 1 URI: "firstname.lastname@company.com"
** end
The xStatus Standby commands
Shows if the system is in standby or not.
Value space of the result returned:
<On/Off>
Example:
xStatus Standby Active
*s Standby Active: Off
** end
The xStatus SystemUnit commands
Shows the top level overview of the system unit status.
Example:
xStatus SystemUnit
*s SystemUnit ProductType: "Cisco TelePresence Codec"
*s SystemUnit ProductId: "Cisco TelePresence Codec C90"
*s SystemUnit ProductPlatform: "C90"
*s SystemUnit Uptime: 864143
*s SystemUnit Software Application: "Endpoint"
*s SystemUnit Software Version: "TC4.2.0"
*s SystemUnit Software Name: "s52000"
*s SystemUnit Software ReleaseDate: "2011-06-03"
*s SystemUnit Software MaxVideoCalls: 3
*s SystemUnit Software MaxAudioCalls: 4
*s SystemUnit Software ReleaseKey: "true"
*s SystemUnit Software OptionKeys NaturalPresenter: "true"
*s SystemUnit Software OptionKeys MultiSite: "true"
*s SystemUnit Software OptionKeys PremiumResolution: "true"
*s SystemUnit Software OptionKeys HighDefinition: "true"
*s SystemUnit Software OptionKeys DualDisplay: "true"
*s SystemUnit Hardware Module SerialNumber: "F9AA99A00090"
*s SystemUnit Hardware Module Identifier: "0"
*s SystemUnit Hardware MainBoard SerialNumber: "PH0999998"
*s SystemUnit Hardware MainBoard Identifier: "101701-3 [04]"
*s SystemUnit Hardware VideoBoard SerialNumber: "PH0999999"
*s SystemUnit Hardware VideoBoard Identifier: "101560-1 [02]"
*s SystemUnit Hardware AudioBoard SerialNumber: "N/A"
*s SystemUnit Hardware AudioBoard Identifier: ""
*s SystemUnit Hardware BootSoftware: "U-Boot 2010.06-81"
*s SystemUnit State System: Initialized
*s SystemUnit State MaxNumberOfCalls: 3
*s SystemUnit State MaxNumberOfActiveCalls: 3
*s SystemUnit State NumberOfActiveCalls: 1
*s SystemUnit State NumberOfSuspendedCalls: 0
*s SystemUnit State NumberOfInProgressCalls: 0
*s SystemUnit State Subsystem Application: Initialized
*s SystemUnit ContactInfo: "anyname@company.com"
** end
Shows the product type.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit ProductType
*s SystemUnit ProductType: "Cisco TelePresence Codec"
** end
Shows the product identity.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit ProductId
*s SystemUnit ProductId: "Cisco TelePresence Codec C90"
** end
Shows the product platform.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit ProductPlatform
*s SystemUnit ProductPlatform: "C90"
** end
Shows the number of seconds since the last restart of the codec.
Value space of the result returned:
<Integer value>
Example:
xStatus SystemUnit Uptime
*s SystemUnit Uptime: 597095
** end
Shows which software application is running on the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Software Application
*s SystemUnit Software Application: "Endpoint"
** end
Shows the software version installed on the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Software Version
*s SystemUnit Software Version: "TC4.2.0"
** end
Shows the name of the software that is installed on the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Software Name
*s SystemUnit Software Name: "s52000"
** end
Shows the release date of the software installed on the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Software ReleaseDate
*s SystemUnit Software ReleaseDate: "2011-07-19"
** end
Shows the the maximum number of simultaneous video calls that is supported.
Value space of the result returned:
<Integer value>
Example:
xStatus SystemUnit Software MaxVideoCalls
*s SystemUnit Software MaxVideoCalls: 3
** end
Shows the the maximum number of simultaneous audio calls that is supported.
Value space of the result returned:
<Integer value>
Example:
xStatus SystemUnit Software MaxAudioCalls
*s SystemUnit Software MaxAudioCalls: 4
** end
Shows if there is a valid releasekey for the software version that is installed on the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Software ReleaseKey
*s SystemUnit Software ReleaseKey: "true"
** end
Shows if the system has the option key installed that supports the NaturalPresenter functionality.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Software OptionKeys NaturalPresenter
*s SystemUnit Software OptionKeys NaturalPresenter: "true"
** end
Shows if the system has the option key installed that supports the MultiSite functionality.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Software OptionKeys MultiSite
*s SystemUnit Software OptionKeys MultiSite: "true"
** end
Shows if the system has the option key installed that supports the PremiumResolution functionality.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Software OptionKeys PremiumResolution
*s SystemUnit Software OptionKeys PremiumResolution: "true"
** end
Shows if the system has the option key installed that supports the HighDefinition functionality.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Software OptionKeys HighDefinition
*s SystemUnit Software OptionKeys HighDefinition: "true"
** end
Shows if the system has the option key installed that supports the DualDisplay functionality.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Software OptionKeys DualDisplay
*s SystemUnit Software OptionKeys DualDisplay: "true"
** end
Shows the serial number of the hardware module in the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Hardware Module SerialNumber
*s SystemUnit Hardware Module SerialNumber: "F9AA99A00090"
** end
Shows the revision of the hardware module in the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Hardware Module Identifier
*s SystemUnit Hardware Module Identifier: "1"
** end
The Cisco TelePresence endpoints are using a NAND flash memory for general storage. The endpoints running TC software will be manufactured with a new version of the flash memory. Endpoints having the new version of the flash memory must run software TC4.2.1 or later. Some previous TC software versions will be updated to support the new flash memory. Please check the release note to find if the new version of the flash memory is supported. If your endpoint does not have the CompatibilityLevel command it will not have the new flash memory installed.
The result returned when running the command will be either 0 or 1:
0 = The system does not have the new flash memory installed.
1 = The system has the new flash memory installed. If downgraded, it can only be downgraded to previous TC software versions having support for the new version of the flash memory.
Value space of the result returned:
<1/0>
Example:
xstatus SystemUnit Hardware Module CompatibilityLevel
*s SystemUnit Hardware Module CompatibilityLevel: 0
** end
Shows the serial number of the main board in the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Hardware MainBoard SerialNumber
*s SystemUnit Hardware MainBoard SerialNumber: "PH0999989"
** end
Shows the revision of the main board in the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Hardware MainBoard Identifier
*s SystemUnit Hardware MainBoard Identifier: "101400-5 [06]"
** end
Shows the serial number of the video board in the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Hardware VideoBoard SerialNumber
*s SystemUnit Hardware VideoBoard SerialNumber: "PH0999999"
** end
Shows the revision of the video board in the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Hardware VideoBoard Identifier
*s SystemUnit Hardware VideoBoard Identifier: "101410-4 [07]"
** end
Shows the serial number of the audio board in the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Hardware AudioBoard SerialNumber
*s SystemUnit Hardware AudioBoard SerialNumber: "N/A"
** end
Shows the revision of the audio board in the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Hardware AudioBoard Identifier
*s SystemUnit Hardware AudioBoard Identifier: ""
** end
Shows the version of the boot software that is installed on the codec.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit Hardware BootSoftware
*s SystemUnit Hardware BootSoftware: "U-Boot 2010.04-30"
** end
The feedback will show the monitoring software id.
Value space of the result returned:
<Integer value>
Example:
xstatus SystemUnit Hardware MonitoringSoftware
*s SystemUnit Hardware MonitoringSoftware: "39"
** end
The feedback will show the speed (rpm) for the specified fan.
Value space of the result returned:
<S: 0, 100>
Example:
xstatus SystemUnit Hardware Monitoring Fan 1 Status
*s SystemUnit Hardware Monitoring Fan 1 Status: "locked on 1096 rpm"
** end
The feedback will show the current maximum temperature (degree Celsius) measured in the codec/system.
Value space of the result returned:
<Double (decimal) number>
Example:
xstatus SystemUnit Hardware Temperature
*s SystemUnit Hardware Temperature: "64.0"
** end
Shows what state the system is in.
InCall: The system is in a call.
Initialized: The system is ready for use.
Initializing: The system is initializing.
Multisite: The system is in a Multisite conference.
Sleeping: The system is in sleep mode.
Value space of the result returned:
<InCall/Initialized/Initializing/Multisite/Sleeping>
Example:
xStatus SystemUnit State System
*s SystemUnit State System: Initialized
** end
Shows the the maximum number of simultanious calls.
Value space of the result returned:
<0..5>
Example:
xStatus SystemUnit State MaxNumberOfCalls
*s SystemUnit State MaxNumberOfCalls: 3
** end
Shows the the maximum number of simultanious active calls. Calls that are set on hold/transfer are not counted as active.
Value space of the result returned:
<0..5>
Example:
xStatus SystemUnit State MaxNumberOfActiveCalls
*s SystemUnit State MaxNumberOfActiveCalls: 3
** end
Shows the number of active calls.
Value space of the result returned:
<0..5>
Example:
xStatus SystemUnit State NumberOfActiveCalls
*s SystemUnit State NumberOfActiveCalls: 0
** end
Shows the number of suspended calls.
Value space of the result returned:
<0..5>
Example:
xStatus SystemUnit State NumberOfSuspendedCalls
*s SystemUnit State NumberOfSuspendedCalls: 0
** end
Shows the number of calls in progress.
Value space of the result returned:
<0..5>
Example:
xStatus SystemUnit State NumberOfInProgressCalls
*s SystemUnit State NumberOfInProgressCalls: 0
** end
Shows the status of the sub system application.
Initialized: The sub-system application is initialized.
Initializing: The sub-system application is initializing.
Value space of the result returned:
<Initialized/Initializing>
Example:
xStatus SystemUnit State Subsystem Application
*s SystemUnit State Subsystem Application: Initialized
** end
Shows the address which another system can dial to reach this system.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus SystemUnit ContactInfo
*s SystemUnit ContactInfo: "firstname.lastname@company.com"
** end
The xStatus Time commands
Shows the current time zone on Olson format.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Time ZoneOlson
*s Time ZoneOlson: Europe/Berlin
** end
The xStatus Video commands
Shows the top level overview of the video input status.
Example:
xStatus Video Input
*s Video Input LastConnectedSource: 0
*s Video Input Source 1 Resolution Height: 1080
*s Video Input Source 1 Resolution Width: 1920
*s Video Input Source 1 Resolution RefreshRate: 64
*s Video Input Source 1 Resolution FormatType: Digital
*s Video Input Source 1 Resolution FormatStatus: Ok
*s Video Input Source 2 Resolution Height: 1080
*s Video Input Source 2 Resolution Width: 1920
*s Video Input Source 2 Resolution RefreshRate: 64
*s Video Input Source 2 Resolution FormatType: Unknown
*s Video Input Source 2 Resolution FormatStatus: Error
*s Video Input Source 3 Resolution Height: 1080
*s Video Input Source 3 Resolution Width: 1920
*s Video Input Source 3 Resolution RefreshRate: 60
*s Video Input Source 3 Resolution FormatType: Unknown
*s Video Input Source 3 Resolution FormatStatus: Error
*s Video Input Source 4 Resolution Height: 0
*s Video Input Source 4 Resolution Width: 0
*s Video Input Source 4 Resolution RefreshRate: 0
*s Video Input Source 4 Resolution FormatType: Unknown
*s Video Input Source 4 Resolution FormatStatus: Error
*s Video Input Source 5 Resolution Height: 0
*s Video Input Source 5 Resolution Width: 0
*s Video Input Source 5 Resolution RefreshRate: 0
*s Video Input Source 5 Resolution FormatType: Unknown
*s Video Input Source 5 Resolution FormatStatus: Error
*s Video Input HDMI 1 Connected: True
*s Video Input HDMI 1 SignalState: OK
*s Video Input HDMI 2 Connected: True
*s Video Input HDMI 2 SignalState: OK
*s Video Input HDMI 3 Connected: True
*s Video Input HDMI 3 SignalState: OK
*s Video Input HDMI 4 Connected: False
*s Video Input HDMI 4 SignalState: Unknown
*s Video Input HDSDI 1 Connected: False
*s Video Input HDSDI 1 SignalState: Unknown
*s Video Input HDSDI 2 Connected: False
*s Video Input HDSDI 2 SignalState: Unknown
*s Video Input HDSDI 3 Connected: False
*s Video Input HDSDI 3 SignalState: Unknown
*s Video Input HDSDI 4 Connected: False
*s Video Input HDSDI 4 SignalState: Unknown
*s Video Input YPbPr 1 Connected: Unknown
*s Video Input YPbPr 1 SignalState: Unknown
*s Video Input YPbPr 2 Connected: Unknown
*s Video Input YPbPr 2 SignalState: Unknown
*s Video Input DVI 3 Connected: Unknown
*s Video Input DVI 3 SignalState: Unknown
*s Video Input DVI 5 Connected: Unknown
*s Video Input DVI 5 SignalState: Unknown
*s Video Input Legacy 5 Connected: False
*s Video Input Legacy 5 SignalState: Unknown
** end
Shows the last connected video input source.
Value space of the result returned:
<1..5>
Example:
xStatus Video Input LastConnectedSource
*s Video Input LastConnectedSource: 0
** end
Shows the resolution height (in pixels) for the video input source.
Value space of the result returned:
<0..3000>
Example:
xStatus Video Input Source 1 Resolution Height
*s Video Input Source 1 Resolution Height: 1080
** end
Shows the resolution width (in pixels) for the video input source.
Value space of the result returned:
<0..4000>
Example:
xStatus Video Input Source 1 Resolution Width
*s Video Input Source 1 Resolution Width: 1920
** end
Shows the resolution refresh rate (Hz) for the video input source.
Value space of the result returned:
<0..300>
Example:
xStatus Video Input Source 1 Resolution RefreshRate
*s Video Input Source 1 Resolution RefreshRate: 50
** end
Shows the resolution format type for the video input source.
Value space of the result returned:
<Unknown/AnalogCVTBlanking/AnalogCVTReducedBlanking/AnalogGTFDefault/AnalogGTFSecondary/AnalogDiscreteTiming/AnalogDMTBlanking/AnalogCEABlanking/Digital>
Example:
xStatus Video Input Source 1 Resolution FormatType
*s Video Input Source 1 Resolution FormatType: Digital
** end
Shows the resolution format status for the video input source.
Value space of the result returned:
<Ok/AnalogOutOfRange/AnalogNotFound/Interlaced/Error/Unknown>
Example:
xStatus Video Input Source 1 Resolution FormatStatus
*s Video Input Source 1 Resolution FormatStatus: Ok
** end
Shows if there is something connected to the HDMI connector. Not all connections can be detected.
Value space of the result returned:
<True/False>
Example:
xStatus Video Input HDMI 1 Connected
*s Video Input HDMI 1 Connected: True
** end
Shows the signal state for the HDMI input.
Unknown: The signal format is unknown.
OK: A signal is detected and the signal format is supported.
Unsupported: A signal is detected, but the signal format is not supported.
Value space of the result returned:
<Unknown/OK/Unsupported>
Example:
xStatus Video Input HDMI 1 SignalState
*s Video Input HDMI 1 SignalState: OK
** end
Shows if there is something connected to the HD-SDI connector. Not all connections can be detected.
Value space of the result returned:
<True/False>
Example:
xStatus Video Input HDSDI 1 Connected
*s Video Input HDSDI 1 Connected: False
** end
Shows the signal state for the HD-SDI input.
Unknown: The signal format is unknown.
OK: A signal is detected and the signal format is supported.
Unsupported: A signal is detected, but the signal format is not supported.
Value space of the result returned:
<Unknown/OK/Unsupported>
Example:
xStatus Video Input HDSDI 1 SignalState
*s Video Input HDSDI 1 SignalState: OK
** end
Shows if there is something connected to the YPbPr connector. Not all connections can be detected.
Value space of the result returned:
<True/False>
Example:
xStatus Video Input YPbPr 1 Connected
*s Video Input YPbPr 1 Connected: False
** end
Shows the signal state for the YPbPr input.
Unknown: The signal format is unknown.
OK: A signal is detected and the signal format is supported.
Unsupported: A signal is detected, but the signal format is not supported.
Value space of the result returned:
<Unknown/OK/Unsupported>
Example:
xStatus Video Input YPbPr 1 SignalState
*s Video Input YPbPr 1 SignalState: OK
** end
Shows if there is something connected to the DVI connector. Not all connections can be detected.
Value space of the result returned:
<True/False>
Example:
xStatus Video Input DVI 3 Connected
*s Video Input DVI 3 Connected: False
** end
Shows the signal state for the DVI-I input.
Unknown: The signal format is unknown.
OK: A signal is detected and the signal format is supported.
Unsupported: A signal is detected, but the signal format is not supported.
Value space of the result returned:
<Unknown/OK/Unsupported>
Example:
xStatus Video Input DVI 3 SignalState
*s Video Input DVI 3 SignalState: OK
** end
Shows if there is something connected to the Legacy, which are the Y/Comp and C connectors. Not all connections can be detected.
Value space of the result returned:
<True/False>
Example:
xStatus Video Input Legacy 5 Connected
*s Video Input Legacy 5 Connected: False
** end
Shows the signal state for the Legacy, which are the Y/Comp and C inputs.
Unknown: The signal format is unknown.
OK: A signal is detected and the signal format is supported.
Unsupported: A signal is detected, but the signal format is not supported.
Value space of the result returned:
<Unknown/OK/Unsupported>
Example:
xStatus Video Input Legacy 5 SignalState
*s Video Input Legacy 5 SignalState: OK
** end
Shows the top level overview of the video output status.
Example:
xStatus Video Output
*s Video Output HDMI 1 Resolution Height: 1080
*s Video Output HDMI 1 Resolution Width: 1920
*s Video Output HDMI 1 Resolution RefreshRate: 60
*s Video Output HDMI 3 Resolution Height: 720
*s Video Output HDMI 3 Resolution Width: 1280
*s Video Output HDMI 3 Resolution RefreshRate: 60
*s Video Output DVI 2 Resolution Height: 720
*s Video Output DVI 2 Resolution Width: 1280
*s Video Output DVI 2 Resolution RefreshRate: 60
*s Video Output DVI 4 Resolution Height: 720
*s Video Output DVI 4 Resolution Width: 1280
*s Video Output DVI 4 Resolution RefreshRate: 60
*s Video Output Legacy 5 Resolution Height: 576
*s Video Output Legacy 5 Resolution Width: 720
*s Video Output Legacy 5 Resolution RefreshRate: 50
** end
Shows the resolution height (in pixels) for the video output HDMI.
Value space of the result returned:
<120..3000>
Example:
xStatus Video Output HDMI 1 Resolution Height
*s Video Output HDMI 1 Resolution Height: 720
** end
Shows the resolution width (in pixels) for the video output HDMI.
Value space of the result returned:
<176..4000>
Example:
xStatus Video Output HDMI 1 Resolution Width
*s Video Output HDMI 1 Resolution Width: 1280
** end
Shows the resolution refresh rate (Hz) for the video output HDMI.
Value space of the result returned:
<1..300>
Example:
xStatus Video Output HDMI 1 Resolution RefreshRate
*s Video Output HDMI 1 Resolution RefreshRate: 60
** end
Shows the resolution height (in pixels) for the video output DVI.
Value space of the result returned:
<120..3000>
Example:
xStatus Video Output DVI 2 Resolution Height
*s Video Output DVI 2 Resolution Height: 720
** end
Shows the resolution width (in pixels) for the video output DVI.
Value space of the result returned:
<176..4000>
Example:
xStatus Video Output DVI 2 Resolution Width
*s Video Output DVI 2 Resolution Width: 1280
** end
Shows the resolution refresh rate (Hz) for the video output DVI.
Value space of the result returned:
<1..300>
Example:
xStatus Video Output DVI 2 Resolution RefreshRate
*s Video Output DVI 2 Resolution RefreshRate: 60
** end
Shows the resolution height (in pixels) for the video output Legacy (Composite).
Value space of the result returned:
<120..3000>
Example:
xStatus Video Output Legacy 5 Resolution Height
*s Video Output Legacy 5 Resolution Height: 480
** end
Shows the resolution width (in pixels) for the video output Legacy (Composite).
Value space of the result returned:
<176..4000>
Example:
xStatus Video Output Legacy 5 Resolution Width
*s Video Output Legacy 5 Resolution Width: 720
** end
Shows the resolution refresh rate (Hz) for the video output Legacy (Composite).
Value space of the result returned:
<1..300>
Example:
xStatus Video Output Legacy 5 Resolution RefreshRate
*s Video Output Legacy 5 Resolution RefreshRate: 60
** end
Shows the top level overview of the video status.
Example:
xStatus Video Layout
*s Video Layout PresentationView: "full"
*s Video Layout Site 1 Output 1 FamilyName: "speaker"
*s Video Layout Site 1 Output 1 FullFamilyName: "speaker-sv-on"
*s Video Layout Site 1 Output 1 FamilyNumber: 1027
*s Video Layout Site 1 Output 1 GraphicName: "1top-1small"
*s Video Layout Site 1 Output 1 GraphicNumber: 1017
*s Video Layout Site 1 Output 1 Descriptor: 4
*s Video Layout Site 1 Output 1 DescriptorOutput: 1
*s Video Layout Site 1 Output 1 Frame 1 PositionX: 1333
*s Video Layout Site 1 Output 1 Frame 1 PositionY: 59
*s Video Layout Site 1 Output 1 Frame 1 Width: 7334
*s Video Layout Site 1 Output 1 Frame 1 Height: 7334
*s Video Layout Site 1 Output 1 Frame 1 Layer: 1
*s Video Layout Site 1 Output 1 Frame 1 VideoSourceType: "site"
*s Video Layout Site 1 Output 1 Frame 1 VideoSourceId: 27
*s Video Layout Site 1 Output 1 Frame 1 InputNumber: 1
*s Video Layout Site 1 Output 1 Frame 1 Filename: ""
-
- continues with the video layout status for the Sites [1..n], Outputs [1..n] and Frames [1..n].
** end
Returns information about the presentation view mode.
Value space of the result returned:
<Default/Maximized/Minimized>
Example:
xStatus Video Layout PresentationView
*s Video Layout PresentationView: "Default"
** end
Shows the name of the video layout family.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Video Layout Site 1 Output 1 FamilyName
*s Video Layout Site 1 Output 1 FamilyName: "fullscreen"
** end
Shows the name, included information about selfview on/off, for the video layout family.
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Video Layout Site 1 Output 1 FullFamilyName
*s Video Layout Site 1 Output 1 FullFamilyName: "fullscreen-local-single-camctrl"
** end
Shows the number of the video layout family. The number identifies the layout family of the specified output.
Value space of the result returned:
<Integer value>
Example:
xStatus Video Layout Site 1 Output 1 FamilyNumber
*s Video Layout Site 1 Output 1 FamilyNumber: 1014
** end
Shows the name of the graphic layout. The name identifies the layout used right now at the specified output.
NOTE: Note that while the FamilyName is constant as the long as the configurations on the system does not change, the GraphicName varies depending on system state (the number of participants for instance).
Value space of the result returned:
<S: 0, 100>
Example:
xStatus Video Layout Site 1 Output 1 GraphicName
*s Video Layout Site 1 Output 1 GraphicName: "full-pip"
** end
Shows the number of the graphic layout. The number identifies the layout used right now at the specified output.
Value space of the result returned:
<Integer value>
Example:
xStatus Video Layout Site 1 Output 1 GraphicNumber
*s Video Layout Site 1 Output 1 GraphicNumber: 1037
** end
Shows the descriptor of the layout.
Value space of the result returned:
<Integer value>
Example:
xStatus Video Layout Site 1 Output 1 Descriptor
*s Video Layout Site 1 Output 1 Descriptor: 3
** end
Shows the descriptor output of the layout.
Value space of the result returned:
<Integer value>
Example:
xStatus Video Layout Site 1 Output 1 DescriptorOutput
*s Video Layout Site 1 Output 1 DescriptorOutput: 1
** end
Shows the horizontal position of the upper left corner of the frame.
Value space of the result returned:
<0..10000>
Example:
xStatus Video Layout Site 1 Output 1 Frame 1 PositionX
*s Video Layout Site 1 Output 1 Frame 1 PositionX: 0
** end
Shows the vertical position of the upper left corner of the frame.
Value space of the result returned:
<0..10000>
Example:
xStatus Video Layout Site 1 Output 1 Frame 1 PositionY
*s Video Layout Site 1 Output 1 Frame 1 PositionY: 0
** end
Shows the width of the frame.
Value space of the result returned:
<0..10000>
Example:
xStatus Video Layout Site 1 Output 1 Frame 1 Width
*s Video Layout Site 1 Output 1 Frame 1 Width: 10000
** end
Shows the height of the frame.
Value space of the result returned:
<0..10000>
Example:
xStatus Video Layout Site 1 Output 1 Frame 1 Height
*s Video Layout Site 1 Output 1 Frame 1 Height: 10000
** end
Shows the layer of the frame.
Value space of the result returned:
<1..6>
Example:
xStatus Video Layout Site 1 Output 1 Frame 1 Layer
*s Video Layout Site 1 Output 1 Frame 1 Layer: 1
** end
Describes the video source type in the frame.
Value space of the result returned:
<S:0,.100>
Example:
xStatus Video Layout Site 1 Output 1 Frame 1 VideoSourceType
*s Video Layout Site 1 Output 1 Frame 1 VideoSourceType: "graphic"
** end
Shows the video source Id which is used when adding or updating frames. See the xCommand Video Layout Frame Add and xCommand Video Layout Frame Update.
Value space of the result returned:
<1..5>
Example:
xStatus Video Layout Site 1 Output 1 Frame 1 VideoSourceId
*s Video Layout Site 1 Output 1 Frame 1 VideoSourceId: 0
** end
Shows the layout input number.
Value space of the result returned:
<1..5>
Example:
xStatus Video Layout Site 1 Output 1 Frame 1 InputNumber
*s Video Layout Site 1 Output 1 Frame 1 InputNumber: 0
** end
Shows the filename of the layout frame.
Value space of the result returned:
<S: 0, 200>
Example:
xStatus Video Layout Site 1 Output 1 Frame 1 Filename
*s Video Layout Site 1 Output 1 Frame 1 Filename: "/user/posters/wallpaper.png"
** end
The xStatus Experimental commands
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery ProtectionPackets MediaPacketsCovered
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery ProtectionPackets MediaPacketsCovered: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery ProtectionPackets Received
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery ProtectionPackets Received: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery ProtectionPackets Lost
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery ProtectionPackets Lost: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery ProtectionPackets OutOfOrder
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery ProtectionPackets OutOfOrder: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Received
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Received: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Lost
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Lost: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets OutOfOrder
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets OutOfOrder: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Recovered
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Recovered: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets ConsecutiveLost
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets ConsecutiveLost: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics ZeroLost
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics ZeroLost: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics OneLost
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics OneLost: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics TwoLost
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics TwoLost: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics ThreeLost
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics ThreeLost: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics FourLost
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics FourLost: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics MoreThanFourLost
*s Experimental Diagnostics Call 27 Channels IncomingDataChannel 327 PacketRecovery MediaPackets Statistics MoreThanFourLost: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Shows the stereo echo cancellation mode.
Value space of the result returned:
<On/Off>
Example:
xStatus Experimental Audio StereoEchoCancellation Mode
*s Experimental Audio StereoEchoCancellation Mode: Off
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Shows if there is a signal on the connector.
Value space of the result returned:
<True/False>
Example:
xStatus Experimental Audio Input Connectors Microphone 1 Activity
*s Experimental Audio Input Connectors Microphone 1 Activity: True
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Shows if there is a signal on the connector.
Value space of the result returned:
<True/False>
Example:
xStatus Experimental Audio Input Connectors Line 1 Activity
*s Experimental Audio Input Connectors Line 1 Activity: False
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Shows if there is a signal on the connector.
Value space of the result returned:
<True/False>
Example:
xStatus Experimental Audio Input Connectors HDMI 3 Activity
*s Experimental Audio Input Connectors HDMI 3 Activity: False
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Audiotracking Camera 1 Angle
*s Experimental Audiotracking Camera 1 Angle: 0
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Value space of the result returned:
<Integer value>
Example:
xStatus Experimental Audiotracking Camera 1 Quality
*s Experimental Audiotracking Camera 1 Quality: 0
** end
If CTMS negotiation is performed during a call this node can give feedback on the negotiation. The command has three feedbacks:
1) The Status feedback will tell if the negotiation was successful or failed.
2) If the negotiation failed the Reason feedback will display a message that indicates what went wrong. Example: "Timeout", "Media received before completion".
3) The Version feedback will display a message telling what version was negotiated. When failed, version=0.
NOTE: This Experimental command can be used 'as is'. The Experimental settings WILL change.
Value space of the result returned:
Experimental CTMS Call [1..n] CTMS Negotiation Status: <Success/Failed>
Experimental CTMS Call [1..n] CTMS Negotiation Reason: <S: 0, 255>
Experimental CTMS Call [1..n] CTMS Negotiation Version: <0..4>
Example:
Success scenario:
xStatus Experimental CTMS
*s Experimental CTMS Call 3 CTMS Negotiation Status: Success
*s Experimental CTMS Call 3 CTMS Negotiation Reason: ""
*s Experimental CTMS Call 3 CTMS Negotiation Version: 3
** end
Failure scenario:
xStatus Experimental CTMS
*s Experimental CTMS Call 4 CTMS Negotiation Status: Failed
*s Experimental CTMS Call 4 CTMS Negotiation Reason: "Media received before completion"
*s Experimental CTMS Call 4 CTMS Negotiation Version: 0
** end
No negotiation:
xStatus Experimental CTMS
** end