Technical References

D14642.13 Codec C40-C60 API Reference Guide TC6.3, NOVEMBER 2013. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. 134
Cisco TelePresence System Codec C40/C60 API Reference Guide
Requires user role: ADMIN
Parameters:
LayoutId(r): <1..2147483647>
FrameId: <1..65535>
PositionX(o): <0..10000>
PositionY(o): <0..10000>
Width(o): <1..10000>
Height(o): <1..10000>
Layer(0): <1..5>
Border: <On/Off>
VideoSourceType(o): <graphic/localInput/localMain/localPresentation/mostSpeaking/
mostSpeaking_orderedByPartNumb/otherMain/otherMainRemote/ownMain/participantNumber/
presentation/remoteMain/remotePresentation/videoFile>
VideoSourceId: <0..2147483647>
Example:
xCommand Video Layout Frame Add LayoutId:1 PositionX:100 PositionY:100
Width:9800 Height:9800 Layer:1 Border:off VideoSourceType:localInput
VideoSourceId:1
OK
*r VideoLayoutFrameAddResult (status=OK):
FrameId: 1
** end
xCommand Video Layout Frame Remove
NOTE: This command is not supported on Codec C40.
Remove a video frame from an existing layout.
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, which was created when the xCommand Video Frame Add
command was issued.
Requires user role: ADMIN
Parameters:
LayoutId(r): <1..2147483647>
FrameId(r): <1..65535>
Example:
xCommand Video Layout Frame Remove LayoutId:1 FrameId:1
*r VideoLayoutFrameRemoveResult (status=OK):
** end
xCommand Video Layout Frame Update
NOTE: This command is not supported on Codec C40.
Change the details of an existing frame in a video layout.
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, which was created when the xCommand Video Frame Add
command was issued.
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 is on
top.
Border: Select whether or not the frame should have a border.
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 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
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.
otherMainRemote: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 otherMainRemote. The source and
the layout engine automatically populate the frame content with one of the other remote 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 self-view.
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.
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.
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand