Xcommand Userinterface Presentation Externalsource Remove; Xcommand Userinterface Presentation Externalsource Removeall; Xcommand Userinterface Presentation Externalsource Select; Xcommand Userinterface Presentation Externalsource State Set - Cisco TelePresence SX80 Reference Manual

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

Advertisement

Cisco TelePresence SX80
Introduction

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
: String (0, 40)
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
: String (0, 40)
SourceIdentifier
The unique string that identifies this input source. It was defined when the source was
created with the UserInterface Presentation ExternalSource Add command.
Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017.
D15317.07
About the API
xConfiguration
xCommand
xCommand

xCommand UserInterface Presentation ExternalSource State Set

Set or change the state of the input source (specified by the SourceIdentifier).
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL
USAGE:
xCommand UserInterface Presentation ExternalSource State Set SourceIdentifier:
"SourceIdentifier" State:
State
where
: String (0, 40)
SourceIdentifier
The unique string that identifies this input source. It was defined when the source was
created with the UserInterface Presentation ExternalSource Add command.
: Hidden/Ready/NotReady/Error
State
Ready: The input source will be presented when someone selects it (taps it on the user
interface, or when the UserInterface Presentation ExternalSource Select command is
issued).
NotReady: The input source is not ready, and cannot be selected.
Error: The input source is in an erroneous state. The ErrorReason parameter may be
used to inform the user about the reason for failure.
Hidden: The input source will not be displayed in the user interface sharetray.
: String (0, 80)
ErrorReason
This string is displayed in the user interface sharetray, given that the State parameter is
set to Error.
149
API Reference Guide
xStatus
Appendices
[ErrorReason: "ErrorReason"]
Copyright © 2017 Cisco Systems, Inc. All rights reserved.

Hide quick links:

Advertisement

Table of Contents
loading

Table of Contents