D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014.
Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
171
Cisco TelePresence System Codec C40/C60
API Reference Guide
xStatus ICE Turn Hostname
Returns the hostname, or IP address, that is configured as the TURN server.
Value space of the result returned:
<String>
Example:
xStatus ICE Turn Hostname
*s ICE Turn Hostname: "callway.medianetworkservices.com"
** end
xStatus ICE Turn Username
Returns the user name used for accessing the TURN server.
Value space of the result returned:
<String>
Example:
xStatus ICE Turn Username
*s ICE Turn Username: "username"
** end
xStatus ICE Call Result
Shows the state of the ICE routing in the present call.
Succeeded: The ICE routing is in use.
Failed: The ICE routing has failed.
Unsupported: ICE routing is not supported.
Mangled: ICE cannot route the media, because a server, such as VCS, is set to handle it.
Value space of the result returned:
<Succeeded/Failed/Unsupported/Mangled>
Example:
xStatus ICE Call Result
*s ICE Call 0 Result: "Unsupported"
** end
xStatus ICE Call Local Candidate
Returns the network interface type the local system is using to send media.
HOST: The endpoint sends media from its own IP address.
PRFLX: The endpoint sends media from its public IP address as seen by the remote Peer.
SRFLX: The endpoint sends media from its public IP address as seen by the TURN server.
RELAY: The endpoint sends media from the IP address and port allocated on the TURN server, and
is used as a fallback until ICE has concluded.
Value space of the result returned:
<HOST/PRFLX/SRLFX/RELAY>
Example:
xStatus ICE Call Local Candidate
*s ICE Call 1 Local Candidate: “HOST”
** end
xStatus ICE Call Local IP
Returns the IP address the local system is using for media routing in the present call.
Value space of the result returned:
<String>
Example:
xStatus ICE Call Local IP
*s ICE Call 1 Local IP: “192.0.1.20”
** end
xStatus ICE Call Remote Candidate
Returns the network interface type the remote system is using to send media.
HOST: The far-end receives media on its own IP address.
PRFLX: The far-end receives media on its public IP address as seen by the remote Peer.
SRFLX: The far-end receives media on its public IP address as seen by the TURN server.
RELAY: The far-end receives media on the IP address and port allocated on the TURN server, and is
used as a fallback until ICE has concluded.
Value space of the result returned:
<HOST/PRFLX/SRFLX/RELAY>
Example:
xStatus ICE Call Remote Candidate
*s ICE Call 1 Remote Candidate: “SRFLX”
** end
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xStatus