D15333.07 Cisco TelePresence SX10 API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. 122
Cisco TelePresence SX10
API Reference Guide
xCommand UserInterface Presentation ExternalSource Add
Establish and set up an input source that is connected to the video system via an external
switch.
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL
USAGE:
xCommand UserInterface Presentation ExternalSource Add ConnectorId: ConnectorId
SourceIdentifier: "SourceIdentifier" Name: "Name" Type: Type
where
ConnectorId
: Integer (2..3)
The ID of the video system connector that the external switch is connected to.
SourceIdentifier
: String (0, 40)
A unique string that identifies the input source. The identifier is used by other
commands and events when addressing this specific input source.
Name
: String (0, 40)
The name of the input source. This name will be displayed on the user interface.
Type
: camera/desktop/document_camera/mediaplayer/PC/whiteboard/other
The type of input source. The type determines which icon to display on the user
interface.
xCommand UserInterface Presentation ExternalSource List
Returns the current list of external input sources.
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL
USAGE:
xCommand UserInterface Presentation ExternalSource List
xCommand UserInterface Presentation ExternalSource Remove
Remove the input source (specified by the SourceIdentifier) from the list of external input
sources.
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL
USAGE:
xCommand UserInterface Presentation ExternalSource Remove SourceIdentifier:
"SourceIdentifier"
where
SourceIdentifier
: String (0, 40)
The unique string that identifies this input source. It was defined when the source was
created with the UserInterface Presentation ExternalSource Add command.
xCommand UserInterface Presentation ExternalSource RemoveAll
Remove all input sources from the list of external input sources.
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL
USAGE:
xCommand UserInterface Presentation ExternalSource RemoveAll
xCommand UserInterface Presentation ExternalSource Select
Starts to present the input source (specified by the SourceIdentifier) if it is in Ready state (see
the UserInterface Presentation ExternalSource State Set command). The input source will be
shown in the user interface sharetray as "Presenting".
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL, USER
USAGE:
xCommand UserInterface Presentation ExternalSource Select SourceIdentifier:
"SourceIdentifier"
where
SourceIdentifier
: String (0, 40)
The unique string that identifies this input source. It was defined when the source was
created with the UserInterface Presentation ExternalSource Add command.