Xcommand Audio Localoutput Add; Xcommand Audio Localoutput Addconnector - Cisco TelePresence SX80 Reference Manual

Cisco TelePresence SX80

Introduction

xCommand Audio LocalOutput Add

Create a virtual local output, and generate an identifier for it (OutputId). A local output is a mix of
local inputs and the remote input signals. Use the xCommand Audio LocalOutput ConnectInput
command to specify which local inputs to include; the remote input signal (from far-end) is
automatically added to all local outputs when in a call. A local output is associated with a set of
output connectors, which all receive the same signal.
The maximum number of local output modules is 6. You get an error message if you exceed the
limit.
This command is mainly intended for internal use by the CE Console. If you don't use CE
Console, you need to manually add the command in a startup script in order to make the defini-
tion persistent over a reboot.
Requires user role: ADMIN
USAGE:
xCommand Audio LocalOutput Add [OutputId: OutputId] [Name: "Name"] [Loudspeaker:
Loudspeaker] [Channels: Channels] [VolumeControlled: VolumeControlled]
where
: Integer (0..65534)
OutputId
A unique identifier for the local output. If you don't specify an OutputID, the system will
automatically create one for you. We recommend that you specify the OutputId yourself
in case you need to refer to the output module at a later stage.
: String (0, 255)
Name
Choose a name that describes the local output.
: On/Off
Loudspeaker
On: Choose On if at least one of the associated connectors are connected to a
loudspeaker. This is important because it tells the echo canceler to use this signal as a
reference signal.
Off: Choose Off if no loudspeaker is connected to the associated connectors.
Note that only one of the local outputs should have a loudspeaker connected.
: Integer (1..2)
Channels
1: Mix the local and remote input signals into a mono signal.
2: Mix the local and remote input signals into a stereo signal.
: On/Off)
VolumeControlled
On: The volume will change according to the level set with the volume controls on the
user interface, or with the xCommand Audio Volume commands.
Cisco TelePresence SX80 API Reference Guide CE9.1, JUNE 2017.
D15317.07
About the API xConfiguration xCommand xCommand
Off: The volume is neither influenced by the volume controls on the user interface, nor
the xCommand Audio Volume commands.

xCommand Audio LocalOutput AddConnector

Attach an output connector to the local output given by the output ID. You have to specify
both the connector's type and number (ConnectorType, ConnectorId) to uniquely identify the
connector. A connector can only be attached to one local output.
Run xStatus Audio Output LocalOutput to get an overview of all local outputs.
This command is mainly intended for internal use by the CE Console. If you don't use CE
Console, you need to manually add the command in a startup script in order to make the defini-
tion persistent over a reboot.
Requires user role: ADMIN
USAGE:
xCommand Audio LocalOutput AddConnector OutputId:
ConnectorType ConnectorId: ConnectorId
where
: Integer (0..65534)
OutputId
The unique identifier of the local output. It was generated when the local output was
created with the xCommand Audio LocalOutput Add command.
: HDMI/Line
ConnectorType
Select the connector type.
: Integer (1..2) for an HDMI connector; Integer (1..6) for a Line connector
ConnectorId
Select a connector. The connectors are numbered from left to right on the codec
connector panel (as seen from rear).
105
API Reference Guide
xStatus Appendices
OutputId ConnectorType:
Copyright © 2017 Cisco Systems, Inc. All rights reserved.