Xcommand Userinterface Presentation Externalsource Add; Xcommand Userinterface Presentation Externalsource List; Xcommand Userinterface Presentation Externalsource Remove; Xcommand Userinterface Presentation Externalsource Removeall - Cisco TelePresence SX20 Codec Reference Manual

Application programming interface (api)
Hide thumbs Also See for TelePresence SX20 Codec:
Table of Contents

Advertisement

Cisco TelePresence SX20 Codec
Introduction

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:
SourceIdentifier: "SourceIdentifier" Name: "Name" Type:
where
: Integer (1..3)
ConnectorId
The ID of the video system connector that the external switch is connected to.
: String (0, 40)
SourceIdentifier
A unique string that identifies the input source. The identifier is used by other
commands and events when addressing this specific input source.
: String (0, 40)
Name
The name of the input source. This name will be displayed on the user interface.
: camera/desktop/document_camera/mediaplayer/PC/whiteboard/other
Type
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
SX20 Codec API Reference Guide CE9.1, JUNE 2017.
D15316.07
About the API
xConfiguration
Type
xCommand
xCommand

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:
ConnectorId
xCommand UserInterface Presentation ExternalSource Remove SourceIdentifier:
"SourceIdentifier"
where
SourceIdentifier
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
The unique string that identifies this input source. It was defined when the source was
created with the UserInterface Presentation ExternalSource Add command.
127
xStatus
: String (0, 40)
: String (0, 40)
Copyright © 2017 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices

Advertisement

Table of Contents
loading

Table of Contents