Video Commands - Cisco TelePresence System Codec C40 Reference Manual

Cisco TelePresence System Codec C40/C60
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 Add
NOTE: This command is not supported on Codec C40.
Add a new empty video layout composition. Returns the LayoutId. When the command has been
issued you can use the result, the LayoutId of the newly created layout, to add frames with different
video sources to the layout.
Requires user role: ADMIN
Parameters:
LayoutId: <1..2147483647>
Example:
xCommand Video Layout Add
OK
*r VideoLayoutAddResult (status=OK):
LayoutId: 1
** end
D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014.
About the API xConfiguration
xCommand Video Layout Remove
xCommand Video Layout RemoveAll
xCommand Video Layout Reset
131
xCommand xCommand
NOTE: This command is not supported on Codec C40.
Removes an existing video layout.
LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout
Add command was issued.
Requires user role: ADMIN
Parameters:
LayoutId(r): <1..2147483647>
Example:
xCommand Video Layout Remove LayoutId: 1
*r VideoLayoutRemoveResult (status=OK):
** end
NOTE: This command is not supported on Codec C40.
Removes all the existing video layouts.
Requires user role: ADMIN
Example:
xCommand Video Layout RemoveAll
*r VideoLayoutRemoveAllResult (status=OK):
** end
NOTE: This command is not supported on Codec C40.
Resets all the layout compositions to factory default.
Requires user role: ADMIN
Example:
xCommand Video Layout Reset
*r VideoLayoutResetResult (status=OK):
** end
API Reference Guide
xStatus Appendices
Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.