Video Commands - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec
Contents Introduction

Video commands

xCommand Video PictureLayoutSet
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: USER
Parameters:
Target: <local/remote>
CallId: <0..65534>
LayoutFamily(r): <auto/custom/equal/fullscreen/overlay/presentationlargespeaker/
presentationsmallspeaker/prominent/single/speaker_full>
CustomLayoutName: <S: 1, 128>
Example:
xCommand Video PictureLayoutSet Target: Local LayoutFamily: equal
*r SetPictureLayoutResult (status=OK):
** end
xCommand Video Layout SetPresentationView
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: ADMIN
Parameters:
View(r): <Default/Maximized/Minimized>
Example:
xCommand Video Layout SetPresentationView View:Default
OK
*r VideoLayoutSetPresentationViewResult (status=OK):
** end
SX20 Codec API Reference Guide TC7.0, JANUARY 2014.
D14949.08
About the API xConfiguration
xCommand Video OSD Close
xCommand Video PIP ActiveSpeaker Set
115
xCommand xCommand
Closes all menus on the on-screen display.
Element: The on–screen menu.
Requires user role: ADMIN
Parameters:
Element(r): <Menu>
Example:
xCommand Video OSD Close Element: Menu
*r OsdCloseElementResult (status=OK):
** end
Sets position for the active speakers PiP (picture in picture).
Position: Predefined positions.
CenterLeft: The ActiveSpeaker PiP appears on the left side of the screen, in center.
CenterRight: The ActiveSpeaker PiP appears on the right side of the screen, in center.
LowerLeft: The ActiveSpeaker PiP appears in the lower left corner of the screen.
LowerRight: The ActiveSpeaker PiP appears in the lower right corner of the screen.
UpperCenter: The ActiveSpeaker PiP appears on top of the screen, in center.
UpperLeft: The ActiveSpeaker PiP appears in the upper left corner of the screen.
UpperRight: The ActiveSpeaker PiP appears in the upper right corner of the screen.
Requires user role: ADMIN
Parameters:
Position(r): <CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight>
Example:
xCommand Video PIP ActiveSpeaker Set Position: UpperRight
*r ActiveSpeakerPipSetResult (status=OK):
** end
API Reference Guide
xStatus Appendices
Copyright © 2014 Cisco Systems, Inc. All rights reserved.