Technical References
D14642.13 Codec C40-C60 API Reference Guide TC6.3, NOVEMBER 2013. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. 17
Cisco TelePresence System Codec C40/C60 API Reference Guide
Addressing status information with xStatus
To read the status from the system type the root command (xStatus) followed by a path (address expression):
xStatus <address expression>
Example 1: Query all ongoing Call information:
xStatus Call
*s Call 3 Status: Connected
*s Call 3 Direction: Incoming
*s Call 3 Protocol: “sip”
*s Call 3 CallType: Video
*s Call 3 RemoteNumber: “name@company.com”
*s Call 3 CallbackNumber: “sip:name@company.com”
*s Call 3 DisplayName: “Name”
*s Call 3 TransmitCallRate: 512
*s Call 3 ReceiveCallRate: 512
*s Call 3 CallPriority: None
*s Call 3 FacilityServiceId: 0
*s Call 3 Encryption Type: “Aes-128”
*s Call 3 PlacedOnHold: False
*s Call 3 Duration: 123
*s Call 3 AnswerState: Answered
*s Call 3 ModifyState: Idle
*s Call 3 DeviceType: Endpoint
** end
OK
Example 2: Query the protocol for a call:
xStatus Call Protocol
*s Call 3 Protocol: “sip”
OK
xStatus ?
– Status –
Audio
C a l l[...]
C a m e r a[1..7]
Conference
Diagnostics
Experimental
GPIO
H320
H323
HttpFe e d back[1..4]
MediaChannels
Network
NetworkServices
Pr eset[1..15]
Provisioning
Security
SIP
Standby
SystemUnit
Time
Video
OK
Status
A status contains the current state of the codec, such as
connected calls, the status of the gatekeeper registration,
connected inputs and output sources.
Writing xStatus ? on the command line lists all top level
statuses.
Writing xStatus lists all statuses and their current values.
To list out only some of the statuses, write xStatus followed
by the relevant part of the status path.
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API