Xcommand Video Layout Frame Add; Xcommand Video Layout Remove; Xcommand Video Layout Removeall; Xcommand Video Layout Reset - Cisco TelePresence System Codec C90 Reference Manual

Cisco TelePresence System Codec C90
Contents Introduction

xCommand Video Layout Remove

Remove 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: USER
Parameters:
LayoutId(r): <1..2147483647>
Example:
xCommand Video Layout Remove LayoutId: 1
*r VideoLayoutRemoveResult (status=OK):
** end

xCommand Video Layout RemoveAll

Remove all existing video layouts.
Requires user role: USER
Example:
xCommand Video Layout RemoveAll
*r VideoLayoutRemoveAllResult (status=OK):
** end

xCommand Video Layout Reset

Reset all layout compositions to factory default.
USER
Requires user role:
Example:
xCommand Video Layout Reset
*r VideoLayoutResetResult (status=OK):
** end
D14641.06 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved.
About the API xConfiguration

xCommand Video Layout Frame Add

104
xCommand xCommand
Add a Video frame to an existing layout. Returns the FrameId. Select size and position of the frame,
and the video source to be shown in the frame.
LayoutId: A unique identifier for the layout, which was created when the xCommand Video Layout
Add command was issued.
FrameId: A unique identifier of the frame.
PositionX: The top-left X position of the frame.
PositionY: The top-left Y position of the frame.
Width: The width of the frame.
Height: The height of the frame.
Layer: The stacking order of the frames (1-5). Must be unique per frame per layout. Layer 5 will be on
top.
Border: Select whether or not the frame should have a border.
VideoSourceId: A unique identifier of the video source.
If the VideoSourceType is set to RemoteMain the VideoSourceId is the CallId of the remote site.
If the VideoSourceType is set to LocalInput the VideoSourceId is the video input SourceId.
Otherwise set to 1.
VideoSourceType: Select the video source to be used as the content of the frame. The parameter
arguments are explained below:
Graphic: Not in use.
LocalInput: Select one of the local input sources.
LocalMain: Select what is currently the main source on the local side.
LocalPresentation: Select what is currently the default presentation source on the local side.
MostSpeaking: Select the current loudest speaker in the conference.
OtherMain: Select another remote site in a call. This involves logic in the codec to ensure that a site
does not see itself. You can add several frames with OtherMain. The source and the layout engine will
automatically populate the frame content with one of the other sites main video, making sure that you
do not see the same site more than once, nor yourself.
OwnMain: Select that each site can see its own selfview.
Presentation: Select what is currently the presentation source (there is always only one active H.239
content in a conference).
RemoteMain: Select the main source of remote site.The CallId must then be specified in the
VideoSourceId parameter.
RemotePresentation: Select the presentation source of remote site. The CallId must then be
specified in the VideoSourceId parameter.
VideoFile: Not in use.
Requires user role: ADMIN
Parameters:
LayoutId(r): <1..2147483647>
FrameId: <1..65535>
PositionX(r): <0..10000>
PositionY(r): <0..10000>
Width(r): <1..10000>
API Reference Guide
xStatus Appendices
www.cisco.com