xCommand
xCommand
Description of the xCommand commands for Cisco TelePresence System Codec C90 with software version TC5.0
Revision: D1464707
The xCommand type commands instruct the codec to execute actions, like to dial a number, move a camera or query the phone book. All commands start with the prefix xCommand followed by a command path. The commands are case-insensitive.
- Writing xcommand ? on the command line will list all the top level commands.
- Writing xcommand ?? will list all command and their value spaces.
- To only list out parts of the commands, write xcommand followed by one or more parts of the path.
Required parameters: The required parameters are marked with (r).
String parameters: In this document, string parameters have the syntax <S: 0, 255>, which means that the length of the string can be from 0 to 255 characters. String parameters must be enclosed in quotation marks when you issue a command.
Integer parameters: In this document, integer parameters have the syntax <0..100>, which means that the value can go from 0 to 100.
Troubleshooting: Check that the spelling and syntax is right. Check also that the value space is valid and that all the required parameters are included.
User roles: The user accounts on the system can have three different user roles which possess different system rights.
- ADMIN: A user account with ADMIN rights can create new users and change all settings, except the security audit configurations. The ADMIN user can upload all certificates, except the audit certificates.
- USER: A user account with USER rights can make calls and search the phonebook.
- AUDIT: A user account with AUDIT rights can change the security audit settings and upload audit certificates.
The system comes with a default user account. The user name is admin with no password set. This user has USER, ADMIN and AUDIT rights.
NOTE: It is very important that at least one user has ADMIN rights at all times.
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 C Series.
All contents are Copyright 2010 Cisco Systems, Inc. All rights reserved.
The xCommand Audio commands
Shows the current equalizer settings for the codec.
Requires user role:
Parameters:
EqualizerId: <1..8>
Example:
xCommand Audio Equalizer List EqualizerId: 1
*r AudioEqualizerListResult Equalizer 1 Section 1 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 1 Frequency: "100"
*r AudioEqualizerListResult Equalizer 1 Section 1 Q: "4"
*r AudioEqualizerListResult Equalizer 1 Section 1 Gain: "0"
*r AudioEqualizerListResult Equalizer 1 Section 2 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 2 Frequency: "200"
*r AudioEqualizerListResult Equalizer 1 Section 2 Q: "4"
*r AudioEqualizerListResult Equalizer 1 Section 2 Gain: "0"
*r AudioEqualizerListResult Equalizer 1 Section 3 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 3 Frequency: "500"
*r AudioEqualizerListResult Equalizer 1 Section 3 Q: "4"
*r AudioEqualizerListResult Equalizer 1 Section 3 Gain: "0"
*r AudioEqualizerListResult Equalizer 1 Section 4 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 4 Frequency: "1000"
*r AudioEqualizerListResult Equalizer 1 Section 4 Q: "4"
*r AudioEqualizerListResult Equalizer 1 Section 4 Gain: "0"
*r AudioEqualizerListResult Equalizer 1 Section 5 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 5 Frequency: "2000"
*r AudioEqualizerListResult Equalizer 1 Section 5 Q: "4"
*r AudioEqualizerListResult Equalizer 1 Section 5 Gain: "0"
*r AudioEqualizerListResult Equalizer 1 Section 6 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 6 Frequency: "5000"
*r AudioEqualizerListResult Equalizer 1 Section 6 Q: "0"
*r AudioEqualizerListResult Equalizer 1 Section 6 Gain: "0"
** end
The system has eight user defined equalizers, each made up of six second order IIR sections. Each of the eight equalizers can be applied to one or more of the audio input and output connectors on the codec. Each IIR section can be modified independently.
There are five filter types, and the frequency response variations dependent on some of the parameter variations. The Q-value for low pass, high pass, low shelf and high shelf filters should be set to 1/sqrt(2) in order to get maximally flat responses. The Q-value (or Q-factor) is defined as Q=f0/bw. Where f0=resonance frequency in Hz; and bw=filter bandwidth in Hz.
To switch off one of the six equalizer sections; set the second order section to have a flat frequency response. This can be done by setting the filter type to "none" or by setting the filter type to "peaking" and the gain to "0" (zero).
We recommend using the TC Console tool, with the embedded equalizer GUI, to modify the equalizers. The TC Console software is found on the Developer Zone web page. Go to: http://developer.tandberg.com/web/guest/tools/integrators/audio-console.
Requires user role:
Parameters:
EqualizerId(r): <1..8>
Section(r): <1..6>
FilterType(r): <HighPass/HighShelf/LowPass/LowShelf/None/Peaking>
Frequency(r): <S: 0, 32>
Q(r): <S: 0, 32>
Gain(r): <S: 0, 32>
Example:
xCommand Audio Equalizer List EqualizerId: 1 Section: 1 FilterType: Peaking Frequency: "100" Q: "4" Gain: "0"
*r AudioEqualizerListResult Equalizer 1 Section 1 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 1 Frequency: "100"
*r AudioEqualizerListResult Equalizer 1 Section 1 Q: "4"
*r AudioEqualizerListResult Equalizer 1 Section 1 Gain: "0"
*r AudioEqualizerListResult Equalizer 1 Section 2 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 2 Frequency: "200"
*r AudioEqualizerListResult Equalizer 1 Section 2 Q: "4"
*r AudioEqualizerListResult Equalizer 1 Section 2 Gain: "0"
*r AudioEqualizerListResult Equalizer 1 Section 3 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 3 Frequency: "500"
*r AudioEqualizerListResult Equalizer 1 Section 3 Q: "4"
*r AudioEqualizerListResult Equalizer 1 Section 3 Gain: "0"
*r AudioEqualizerListResult Equalizer 1 Section 4 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 4 Frequency: "1000"
*r AudioEqualizerListResult Equalizer 1 Section 4 Q: "4"
*r AudioEqualizerListResult Equalizer 1 Section 4 Gain: "0"
*r AudioEqualizerListResult Equalizer 1 Section 5 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 5 Frequency: "2000"
*r AudioEqualizerListResult Equalizer 1 Section 5 Q: "4"
*r AudioEqualizerListResult Equalizer 1 Section 5 Gain: "0"
*r AudioEqualizerListResult Equalizer 1 Section 6 FilterType: "Peaking"
*r AudioEqualizerListResult Equalizer 1 Section 6 Frequency: "5000"
*r AudioEqualizerListResult Equalizer 1 Section 6 Q: "0"
*r AudioEqualizerListResult Equalizer 1 Section 6 Gain: "0"
** end
Mute all microphones.
Requires user role:
Example:
xCommand Audio Microphones Mute
*r AudioMicrophonesMuteResult (status=OK):
** end
Unmute microphones.
Requires user role:
Example:
xCommand Audio Microphones Unmute
*r AudioMicrophonesUnmuteResult (status=OK):
** end
Create a local input and generate the local input id. A local input is a mix of input connectors with the following settings: Name, MixerMode, AGC, Mute and Channels.
InputId: A unique identifier for the local input.
Name: Choose a name that describes the mix of input connectors.
MixerMode Auto: The microphone with the strongest speaker is active and the others are strongly attenuated.
MixerMode Fixed: The input connector signals are mixed together with equal gains.
MixerMode GainShared: The microphones are given a normalized gain factor relative to the strongest speaker before being mixed together.
AGC: Automatic Gain Control.
Mute: Mutes the mix of input connectors.
Channels: Set channels to 1 to mix the input connectors into a mono signal. To mix the input connectors into a stereo signal, set channels to 2.
Requires user role:
Parameters:
InputId: <0..65534>
Name: <S: 0, 255>
MixerMode: <Auto/Fixed/GainShared>
AGC: <On/Off>
Mute: <On/Off>
Channels: <1..2>
Example:
xCommand Audio LocalInput Add
OK
*r AudioInputGroupAddResult (status=OK):
InputId: 2
** end
Update the settings of the local input given by the input ID.
InputId: A unique identifier for the local input.
Name: Choose a name that describes the mix of input connectors.
MixerMode Auto: The microphone with the strongest speaker is active and the others are strongly attenuated.
MixerMode Fixed: The input connector signals are mixed together with equal gains.
MixerMode GainShared: The microphones are given a normalized gain factor relative to the strongest speaker before being mixed together.
AGC: Automatic Gain Control.
Mute: Mutes the mix of input connectors.
Channels: Set channels to 1 to mix the input connectors into a mono signal. To mix the input connectors into a stereo signal, set channels to 2.
Requires user role:
Parameters:
InputId(r): <0..65534>
Name(r): <S: 0, 255>
MixerMode(r): <Auto/Fixed/GainShared>
AGC(r): <On/Off>
Mute(r): <On/Off>
Channels(r): <1..2>
Example:
xCommand Audio LocalInput Update InputId: 2 Name: "Microphone" MixerMode: GainShared AGC: Off Mute: Off Channels: 1
OK
*r AudioInputGroupUpdateResult (status=OK):
** end
Remove the local input given by the input ID.
InputId: A unique identifier for the local input.
Requires user role:
Parameters:
InputId(r): <0..65534>
Example:
xCommand Audio LocalInput Remove InputID: 2
OK
*r AudioInputGroupRemoveResult (status=OK):
** end
Attach an input connector to the local input given by the input ID. A connector is defined by its type and ID.
InputId: A unique identifier for the local input.
ConnectorType: Select the connector type.
ConnectorId: Select a connector.
Requires user role:
Parameters:
InputId(r): <0..65534>
ConnectorType(r): <HDMI/Line/Microphone>
ConnectorId(r): <1..8>
Example:
xCommand Audio LocalInput AddConnector InputId: 3 ConnectorType: Line ConnectorId: 1
OK
*r AudioInputGroupAddConnectorResult (status=OK):
** end
Detach an input connector from the local input given by the input ID. A connector is defined by its type and ID.
InputId: A unique identifier for the local input.
ConnectorType: Select the connector type.
ConnectorId: Select the connector.
Requires user role:
Parameters:
InputId(r): <0..65534>
ConnectorType(r): <HDMI/Line/Microphone>
ConnectorId(r): <1..8>
Example:
xCommand Audio LocalInput RemoveConnector InputId: 3 ConnectorType: Line ConnectorId: 1
OK
*r AudioInputGroupRemoveConnectorResult (status=OK):
** end
Create a local output and generate the local output id. A local output is a mix of local input and remote input signals. All connectors attached to the local output receive the same signal.
OutputId: A unique identifier for the local output.
Name: Choose a name that describes the local output.
Loudspeaker: If one or more of the output connectors are connected to a loudspeaker, this signal should be a reference signal to the echo canceller. Hence set loudspeaker to On. NOTE: When microphone reinforcement is disabled there should only be one loudspeaker local output.
Channels: Set channels to 1 to mix the local and remote inputs into a mono signal. To mix the inputs into a stereo signal, set channels to 2.
Requires user role:
Parameters:
OutputId: <0..65534>
Name: <S: 0, 255>
Loudspeaker: <On/Off>
Channels: <1..2>
Example:
xCommand Audio LocalOutput Add
OK
*r AudioOutputGroupAddResult (status=OK):
OutputId: 47
** end
Update the settings of the local output given by the output ID.
OutputId: A unique identifier for the local output.
Name: Choose a name that describes the local output.
Loudspeaker: If one or more of the output connectors are connected to a loudspeaker, this signal should be a reference signal to the echo canceller. Hence set loudspeaker to On. NOTE: When microphone reinforcement is disabled there should only be one loudspeaker local output.
Channels: Set channels to 1 to mix the local and remote inputs into a mono signal. To mix the inputs into a stereo signal, set channels to 2.
Requires user role:
Parameters:
OutputId(r): <0..65534>
Name(r): <S: 0, 255>
Loudspeaker(r): <On/Off>
Channels(r): <1..2>
Example:
xCommand Audio LocalOutput Update OutputId: 5 Name: "Loudspeaker" Loudspeaker: On Channels: 2
OK
*r AudioOutputGroupUpdateResult (status=OK):
** end
Remove the local output given by the output ID.
OutputId: A unique identifier for the local output.
Requires user role:
Parameters:
OutputId(r): <0..65534>
Example:
xCommand Audio LocalOutput Remove OutputId: 6
OK
*r AudioOutputGroupRemoveResult (status=OK):
** end
Attach an output connector to the local output given by the output ID. A connector is defined by its type and ID.
OutputId: A unique identifier for the local output.
ConnectorType: Select the connector type.
ConnectorId: Select a connector.
Requires user role:
Parameters:
OutputId(r): <0..65534>
ConnectorType(r): <HDMI/Line>
ConnectorId(r): <1..8>
Example:
xCommand Audio LocalOutput AddConnector OutputId:5 ConnectorType: Line ConnectorId:1
OK
*r AudioOutputGroupAddConnectorResult (status=OK):
** end
Detach an output connector from the local output given by the output ID. A connector is defined by its type and ID.
OutputId: A unique identifier for the local output.
ConnectorType: Select the connector type.
ConnectorId: Select the connector.
Requires user role:
Parameters:
OutputId(r): <0..65534>
ConnectorType(r): <HDMI/Line>
ConnectorId(r): <1..8>
Example:
xCommand Audio LocalOutput RemoveConnector OutputId:5 ConnectorType: Line ConnectorId:1
OK
*r AudioOutputGroupRemoveConnectorResult (status=OK):
** end
Connect a local or remote input to a local output by giving their IDs as parameters.
OutputId: A unique identifier for the local output.
InputId: A unique identifier for the local input.
InputGain: Set a gain on the input signal in the range from -54dB to 15dB. The value -54dB equals Off.
Requires user role:
Parameters:
OutputId(r): <0..65534>
InputId(r): <0..65534>
InputGain: <-54..15>
Example:
xCommand Audio LocalOutput ConnectInput OutputId:6 InputId:3
OK
*r AudioOutputGroupConnectInputResult (status=OK):
** end
Update the gain of a local or remote input connected to a local output. The gain on the input signal is in the range from -54dB to 15dB. The value -54dB equals Off.
OutputId: A unique identifier for the local output.
InputId: A unique identifier for the local input.
InputGain: Set a gain on the input signal in the range from -54dB to 15dB. The value -54dB equals Off.
Requires user role:
Parameters:
OutputId(r): <0..65534>
InputId(r): <0..65534>
InputGain: <-54..15>
Example:
xCommand Audio LocalOutput UpdateInputGain OutputId:6 InputId:3
OK
*r AudioOutputGroupUpdateInputGainResult (status=OK):
** end
Disconnect a local or remote input from a local output.
OutputId: A unique identifier for the local output.
InputId: A unique identifier for the local or remote input.
Requires user role:
Parameters:
OutputId(r): <0..65534>
InputId(r): <0..65534>
Example:
xCommand Audio LocalOutput DisconnectInput OutputId:6 InputId:3
OK
*r AudioOutputGroupDisconnectInputResult (status=OK):
** end
Connect a local or remote input to a remote output with their IDs as parameters. When a call is made a remote input and remote output pair is created.
OutputId: A unique identifier for the local output.
InputId: A unique identifier for the local or remote input.
InputGain: Set a gain on the input signal in the range from -54dB to 15dB. The value -54dB equals Off.
Requires user role:
Parameters:
OutputId(r): <0..65534>
InputId(r): <0..65534>
InputGain: <-54..15>
Example:
xCommand Audio RemoteOutput ConnectInput OutputId:10 InputId:8
OK
*r AudioRemoteOutputGroupConnectInputResult (status=OK):
** end
Update the gain of a local or remote input connected to a remote output.
OutputId: A unique identifier for the local output.
InputId: A unique identifier for the local or remote input.
InputGain: Set a gain on the input signal in the range from -54dB to 15dB. The value -54dB equals Off.
Requires user role:
Parameters:
OutputId(r): <0..65534>
InputId(r): <0..65534>
InputGain: <-54..15>
Example:
xCommand Audio RemoteOutput UpdateInputGain OutputId:6 InputId:3
OK
*r AudioRemoteOutputGroupUpdateInputGainResult (status=OK):
** end
Disconnect a local or remote input from a remote output with their IDs as parameters.
OutputId: A unique identifier for the local output.
InputId: A unique identifier for the local or remote input.
Requires user role:
Parameters:
OutputId(r): <0..65534>
InputId(r): <0..65534>
Example:
xCommand Audio RemoteOutput DisconnectInput OutputId:10 InputId:8
OK
*r AudioRemoteOutputGroupDisconnectInputResult (status=OK):
** end
Remove all local inputs and local outputs.
Requires user role:
Example:
xCommand Audio Setup Clear
*r AudioSetupClearResult (status=OK):
** end
Play the specified audio sound.
Requires user role:
Parameters:
Sound(r): <Busy/CallWaiting/Dial/KeyTone/Ringing/SpecialInfo/TelephoneCall/VideoCall>
Loop: <On/Off>
Example:
xCommand Audio Sound Play Sound: Ringing
*r AudioSoundPlayResult (status=OK):
** end
Stop playing audio sound.
Requires user role:
Example:
xCommand Audio Sound Stop
*r AudioSoundStopResult (status=OK):
** end
Start collecting VU meter information for connector given by type and ID.
Requires user role:
Parameters:
ConnectorType(r): <HDMI/Line/Microphone>
ConnectorId(r): <1..8>
Example:
xCommand Audio Vumeter Start ConnectorType: Microphone ConnectorId: 1
*r AudioVumeterStartResult (status=OK):
** end
Stop collecting VU meter information for connector given by type and ID.
Requires user role:
Parameters:
ConnectorType(r): <HDMI/Line/Microphone>
ConnectorId(r): <1..8>
Example:
xCommand Audio Vumeter Stop ConnectorType: Microphone ConnectorId: 1
*r AudioVumeterStopResult (status=OK):
** end
The xCommand Bookings commands
Clear the current stored list of bookings.
Requires user role:
Example:
xCommand Bookings Clear
** end
OK
List the stored bookings for the system. The list of booking details is received from the management system. All parameters are optional, and can be used to limit the search result.
If no parameters are used, past, present and future bookings are all listed. To avoid listing bookings from yesterday and before, use DayOffset = 0.
Days: Number of days to retrieve bookings from.
DayOffset: Which day to start the search from (today: 0, tomorrow: 1…).
Limit: Max number of bookings to list.
Offset: Offset number of bookings for this search.
Requires user role:
Parameters:
Days: <1..365>
DayOffset: <0..365>
Limit: <1..65534>
Offset: <0..65534>
Example:
Example 1 (One booking in list)
xCommand Bookings List
OK
*r Bookings ResultInfo TotalRows: 1
*r Bookings LastUpdated: "2011-09-02T11:19:01Z"
*r Bookings Booking 1 Id: "273"
*r Bookings Booking 1 Title: "Sales meeting"
*r Bookings Booking 1 Agenda: "Describe this command"
*r Bookings Booking 1 Privacy: Public
*r Bookings Booking 1 Organizer FirstName: "Ola"
*r Bookings Booking 1 Organizer LastName: "Normann"
*r Bookings Booking 1 Organizer Email: "ola.normann@domain.com"
*r Bookings Booking 1 Time StartTime: "2011-09-02T13:00:00Z"
*r Bookings Booking 1 Time StartTimeBuffer: 600
*r Bookings Booking 1 Time EndTime: "2011-09-02T13:30:00Z"
*r Bookings Booking 1 Time EndTimeBuffer: 0
*r Bookings Booking 1 MaximumMeetingExtension: 30
*r Bookings Booking 1 MeetingExtensionAvailability: Guaranteed
*r Bookings Booking 1 BookingStatus: OK
*r Bookings Booking 1 BookingStatusMessage: ""
*r Bookings Booking 1 Webex Enabled: True
*r Bookings Booking 1 Webex Url: "http://webex.url"
*r Bookings Booking 1 Webex MeetingNumber: "webexNumber@cisco.com"
*r Bookings Booking 1 Webex Password: ""
*r Bookings Booking 1 Webex HostKey: ""
*r Bookings Booking 1 Webex DialInNumbers DialInNumber 1 Type: TollFree
*r Bookings Booking 1 Webex DialInNumbers DialInNumber 1 Number: "+1 987 654321"
*r Bookings Booking 1 Webex DialInNumbers DialInNumber 2 Type: Toll
*r Bookings Booking 1 Webex DialInNumbers DialInNumber 2 Number: "+1 987 654322"
*r Bookings Booking 1 InteropBridge Number: ""
*r Bookings Booking 1 InteropBridge ConferenceId: ""
*r Bookings Booking 1 ManualCallIn Number: ""
*r Bookings Booking 1 ManualCallIn ConferenceId: ""
*r Bookings Booking 1 ManualCallIn ConferencePassword: ""
*r Bookings Booking 1 Encryption: BestEffort
*r Bookings Booking 1 Role: Slave
*r Bookings Booking 1 Recording: Disabled
*r Bookings Booking 1 DialInfo Calls Call 1 Number: "91123456;conference-id=2100170569"
*r Bookings Booking 1 DialInfo Calls Call 1 Protocol: SIP
*r Bookings Booking 1 DialInfo Calls Call 1 CallRate: 3000
*r Bookings Booking 1 DialInfo Calls Call 1 CallType: Video
*r Bookings Booking 1 DialInfo ConnectMode: OBTP
** end
Example 2 (When no bookings have been received, or after all bookings have been removed by the command xCommand Bookings Clear)
xCommand Bookings List
OK
*r Bookings Error: "No bookings found."
*r Bookings ResultInfo TotalRows: 0
*r Bookings LastUpdated: Never
** end
The xCommand Boot commands
Reboot system.
Requires user role:
Example:
xCommand Boot
*r BootResult (status=OK):
** end
OK
CUIL reboot request, restarting
Connection closed by foreign host.
The xCommand Call commands
Accept an incoming call. If no CallId is specified, all incoming calls will be accepted. The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role:
Parameters:
CallId: <0..65534>
Example:
xCommand Call Accept CallId:19
OK
*r CallAcceptResult (status=OK):
** end
Reject incoming call. If no call id is specified, all incoming calls will be rejected. The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role:
Parameters:
CallId: <0..65534>
Example:
xCommand Call Reject CallId:20
OK
*r CallRejectResult (status=OK):
** end
Disconnect a call. The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role:
Parameters:
CallId(r): <0..65534>
Example:
xCommand Call Disconnect CallId:17
OK
*r DisconnectCallResult (status=OK):
** end
Disconnect all active calls.
Requires user role:
Example:
xCommand Call DisconnectAll
OK
*r DisconnectAllResult (status=OK):
** end
Put a call on hold. The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role:
Parameters:
CallId(r): <0..65534>
Example:
xCommand Call Hold CallId:19
OK
*r CallHoldResult (status=OK):
** end
Join all existing calls, active and on hold.
Requires user role:
Parameters:
No parameters.
Example:
xCommand Call Join
OK
*r CallJoinResult (status=OK):
** end
Resume a call that have been put on hold. The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role:
Parameters:
CallId(r): <0..65534>
Example:
xCommand Call Resume CallId:19
OK
*r CallResumeResult (status=OK):
** end
Request to extend the conference for the call with the specified CallId.
For this command to apply, the following are required:
1) The result from the xStatus Conference Site <CallId> ConferenceExtended must be NotExtended: *s Conference Site <CallId> ConferenceExtended: NotExtended
2) The following tag from the bookings list command must have a value > 0:
*r Bookings Booking <bookingNumber> MaximumMeetingExtension: "30"
Note: The command returns the result from the command itself, not the result from the extension request to far end. The result from the extension request will be given by a separate event.
CallId: CallId for the call in question.
Requires user role:
Parameters:
CallId(r): <0..65534>
Example:
xCommand Call ExtendConference CallId: 1
OK
*r CallExtendConferenceResult (status=OK)
** end
The xCommand CallLog commands
Clear call logs stored in the system. If a logtag is given as argument, that specific call is deleted from the logs. If no logtag is given then all call logs will be deleted. The LogTag values for the calls are found by issuing the xHistory CallLog Call command.
Requires user role:
Parameters:
LogTag: <0..2147483647>
Example:
xCommand CallLog Clear
*r ClearResult (status=OK):
** end
Delete the call log of recent calls. If a logtag is given as argument, that specific call is deleted from the log. If no logtag is given, the complete recent calls log will be deleted. The LogTag values for recent calls are found by issuing the xHistory CallLog Recent command.
Requires user role:
Parameters:
LogTag: <0..2147483647>
Example:
xCommand CallLog Recent Delete
*r DeleteResult (status=OK):
** end
Delete the call log of outgoing calls. If a logtag is given as argument, that specific call is deleted from the log. If no logtag is given, the complete outgoing calls log will be deleted. The LogTag values for outgoing calls are found by issuing the xHistory CallLog Outgoing command.
Requires user role:
Parameters:
LogTag: <0..2147483647>
Example:
xCommand CallLog Outgoing Delete LogTag:202
*r DeleteResult (status=OK):
** end
Delete the call log of received calls. If a logtag is given as argument, that specific call is deleted from the log. If no logtag is given, the complete received calls log will be deleted. The LogTag values for received calls are found by issuing the xHistory CallLog Received command.
Requires user role:
Parameters:
LogTag: <0..2147483647>
Example:
xCommand CallLog Received Delete LogTag:126
*r DeleteResult (status=OK):
** end
Delete the call log of missed calls. If a logtag is given as argument, that specific call is deleted from the log. If no logtag is given, the complete missed calls log will be deleted. The LogTag values for missed calls are found by issuing the xHistory CallLog Missed command.
Requires user role:
Parameters:
LogTag: <0..2147483647>
Example:
xCommand CallLog Missed Delete LogTag:119
*r DeleteResult (status=OK):
** end
Review the call log of dismissed calls. If a logtag is given as argument, that specific call is deleted from the log. If no logtag is given, the complete missed calls log will be deleted. The LogTag values for missed calls are found by issuing the xHistory CallLog Missed command.
Requires user role:
Parameters:
LogTag: <0..2147483647>
Example:
xCommand CallLog Missed Dimissed LogTag:119
*r DismissResult (status=OK):
** end
The xCommand CamCtrlPip commands
Show or hide the camera selfview in a small window (picture in picture).
Requires user role:
Parameters:
Mode(r): <On/Off>
Example:
xCommand CamCtrlPip Mode: On
*r CamCtrlPipResult (status=OK):
** end
The xCommand Camera commands
The camera is reset to its default values for pan and tilt. If the camera is daisy chained, the CameraId is given by its place in the chain.
Requires user role:
Parameters:
CameraId(r): <1..7>
Example:
xCommand Camera PanTiltReset CameraId:1
OK
*r PanTiltResetResult (status=OK):
** end
Reset the camera position the the deafult position.
Requires user role:
Parameters:
CameraId(r): <1..7>
Example:
xCommand Camera PositionReset CameraId:1
OK
*r CameraPositionResetResult (status=OK):
** end
Position the camera by defining the pan, tilt, zoom and focus parameters. If the camera is placed in a daisy chain you need to know the CameraId for the camera you want to address.
Requires user role:
Parameters:
CameraId(r): <1..7>
Pan: <-65535..65535>
Tilt: <-65535..65535>
Zoom: <0..65535>
Focus: <0..65535>
Example:
xCommand Camera PositionSet CameraId:1 Pan:200 Tilt:300
OK
*r CameraPositionSetResult (status=OK):
** end
Move the camera in a specified direction. The camera will move at specified speed until a stop command is issued. In a daisy chain, you need to know the CameraId for the camera you want to address. Be aware that pan and tilt can be operated simultaneously, but no other combinations. In the latter case only the first operation specified will be executed. For example, if you try to run both zoom and pan at the same time, only zoom is executed.
NOTE: You must run a stop command to stop the camera, see the example below.
CameraId: Give the camera id.
Pan: Move the camera to the Left or Right, followed by Stop.
PanSpeed: Set the pan speeed.
Tilt: Move the camera Up or Down, followed by Stop.
TiltSpeed: Set the tilt speeed.
Zoom: Zoom the camera In or Out, followed by Stop.
ZoomSpeed: Set the zoom speeed.
Focus: Focus the camera Far or Near, followed by Stop.
Requires user role:
Parameters:
CameraId(r): <1..7>
Pan: <Left/Right/Stop>
PanSpeed: <1..15>
Tilt: <Down/Up/Stop>
TiltSpeed: <1..15>
Zoom: <In/Out/Stop>
ZoomSpeed: <1..15>
Focus: <Far/Near/Stop>
Example:
xCommand Camera Ramp CameraId:1 Pan:left PanSpeed:1
OK
*r RampResult (status=OK):
** end
xCommand Camera Ramp CameraId:1 Pan:stop
OK
*r RampResult (status=OK):
** end
Reinitialize the daisy chain of cameras and updates the CameraId parameter. The CameraId parameter holds information of which camera is sitting in what position in the camera chain.
Requires user role:
Example:
xCommand Camera ReconfigureCameraChain
*r ReconfigureCameraChainResult (status=OK):
** end
Trigger the autofocus functionality. The camera must support autofocus functionality. If the camera is daisy chained, the CameraId is given by its place in the chain.
Requires user role:
Parameters:
CameraId(r): <1..7>
Example:
xCommand Camera TriggerAutofocus CameraId:1
OK
*r TriggerAutofocusResult (status=OK):
** end
Selects pan, tilt, zoom and focus parameters for the given camera id from the selected preset.
CameraId: Give the camera id.
PresetId: Select preset 1 to 15.
Requires user role:
Parameters:
CameraId(r): <1..7>
PresetId(r): <1..15>
Example:
xCommand Camera PositionActivateFromPreset CameraId:1 PresetID:1
OK
*r PositionActivateFromPresetResult (status=OK):
** end
This command activates a stored camera preset.
Note: The xCommand Camera Preset commands are used to store camera positions for individual cameras. This is in contrast to the xCommand Preset commands where a single preset stores/recalls ALL connected cameras plus the Video Input switcher settings. This makes it more usable for integrations where one wants to store multiple camera positions individually per camera rather than a complete camera position set.
PresetId: The preset number you want to activate.
Requires user role:
Parameters:
PresetId(r): <1..35>
Example:
xCommand Camera Preset Activate PresetId: 1
OK
*r CameraPresetActivateResult (status=OK)
** end
Edit a stored camera preset.
Note: The xCommand Camera Preset commands are used to store camera positions for individual cameras. This is in contrast to the xCommand Preset commands where a single preset stores/recalls ALL connected cameras plus the Video Input switcher settings. This makes it more usable for integrations where one wants to store multiple camera positions individually per camera rather than a complete camera position set.
PresetId: The preset number you want to edit.
ListPosition: The sort order position in the xCommand Camera Preset List result.
Name: The name of the preset in the xCommand Camera Preset List result.
Requires user role:
Parameters:
PresetId(r): <1..35>
ListPosition: <1..35>
Name: <S: 0, 255>
Example:
xCommand Camera Preset Edit PresetId: 1 ListPosition: 1 Name: ""
OK
*r CameraPresetEditResult (status=OK)
** end
List information about available camera presets.
Note: The xCommand Camera Preset commands are used to store camera positions for individual cameras. This is in contrast to the xCommand Preset commands where a single preset stores/recalls ALL connected cameras plus the Video Input switcher settings. This makes it more usable for integrations where one wants to store multiple camera positions individually per camera rather than a complete camera position set.
PresetId: Filter on specified preset.
Requires user role:
Parameters:
PresetId: <1..35>
Example:
xCommand Camera Preset List PresetId: 1
OK
*r CameraPresetListResult (status=OK)
** end
Remove a camera preset.
Note: The xCommand Camera Preset commands are used to store camera positions for individual cameras. This is in contrast to the xCommand Preset commands where a single preset stores/recalls ALL connected cameras plus the Video Input switcher settings. This makes it more usable for integrations where one wants to store multiple camera positions individually per camera rather than a complete camera position set.
PresetId: The id of the camera preset to remove.
Requires user role:
Parameters:
PresetId(r): <1..35>
Example:
xCommand Camera Preset Remove PresetId: 1
OK
*r CameraPresetRemoveResult (status=OK)
** end
Add a new camera preset.
Note: The xCommand Camera Preset commands are used to store camera positions for individual cameras. This is in contrast to the xCommand Preset commands where a single preset stores/recalls ALL connected cameras plus the Video Input switcher settings. This makes it more usable for integrations where one wants to store multiple camera positions individually per camera rather than a complete camera position set.
PresetId: Optional Id for this preset.
CameraId: Which camera to store the position of.
ListPosition: The sort order of the new preset.
Name: The name that will be used in the listing of presets.
Requires user role:
Parameters:
PresetId: <1..35>
CameraId: <1..7>
ListPosition: <1..35>
Name: <S: 0, 255>
Example:
xCommand Camera Preset Store PresetId: 1 CameraId: 1 ListPosition: 1 Name “”
OK
*r CameraPresetStoreResult (status=OK)
** end
The xCommand Dial commands
Dial out from the system. Returns information about the CallId and ConferenceId, which are required for some other commands.
Number: Enter the number or address.
Protocol: Select the H323 or SIP protocol.
CallRate: Set a call rate.
CallType: Select the audio or video call type.
BookingId: Any identifier that an external booking system (e.g. TMS, CTS-MAN) can use for its own references to match placed calls with the booking systems internal identifier for a meeting. This can be any string, e.g. a GUID. The booking Id will be supplied in call logs, call events etc for the call.
Requires user role:
Parameters:
Number(r): <S: 0, 255>
Protocol: <H323/Sip>
CallRate: <64..6000>
CallType: <Audio/Video>
BookingId: <S: 0, 255>
Example:
xCommand Dial Number:543210 Protocol:h323
OK
*r DialResult (status=OK):
CallId: 2
ConferenceId: 1
** end
The xCommand DTMFSend commands
Send DTMF tones to the far end.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
DTMFString: Enter the DTMF string.
Requires user role:
Parameters:
CallId: <0..65534>
DTMFString(r): <S: 0, 32>
Example:
xCommand DTMFSend CallId:2 DTMFString:1234
*r DTMFSendResult (status=OK):
** end
The xCommand FarEndControl commands
Move the far end camera (the remote camera). NOTE: The far end camera will move in the specified direction until the stop command (ref: xCommand FarEndControl Camera Stop) is issued
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Value: Select the action for how to move the camera.
Requires user role:
Parameters:
CallId: <0..65534>
Value(r): <Left/Right/Up/Down/ZoomIn/ZoomOut>
Example:
xCommand FarEndControl Camera Move CallId:3 Value:left
*r FECCMoveResult (status=OK):
** end
Stop the far end camera after the xCommand FarEndControl Camera Move has been issued.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role:
Parameters:
CallId: <0..65534>
Example:
xCommand FarEndControl Camera Stop CallId:3
*r FECCMoveResult (status=OK):
** end
Move the far end camera to a camera preset position.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
PresetId: The PresetId for far end control must be retrieved from the far end codec.
Requires user role:
Parameters:
CallId: <0..65534>
PresetId(r): <1..15>
Example:
xCommand FarEndControl Preset Activate CallId:3 PresetId:1
*r FECCPresetActivateResult (status=OK):
** end
Store the far end camera position to a camera preset.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
PresetId: The PresetId for far end control must be retrieved from the far end codec.
Requires user role:
Parameters:
CallId: <0..65534>
PresetId(r): <0..15>
Example:
xCommand FarEndControl Preset Store CallId:3 PresetId:1
*r FECCPresetStoreResult (status=OK):
** end
Select which video input source to use as the main source on the far end system.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
SourceId: Select a video input source on the far end.
Requires user role:
Parameters:
CallId: <0..65534>
SourceId(r): <0..15>
Example:
xCommand FarEndControl Source Select CallId:3 SourceId:1
*r FECCSelectSourceResult (status=OK):
** end
The xCommand GPIO commands
Set the status of a GPIO pin that is configured to OutputManualState mode (ref. xConfiguration GPIO Pin [1..4] Mode).
Requires user role:
Parameters:
Pin1: <High/Low>
Pin2: <High/Low>
Pin3: <High/Low>
Pin4: <High/Low>
Example:
xCommand GPIO ManualState Set Pin1: High
*r GpioStateSetResult (status=OK):
** end
The xCommand HttpFeedback commands
Register the system to a HTTP(S) server to return XML feedback over HTTP(S) to specific URLs.
FeedbackSlot: You can have from 1 to 4 slots for feedback.
ServerUrl: Define the URL for the HTTP(S) server.
Expression[1..15]: What parts of the Status and Configuration XML documents to monitor are specified by XPath expressions. You can have from 1 to 15 XPath expressions.
Requires user role:
Parameters:
FeedbackSlot: <1..4>
ServerUrl(r): <S: 1, 2048>
Expression[1..15]: <S: 1, 255>
Example:
xCommand HttpFeedback Register FeedbackSlot:1 ServerUrl:10.47.19.41 Expression[1]:Status/Video Expression[2]:Status/Audio Expression[3]:Status/Call Expression[4]:Status/Conference
OK
*r FeedbackRegisterResult (status=OK):
FeedbackSlot: 1
** end
Deregister XML feedback over HTTP(S).
Requires user role:
Parameters:
FeedbackSlot(r): <1..4>
Example:
xCommand HttpFeedback Deregister FeedbackSlot:1
OK
*r FeedbackDeregisterResult (status=OK):
FeedbackSlot: 1
** end
The xCommand Key commands
Emulates a remote control key press, followed by a key release.
Requires user role:
Parameters:
Key(r): <0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/Left/Mute/MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/SrcDocCam/SrcPc/SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut>
Example:
xCommand Key Click Key:Down
*r KeyClickResult (status=OK):
** end
Emulates a remote control key press without releasing it. The Key Press command must be followed by a Key Release command to emulate releasing the key.
Requires user role:
Parameters:
Key(r): <0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/Left/Mute/MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/SrcDocCam/SrcPc/SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut>
Example:
xCommand Key Press Key:Home
*r KeyPressResult (status=OK):
** end
Emulates a remote control key reelase. The Key Release command is issued after a Key Press command.
Requires user role:
Parameters:
Key(r): <0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/Left/Mute/MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/SrcDocCam/SrcPc/SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut>
Example:
xCommand Key Release Key:Home
*r KeyReleaseResult (status=OK):
** end
The xCommand Message commands
Display a message on screen, for a specified duration of time (in seconds). NOTE: If Duration is not set, the command must be followed by xCommand Message Alert Clear.
Use the xFeedback commands to monitor the feedback from the user. Read more about the xFeedback commands in the API introduction section in this guide.
Title: Enter a message title.
Text: Enter the message to be displayed.
Duration: Set how long (in seconds) the message is to be displayed on the screen. If set to 0 (zero) the message will not disappear until a xCommand Message Alert Clear message has been sent.
Requires user role:
Parameters:
Title: <S: 0, 255>
Text(r): <S: 0, 255>
Duration: <0..3600>
Example:
xCommand Message Alert Display Title: "Message" Text: "The meeting will end in 5 minutes." Duration: 20
OK
*r MessageAlertDisplayResult (status=OK):
** end
Remove the message which was displayed using the xCommand Message Alert Display command. This is required when the Duration parameter is not set.
Requires user role:
Example:
xCommand Message Alert Clear
OK
*r MessageAlertClearResult (status=OK):
** end
Display a text line on screen. Optionally you can place the text line at a specified location and for a specified duration of time (in seconds). NOTE: If Duration is not set, the command must be followed by xCommand Message TextLine Clear.
Text: Enter the text line to be displayed.
X: Enter the X-coordinate (horizontal) on screen. X=0 is in the upper left corner.
Y: Enter the Y-coordinate (vertical) on screen. Y=0 is in the upper left corner.
Duration: Set how long (in seconds) the text line is to be displayed on the screen. If set to 0 (zero) the text line will be displayed until a xCommand Message TextLine Clear command has been sent.
Requires user role:
Parameters:
Text(r): <S: 0, 140>
X: <1..10000>
Y: <1..10000>
Duration: <0..3600>
Example:
xCommand Message TextLine Display Text: "The message to be displayed." X:500 Y:2000 Duration: 20
OK
*r MessageTextLineDisplayResult (status=OK):
** end
Clears the text line which was defined by the xCommand Message TextLine Display command.
Requires user role:
Example:
xCommand Message TextLine Clear
OK
*r MessageTextLineClearResult (status=OK):
** end
Display a small window on screen with a title, text and up to five options for response from the user. The message will display on screen until the user gives a response, or until the system receives the following command xCommand Message Prompt Clear.
Use the xFeedback commands to monitor the feedback from the user. Read more about the xFeedback commands in the API introduction section in this guide.
Title: Enter the title of the message.
Text: Enter the message.
FeedbackId: To identify the feedback enter a FeedbackId.
Option.1 to Option.5: Enter the text to appear on the feedback options.
Requires user role:
Parameters:
Title: <S: 0, 255>
Text(r): <S: 0, 255>
FeedbackId: <S: 0, 255>
Option.1: <S: 0, 255>
Option.2: <S: 0, 255>
Option.3: <S: 0, 255>
Option.4: <S: 0, 255>
Option.5: <S: 0, 255>
Example:
xCommand Message Prompt Display Title: "Meeting extension" Text: "The meeting is about to end. Do you want to extend the meeting?" Option.1: "No" Option.2: "Yes, extend with 5 minutes" Option.3: "Yes, extend with 10 minutes"
OK
*r MessagePromptDisplayResult (status=OK):
** end
Remove the window displayed using the xCommand Message Alert Display command.
Use the xFeedback commands to monitor the feedback from the user. Read more about the xFeedback commands in the API introduction section in this guide.
FeedbackId: The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt Display command.
Requires user role:
Parameters:
FeedbackId: <S: 0, 255>
Example:
xCommand Message Prompt Clear
OK
*r MessagePromptClearResult (status=OK):
** end
Give a response to the xCommand Message Prompt Display.
Use the xFeedback commands to monitor the feedback from the user. Read more about the xFeedback commands in the API introduction section in this guide.
FeedbackId: The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt Display command.
OptionId: The OptionId corresponds to the OptionIds given as possible responses in the xCommand Message Prompt Display command.
Requires user role:
Parameters:
FeedbackId: <S: 0, 255>
OptionId(r): <1..5>
Example:
xCommand Message Prompt Response OptionId: 1
OK
*r MessagePromptResponseResult (status=OK):
** end
Issuing the command will make the API raise a message-echo event. The command has no other impact on the codec. Usage can be to poll the codec from a control system or any external device/system to check for connectivity. To monitor the feedback use the xFeedback command. You can read more about the xFeedback command in the general API introduction section.
Text: Enter the text to be echoed.
Requires user role:
Parameters:
Text: <S: 0, 255>
Example:
xCommand Message Echo Text:" MyEchoListner99"
*** end
* e Message Echo Text: "MyEchoListner99"
The xCommand Phonebook commands
Add a folder to the local phonebook, where phonebook entries can be stored. Returns the FolderId (localGroupId-3), which is a unique Id of the folder.
Name(r): The name of the folder.
ParentFolderId: A unique identifier for the parent folder, which was created when a previous xCommand Phonebook Folder Add command was issued.
Requires user role:
Parameters:
Name(r): <S: 0, 255>
ParentFolderId: <S: 0, 255>
Example:
xCommand Phonebook Folder Add Name: "New York Office"
OK
*r PhonebookFolderAddResult (status=OK):
Name: localGroupId-3
** end
Modify an existing phonebook folder.
FolderId: A unique identifier for the folder, which was created when the xCommand Phonebook Folder Add command was issued.
Name(r): The name of the contact.
ParentFolderId: A unique identifier for the parent folder, which was created when the xCommand Phonebook Folder Add command was issued.
Requires user role:
Parameters:
FolderId(r): <S: 0, 255>
Name: <S: 0, 255>
ParentFolderId: <S: 0, 255>
Example:
xCommand Phonebook Folder Modify FolderId:localGroupId-3 Name: "New York Head Office"
OK
*r PhonebookFolderModifyResult (status=OK):
** end
Delete an existing folder from the local phonebook.
FolderId: A unique identifier for the folder, which was created when the xCommand Phonebook Folder Add command was issued.
Requires user role:
Parameters:
FolderId(r): <S: 0, 255>
Example:
xCommand Phonebook Folder Delete FolderId:localGroupId-3
OK
*r PhonebookFolderDeleteResult (status=OK):
** end
Add new contact to the local phonebook. Stored internally in the system. Returns the ContactId (Name: localContactId-1), which is a unique Id of the contact.
Name: The name of the contact.
FolderId: A unique identifier for the folder, which was created when the xCommand Phonebook Folder Add command was issued.
ImageURL: The URL to an image.
Title: The title of the contact.
Number: The phone number or address of the contact.
Protocol: Select H323 or SIP protocol.
CallRate: Set a call rate.
Device: Select the device type.
Requires user role:
Parameters:
Name(r): <S: 0, 255>
FolderId: <S: 0, 255>
ImageURL: <S: 0, 255>
Title: <S: 0, 255>
Number: <S: 0, 255>
Protocol: <H323/SIP>
CallRate: <0..65534>
Device: <Mobile/Other/Telephone/Video>
Example:
xCommand Phonebook Contact Add Name: "John Doe" Number:12345
OK
*r PhonebookContactAddResult (status=OK):
Name: localContactId-1
** end
Modify the contact details of an existing contact in the local phonebook.
ContactId: A unique identifier for the contact, which was created when the xCommand Phonebook Contact Add command was issued.
Name: The name of the contact.
FolderId: A unique identifier for the folder, which was created when the xCommand Phonebook Folder Add command was issued.
ImageURL: The URL to an image.
Title: The title of the contact.
Requires user role:
Parameters:
ContactId(r): <S: 0, 255>
Name: <S: 0, 255>
FolderId: <S: 0, 255>
ImageURL: <S: 0, 255>
Title: <S: 0, 255>
Example:
xCommand Phonebook Contact Modify ContactId:localContactId-1 Name: "John Doe - office"
OK
*r PhonebookContactModifyResult (status=OK):
** end
Delete an existing contact from local phonebook.
ContactId: A unique identifier for the contact, which was created when the xCommand Phonebook Contact Add command was issued.
Requires user role:
Parameters:
ContactId(r): <S: 0, 255>
Example:
xCommand Phonebook Contact Delete ContactId:localContactId-1
OK
*r PhonebookContactDeleteResult (status=OK):
** end
Add details about the call setup to an existing contact in the local phonebook. Returns the ContactMethodId (Name: 1), which is a unique Id of the contact method.
ContactId: A unique identifier for the contact, which was created when the xCommand Phonebook Contact Add command was issued.
Device: Set which type of device to call to.
Number(r): The phone number or address of the contact.
Protocol: Select H323 or SIP protocol.
CallRate: Set a call rate.
Requires user role:
Parameters:
ContactId(r): <S: 0, 255>
Device: <Mobile/Other/Telephone/Video>
Number(r): <S: 0, 255>
Protocol: <H323/SIP>
CallRate: <0..65534>
Example:
xCommand Phonebook ContactMethod Add ContactId:localContactId-2 Number:54321 Protocol:H323
OK
*r PhonebookContactMethodAddResult (status=OK):
Name: 1
** end
Delete details about the call setup to an existing contact in the local phonebook.
ContactId: A unique identifier for the contact, which was created when the xCommand Phonebook Contact Add command was issued.
ContactMethodId: A unique identifier for the contact method, which was created when the xCommand Phonebook ContactMethod Add command was issued.
Requires user role:
Parameters:
ContactId(r): <S: 0, 255>
ContactMethodId(r): <S: 0, 255>
Example:
xCommand Phonebook ContactMethod Delete ContactId:localContactId-2 ContactMethodId:1
OK
*r PhonebookContactMethodDeleteResult (status=OK):
** end
The search command lets you search in both the local and corporate phone books. A search will give a ResultSet. More examples can be found on the Developer Zone web page. Go to: http://developer.tandberg.com/web/guest/howtos/cseries-api/phonebook.
PhonebookId: The value of the ID tag for which phonebook server to use. See xConfiguration Phonebook Server. Not necessary to use.
PhonebookType: Which phone book to search in. Either the local phone book or the corporate phonebook.
SearchString: Search for entries containing specified string (not begins with). If no FolderId is specified, the search will yield search results from ALL folders/phonebook directories. The SearchString parameter is optional for software version TC2.0 and later.
SearchField: Currently not in use.
Offset: Get records starting with this offset in a search. Default 0. Used together with Limit to support paging.
FolderId: Search only in the specified folder. FolderId (string) is listed in the ResultSet of a search result containing folders.
Limit: Limit the number of records in the result set to this number. E.g. Limit: 10 will only give a ResultSet of 10 entries (Contacts + Folders) although the total number of hits may be greater.
Recursive: Set if the phonebook should search recursive. The result from an empty search will return both the directories and the content in the directories. NOTE: This command is only valid for the local directory.
Requires user role:
Parameters:
PhonebookId: <S: 0, 255>
PhonebookType: <Corporate/Local>
SearchString: <S: 0, 255>
SearchField: <Name/Number>
Offset: <0..65534>
FolderId: <S: 0, 255>
Limit: <0..65534>
Recursive: <False/True>
Example:
xCommand Phonebook Search PhonebookType:Corporate Limit:2 FolderId:"corporate_001"
OK
*r ResultSet ResultInfo TotalRows: 25
*r ResultSet Contact 1 Name: "/tmp"
*r ResultSet Contact 1 ContactId: "e_9664921"
*r ResultSet Contact 1 ContactMethod 1 ContactMethodId: "1"
*r ResultSet Contact 1 ContactMethod 1 Number: "H323:/John.Doe.Office@company.com"
*r ResultSet Contact 1 ContactMethod 1 Protocol: H323
*r ResultSet Contact 1 ContactMethod 2 ContactMethodId: "2"
*r ResultSet Contact 1 ContactMethod 2 Number: "SIP:/John.Doe.Office@company.com"
*r ResultSet Contact 1 ContactMethod 2 Protocol: SIP
*r ResultSet Contact 2 Name: "Other"
*r ResultSet Contact 2 ContactId: "e_9468400"
*r ResultSet Contact 2 ContactMethod 1 ContactMethodId: "3"
*r ResultSet Contact 2 ContactMethod 1 Number: "H323:John.Doe.Home@company.com"
*r ResultSet Contact 2 ContactMethod 1 Protocol: H323
*r ResultSet Contact 2 ContactMethod 2 ContactMethodId: "4"
*r ResultSet Contact 2 ContactMethod 2 Number: "SIP:John.Doe.Home@company.com"
*r ResultSet Contact 2 ContactMethod 2 Protocol: SIP
** end
The xCommand Presentation commands
Open a media stream from the selected presentation source.
PresentationSource: Select the video input source to be used for presentation.
Requires user role:
Parameters:
PresentationSource: <1..5>
Example:
xCommand Presentation Start PresentationSource:2
OK
*r PresentationStartResult (status=OK):
** end
Stop the media stream from the presentation source.
Requires user role:
Example:
xCommand Presentation Stop
OK
*r PresentationStopResult (status=OK):
** end
The xCommand Preset commands
Store the connector selections for all video input sources and the current camera position for all cameras. Note that all video input sources and all camera positions are included in each preset. The system may hold 15 predefined video input presets.
PresetId: Select preset 1 to 15.
Type: Select Camera or All. Currently there is no difference if you select Camera or All.
Description: Enter a description of the camera preset.
Requires user role:
Parameters:
PresetId(r): <1..15>
Type(r): <All/Camera>
Description: <S: 0, 255>
Example:
xCommand Preset Store PresetId:3 Type:Camera Description:"Left view"
OK
*r PresetStoreResult (status=OK):
** end
Activate one of the local presets.
Requires user role:
Parameters:
PresetId(r): <1..15>
Example:
xCommand Preset Activate PresetId:3
OK
*r PresetActivateResult (status=OK):
** end
Delete an existing preset.
Requires user role:
Parameters:
PresetId(r): <1..15>
Example:
xCommand Preset Clear PresetId:3
OK
*r PresetClearResult (status=OK):
** end
The xCommand Provisioning commands
The codec software can be upgraded from the provisioning server. When starting the upgrade the software is automatically downloaded and installed. A reboot of the codec is required to complete the software upgrade.
AutoComplete On: The software upgrade is automatically completed, with a reboot of the codec.
AutoComplete Off: The software upgrade is not completed, and must be completed by running the xCommand Provisioning CompleteUpgrade command.
Requires user role:
Parameters:
AutoComplete: <On/Off>
Example:
xCommand Provisioning StartUpgrade AutoComplete:On
*r StartUpgradeResult (status=OK):
** end
Completes the software upgrade. This will reboot the codec. NOTE: This command is required if the xCommand Provisioning StartUpgrade has been run with the AutoComplete set to Off.
Requires user role:
Parameters:
None
Example:
xCommand Provisioning CompleteUpgrade
*r CompleteUpgradeResult (status=OK):
** end
Cancel a software update in progress.
Requires user role:
Parameters:
None
Example:
xCommand Provisioning CancelUpgrade
*r CancelUpgradeResult (status=OK):
** end
The xCommand Security commands
Activate FIPS (140-2) mode. NOTE: Activating FIPS mode implies a reset to factory defaults.
While in FIPS mode, software upgrade is disabled and the following limitations will apply: All calls will be encrypted, unencrypted communication protocols like Telnet and HTTP cannot be used. IEEE802.1x and SNMP are disabled. The SIP Profile Type setting cannot be Microsoft. The root user is not available (root settings cannot be changed).
To exit FIPS mode, perform a factory reset.
Confirm: <Yes>
Requires user role:
Parameters:
Confirm(r): <Yes>
Example:
xCommand Security FIPSMode Activate Confirm: "Yes"
OK
*r SecurityFIPSModeActivateConfirmResult (status=OK)
** end
The xCommand SStringSend commands
Send data to the far end, e.g. for control systems. Uses the H.224 data channel (UDP).
Message: Enter the message to be sent to the far end.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role:
Parameters:
Message(r): <S: 0, 255>
CallId: <0..65534>
Example:
xCommand SStringSend CallId:4 Message:"This is a test"
*r SStringSendResult (status=OK):
** end
The xCommand Standby commands
Set the system in standby mode, which will turn off the video outputs and put the camera into sleep mode.
Requires user role:
Example:
xCommand Standby Activate
*r ActivateResult (status=OK):
** end
Bring the system out of standby mode.
Requires user role:
Example:
xCommand Standby Deactivate
*r DeactivateResult (status=OK):
** end
Set a nonpermanent standby delay (in minutes). If the system is in standby mode when the reset timer is set, the system is brought out of standby mode. When left idle for the given delay the system goes into standby mode. Setting the reset timer will not affect the Standby Delay in the Advanced configuration menu (or by xConfiguration Standby Delay). Next time this delay will be the valid standby delay.
Requires user role:
Parameters:
Delay(r): <1..480>
Example:
xCommand Standby ResetTimer Delay:10
*r ResetResult (status=OK):
** end
The xCommand SystemUnit commands
Add an option key to support additional features.
Requires user role:
Parameters:
Key(r): <S: 16, 24>
Example:
xCommand SystemUnit OptionKey Add Key:******************
*r OptionKeyResult (status=OK):
** end
Add the software release key. Used to enable new software (applicable for main software releases).
Requires user role:
Parameters:
Key(r): <S: 16, 24>
Example:
xCommand SystemUnit ReleaseKey Add Key:******************
*r ReleaseKeyResult (status=OK):
** end
Set an administrator password to restrict access the codec. After a restart of the codec this password will also apply to the web interface.
Requires user role:
Parameters:
Password(r): <S: 0, 64>
Example:
xCommand SystemUnit AdminPassword Set Password:***********
*r AdminPasswordSetResult (status=OK):
** end
Set a menu password to restrict access to Administrator Settings menu. If you have a remote control the password can also be set from the on screen menu. If you have a Cisco TelePresence Touch controller the menu password is set from the command line interface.
Requires user role:
Parameters:
Password(r): <S: 0, 255>
Example:
xCommand SystemUnit MenuPassword Set Password:***********
*r MenuPasswordSetResult (status=OK):
** end
Validate that the supplied password is correct.
Requires user role:
Parameters:
Password(r): <S: 0, 255>
Example:
xCommand SystemUnit MenuPassword Validate Password:***********
*r MenuPasswordValidateResult (status=OK):
** end
Set the date and time for the system, if not available from NTP (Network Time Protocol).
Requires user role:
Parameters:
Year: <2008..2037>
Month: <1..12>
Day: <1..31>
Hour: <0..23>
Minute: <0..59>
Second: <0..59>
Example:
xCommand SystemUnit DateTime Set Year:2009 Month:7 Day:3 Hour:12 Minute:0 Second:0
*r DateTimeSetResult (status=OK):
** end
Read the time and date from the system.
Requires user role:
Example:
xCommand SystemUnit DateTime get
*r DateTimeGetResult (status=OK):
Year: 2009
Month: 7
Day: 3
Hour: 12
Minute: 0
Second: 0
** end
Reset the codec to factory default settings, followed by an automatic reboot of the codec.
The call logs will be deleted and all system parameters will be reset to default values. All files that have been uploaded to the codec will be deleted. The Release key and Option key will not be affected.
Requires user role:
Parameters:
Confirm(r): <Yes>
Example:
xCommand SystemUnit FactoryReset Confirm: Yes
*r FactoryResetConfirmResult (status=OK):
** end
Initiate a software upgrade by fetching the software on a given URL. If the server requires username and password these parameters must be included.
Requires user role:
Parameters:
URL(r): <S: 0, 255>
UserName: <S: 0, 255>
Password: <S: 0, 255>
Example:
xCommand xCommand SystemUnit SoftwareUpgrade URL: "ftp://<ftp_server_ip_address>/s52000tc4_0_0.pkg" UserName: testDownload Password: 1234
*r SystemUnitSoftwareUpgradeResult (status=OK):
** end
Select a previously saved configuration profile. Will be active after next system boot.
Requires user role:
Parameters:
Name(r): <S: 0, 255>
Example:
xCommand SystemUnit ConfigurationProfile Change Name: "My_ConfigurationProfile_1"
*r ConfigurationProfileChangeResult (status=OK):
Warning: New configuration profile will be active after next boot.
** end
Delete a configuration profile that has been stored in the system.
Requires user role:
Parameters:
Name(r): <S: 0, 255>
Example:
xCommand SystemUnit ConfigurationProfile Remove Name: "My_ConfigurationProfile_1"
*r ConfigurationProfileRemoveResult (status=OK):
** end
Save the current system settings into a configuration profile. Assign a name to the new profile. The name is the unique identifier of the profile.
Requires user role:
Parameters:
Name(r): <S: 0, 255>
Example:
xCommand SystemUnit ConfigurationProfile SaveCurrentConfigurationAs Name: "My_ConfigurationProfile_1"
*r ConfigurationProfileSaveCurrentConfigurationResult (status=OK):
** end
List configuration profiles that has been stored in the system.
Requires user role:
Example:
xCommand SystemUnit ConfigurationProfile List
*r ConfigurationProfileListResult (status=OK):
Profile: My_ConfigurationProfile_1
Profile: My_ConfigurationProfile_2
** end
Cancel the "ConfigurationProfile Change" command, that would otherwise take effect after next system boot.
Requires user role:
Example:
xCommand SystemUnit ConfigurationProfile CancelChange
*r ConfigurationProfileCancelChangeResult (status=OK):
** end
The xCommand TStringSend commands
Send data to far end, e.g. for Telepresence control systems. Uses the H.245 control channel (TCP). Works with H.323 calls only.
Message: Enter the message to be sent to the far end.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role:
Parameters:
CallId(r): <0..65534>
Message(r): <S: 1, 1450>
Example:
xCommand TStringSend CallId:1 Message:"This is an example"
*r TStringSendResult (status=OK):
** end
The xCommand Video commands
Select the screen layout mode.
Target: Select if the target is the local layout or the remote layout.
CallId: The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
LayoutFamily: Select a layout family.
CustomLayoutName: Enter a name for the layout.
Requires user role:
Parameters:
Target: <Local/Remote>
CallId: <0..65534>
LayoutFamily(r): <Auto/Custom/Equal/Fullscreen/PresentationLargeSpeaker/PresentationSmallSpeaker/Speaker_Full>
CustomLayoutName: <S: 1, 128>
Example:
xCommand Video PictureLayoutSet Target: Local LayoutFamily: Equal
*r SetPictureLayoutResult (status=OK):
** end
Add a new empty video layout composition. Returns the LayoutId. When the command has been issued you can use the result, the LayoutId of the newly created layout, to add frames with different video sources to the layout.
Requires user role:
Parameters:
LayoutId: <1..2147483647>
Example:
xCommand Video Layout Add
OK
*r VideoLayoutAddResult (status=OK):
LayoutId: 1
** end
Remove an existing video layout.
LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued.
Requires user role:
Parameters:
LayoutId(r): <1..2147483647>
Example:
xCommand Video Layout Remove LayoutId: 1
*r VideoLayoutRemoveResult (status=OK):
** end
Remove all existing video layouts.
Requires user role:
Example:
xCommand Video Layout RemoveAll
*r VideoLayoutRemoveAllResult (status=OK):
** end
Reset all layout compositions to factory default.
Requires user role:
Example:
xCommand Video Layout Reset
*r VideoLayoutResetResult (status=OK):
** end
Add a Video frame to an existing layout. Returns the FrameId. Select size and position of the frame, and the video source to be shown in the frame.
LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued.
FrameId: A unique identifier of the frame.
PositionX: The top-left X position of the frame.
PositionY: The top-left Y position of the frame.
Width: The width of the frame.
Height: The height of the frame.
Layer: The stacking order of the frames (1-5). Must be unique per frame per layout. Layer 5 will be on top.
Border: Select whether or not the frame should have a border.
VideoSourceId: A unique identifier of the video source.
If the VideoSourceType is set to RemoteMain the VideoSourceId is the CallId of the remote site.
If the VideoSourceType is set to LocalInput the VideoSourceId is the video input SourceId.
Otherwise set to 1.
VideoSourceType: Select the video source to be used as the content of the frame. The parameter arguments are explained below:
Graphic: Not in use.
LocalInput: Select one of the local input sources.
LocalMain: Select what is currently the main source on the local side.
LocalPresentation: Select what is currently the default presentation source on the local side.
MostSpeaking: Select the current loudest speaker in the conference.
OtherMain: Select another remote site in a call. This involves logic in the codec to ensure that a site does not see itself. You can add several frames with OtherMain. The source and the layout engine will automatically populate the frame content with one of the other sites main video, making sure that you do not see the same site more than once, nor yourself.
OwnMain: Select that each site can see its own selfview.
Presentation: Select what is currently the presentation source (there is always only one active H.239 content in a conference).
RemoteMain: Select the main source of remote site.The CallId must then be specified in the VideoSourceId parameter.
RemotePresentation: Select the presentation source of remote site. The CallId must then be specified in the VideoSourceId parameter.
VideoFile: Not in use.
Requires user role:
Parameters:
LayoutId(r): <1..2147483647>
FrameId: <1..65535>
PositionX(r): <0..10000>
PositionY(r): <0..10000>
Width(r): <1..10000>
Height(r): <1..10000>
Layer(r): <1..5>
Border: <On/Off>
VideoSourceId: <0..2147483647>
VideoSourceType(r): <graphic/localInput/localMain/localPresentation/mostSpeaking/otherMain/ownMain/presentation/remoteMain/remotePresentation/videoFile>
Example:
xCommand Video Layout Frame Add LayoutId:1 PositionX:100 PositionY:100 Width:9800 Height:9800 Layer:1 Border:off VideoSourceType:localInput VideoSourceId:1
OK
*r VideoLayoutFrameAddResult (status=OK):
FrameId: 1
** end
Remove a video frame from an existing layout.
LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued.
FrameId: A unique identifier of the frame, which was created when the xCommand Video Frame Add command was issued.
Requires user role:
Parameters:
LayoutId(r): <1..2147483647>
FrameId(r): <1..65535>
Example:
xCommand Video Layout Frame Remove LayoutId:1 FrameId:1
*r VideoLayoutFrameRemoveResult (status=OK):
** end
Change the details of an existing frame in a video layout.
LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued.
FrameId: A unique identifier of the frame, which was created when the xCommand Video Frame Add command was issued.
PositionX: The top-left X position of the frame.
PositionY: The top-left Y position of the frame.
Width: The width of the frame.
Height: The height of the frame.
Layer: The stacking order of the frames (1-5). Must be unique per frame per layout. Layer 5 will be on top.
Border: Select whether or not the frame should have a border.
VideoSourceId: A unique identifier of the video source.
If the VideoSourceType is set to RemoteMain the VideoSourceId is the CallId of the remote site.
If the VideoSourceType is set to LocalInput the VideoSourceId is the video input SourceId.
Otherwise set to 1.
VideoSourceType: Select the video source to be used as the content of the frame. The parameter arguments are explained below:
Graphic: Not in use.
LocalInput: Select one of the local input sources.
LocalMain: Select what is currently the main source on the local side.
LocalPresentation: Select what is currently the default presentation source on the local side.
MostSpeaking: Select the current loudest speaker in the conference.
OtherMain: Select another remote site in a call. This involves logic in the codec to ensure that a site does not see itself. You can add several frames with OtherMain. The source and the layout engine will automatically populate the frame content with one of the other sites main video, making sure that you do not see the same site more than once, nor yourself.
OwnMain: Select that each site can see its own selfview.
Presentation: Select what is currently the presentation source (there is always only one active H.239 content in a conference).
RemoteMain: Select the main source of remote site.The CallId must then be specified in the VideoSourceId parameter.
RemotePresentation: Select the presentation source of remote site. The CallId must then be specified in the VideoSourceId parameter.
VideoFile: Not in use.
Requires user role:
Parameters:
LayoutId(r): <1..2147483647>
FrameId(r): <1..65535>
PositionX: <0..10000>
PositionY: <0..10000>
Width: <1..10000>
Height: <1..10000>
Layer: <1..5>
Border: <On/Off>
VideoSourceId: <0..2147483647>
VideoSourceType: <graphic/localInput/localMain/localPresentation/mostSpeaking/otherMain/ownMain/presentation/remoteMain/remotePresentation/videoFile>
Example:
xCommand Video Layout Frame Update LayoutId:1 FrameId:1 PositionX:200 PositionY:200 Width:9600 Height:9600 Layer:1 Border:off VideoSourceType:localInput VideoSourceId:1
OK
*r VideoLayoutFrameUpdateResult (status=OK):
** end
Assign an existing layout to any local or remote output. The defined video composition will appear on the specified local output or in the specified remote video stream.
CallId: A unique identifier for the call. The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
OutputId: A unique identifier for the local output, which was created when the xCommand Audio LocalOutput Add command was issued.
LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued.
Requires user role:
Parameters:
CallId(r): <0..65534>
OutputId(r): <0..65534>
LayoutId(r): <1..2147483647>
Example:
xCommand Video Layout Assign CallId:1 OutputId:1 LayoutId:2
OK
*r VideoLayoutAssignResult (status=OK):
** end
Assign an existing layout to a local output. The defined video composition will appear on the specified local output.
LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued.
OutputId: A unique identifier for the local output, which was created when the xCommand Audio LocalOutput Add command was issued.
Requires user role:
Parameters:
LayoutId(r): <1..2147483647>
OutputId(r): <0..65534>
Example:
xCommand Video Layout AssignLocalOutput OutputId:1 LayoutId:2
OK
*r VideoLayoutAssignLocalOutputResult (status=OK):
** end
Assign the call layout (main stream) to the remote output. The defined video composition will appear on the remote main video stream.
LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued.
CallId: A unique identifier for the call. The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role:
Parameters:
LayoutId(r): <1..2147483647>
CallId: <0..65534>
Example:
xCommand Video Layout AssignCall LayoutId:2 CallId:1
OK
*r VideoLayoutAssignCallResult (status=OK):
** end
Assign the presentation layout (dual stream) to the remote output. The defined video composition will appear on the remote dual video stream.
LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout Add command was issued.
Requires user role:
Parameters:
LayoutId(r): <1..2147483647>
Example:
xCommand Video Layout AssignPresentation LayoutId:2
OK
*r VideoLayoutAssignPresentationResult (status=OK):
** end
Remove the defined video layout, and go back to default.
CallId: A unique identifier for the call. The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
OutputId: A unique identifier for the local output, which was created when the xCommand Audio LocalOutput Add command was issued.
Requires user role:
Parameters:
CallId(r): <0..65534>
OutputId(r): <0..65534>
Example:
xCommand Video Layout UnAssign CallId: 1 OutputId: 1
*r VideoLayoutUnassignResult (status=OK):
** end
Remove the defined video layout, and go back to default.
OutputId: A unique identifier for the local output, which was created when the xCommand Audio LocalOutput Add command was issued.
Requires user role:
Parameters:
OutputId(r): <0..65534>
Example:
xCommand Video Layout UnAssignLocalOutput OutputId:1
OK
*r VideoLayoutUnAssignLocalOutputResult (status=OK):
** end
Remove the defined video layout, and go back to default.
CallId: A unique identifier for the call. The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId.
Requires user role:
Parameters:
CallId: <0..65534>
Example:
xCommand Video Layout UnAssignCall CallId:1
OK
*r VideoLayoutUnAssignCallResult (status=OK):
** end
Remove the defined video layout, and go back to default.
Requires user role:
Example:
xCommand Video Layout UnAssignPresentation
OK
*r VideoLayoutUnAssignPresentationResult (status=OK):
** end
Set the presentation view mode.
View: Select Default when you want the presentation to be viewed with the default settings for the codec. Select Maximized when you want the presentation to be displayed in full screen. Select Minimized when you want the presentation to be displayed in a small picture on screen.
Requires user role:
Parameters:
View(r): <Default/Maximized/Minimized>
Example:
xCommand Video Layout SetPresentationView View:Default
OK
*r VideoLayoutSetPresentationViewResult (status=OK):
** end
Loads and starts using the specified video layout database. The default video layout database is initially provided by the system. The custom database is generated by the Cisco TC Console tool and is made available to the codec from within the TC Console tool. The TC Console software is found at the Developer Zone web page. Go to: http://developer.tandberg.com/web/guest/tools/integrators/audio-console.
Custom: The system will use the custom video layout database which generated by the Cisco TC Console tool.
CustomAutoModes: The system will use the auto mode part of the custom video layout database.
Default: The system use the default video layout database which is provided by the system.
Requires user role:
Parameters:
Type(r): <Custom/CustomAutoModes/Default>
Example:
xCommand Video Layout LoadDb Type: Default
*r VideoLayoutLoadDbResult (status=OK):
** end
The xCommand Experimental commands
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Mute the local audio input.
Requires user role:
Parameters:
ConferenceId(r): <0..65534>
Example:
xCommand Experimental Audio LocalInput Mute ConferenceID:1
*r AudioLocalInputMuteResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Unmute the local audio input.
Requires user role:
Parameters:
ConferenceId(r): <0..65534>
Example:
xCommand Experimental Audio LocalInput Unmute ConferenceID:1
*r AudioLocalInputUnmuteResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Mute the remote audio input.
Requires user role:
Parameters:
CallId(r): <0..65534>
Example:
xCommand Experimental Audio RemoteInput Mute CallID:1
*r AudioRemoteInputMuteResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Unmute the remote audio input.
Requires user role:
Parameters:
CallId(r): <0..65534>
Example:
xCommand Experimental Audio RemoteInput Unmute CallID:1
*r AudioRemoteInputUnmuteResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Mute the remote audio output.
Requires user role:
Parameters:
CallId(r): <0..65534>
Example:
xCommand Experimental Audio RemoteOutput Mute CallID:1
*r AudioRemoteOutputMuteResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Unmute the remote audio output.
Requires user role:
Parameters:
CallId(r): <0..65534>
Example:
xCommand Experimental Audio RemoteOutput Unmute CallID:1
*r AudioRemoteOutputUnmuteResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Mute the remote local output.
Requires user role:
Parameters:
ConferenceId(r): <0..65534>
Example:
xCommand Experimental Audio LocalOutput Mute ConferenceID:1
*r AudioLocalOutputMuteResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Unmute the remote local output.
Requires user role:
Parameters:
ConferenceId(r): <0..65534>
Example:
xCommand Experimental Audio LocalOutput Unmute ConferenceID:1
*r AudioLocalOutputUnmuteResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Turn on/off the stereo echo cancellation.
Requires user role:
Parameters:
Mode(r): <On/Off>
Example:
xCommand Experimental Audio StereoEchoCancellation Mode: Off
*r AudioStereoEchoCancellationModeResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Requires user role:
Parameters:
VideoSourceId(r): <0..2147483647>
Show(r): <On/Off>
PositionX(r): <0..10000>
PositionY(r): <0..10000>
Example:
xCommand Experimental VideoIndicator VideoSourceId:0 Show:Off PositionX:0 PositionY:0
*r VideoIndicatorResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Requires user role:
Parameters:
CameraId(r): <1..7>
OnOff(r): <On/Off>
Example:
xCommand Experimental Camera DirectIRControl CameraId:1 OnOff:Off
*r CameraDirectIRControlResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Requires user role:
Parameters:
Mode(r): <On/Off>
Example:
xCommand Experimental SetLowLevel Mode:Off
*r SetLowLevelResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Requires user role:
Parameters:
CallId(r): <0..65534>
Number(r): <S: 0, 255>
Example:
xCommand Experimental Call UnattendedTransfer CallId:321 Number:12345678
*r CallUnattendedTransferlResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Requires user role:
Parameters:
FirstCallId(r): <0..65534>
SecondCallId(r): <0..65534>
Example:
xCommand Experimental Call AttendedTransfer FirstCallId:321 SecondCallId:322
*r CallAttendedTransferlResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Requires user role:
Parameters:
CallId(r): <0..65534>
Device(r): <Mouse/NavKey>
Button(r): <0..65534>
Action: <Click/Click2/Click3/None/Press/Release>
PositionX: <0..10000>
PositionY: <0..10000>
Example:
xCommand Experimental UserInput CallId:0 Device:NavKey Button:0
*r UserInputResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Requires user role:
Parameters:
SourceType: <localInput/localMain/localPresentation>
SourceId: <0..65534>
Example:
xCommand Experimental TakeWebSnapshot
*r TakeWebSnapshotResult (status=OK):
** end
NOTE: This Experimental command can be used 'as is' and will not be further documented. The Experimental settings WILL change.
Requires user role:
Parameters:
Type(r): <A/B>
Example:
xCommand Experimental TouchPanelAdjustment Type:A
*r TouchPanelAdjustmentResult (status=OK):
** end