TANDBERG Codec C Series Api Manual page 85

TANDBERG Codec C60 and Codec C40
Contents Contents Introduction Introduction
The Video commands,
cont...
xCommand Video Layout Frame Add
NOTE: This command is not supported on Codec C40.
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.
D14642.02—MAY 2010
About the API About the API xConfiguration xConfiguration
xCommand
xCommand xCommand xStatus xStatus
The Video commands,
cont...
Parameters:
LayoutId(r): <1..2147483647>
FrameId: <1..65535>
PositionX(r): <0..10000>
PositionY(r): <0..10000>
Width(r): <1..10000>
Height(r): <1..10000>
Layer(r): <1..5>
Border: <On/Off>
VideoSourceId: <0..256>
VideoSourceType(r): <Graphic/LocalInput/LocalMain/LocalPresentation/MostSpeaking/OtherMain/
OwnMain/Presentation/RemoteMain/RemotePresentation/VideoFile>
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.
Parameters:
LayoutId(r): <1..2147483647>
FrameId(r): <1..65535>
Example:
xCommand Video Layout Frame Remove LayoutId:1 FrameId:1
*r VideoLayoutFrameRemoveResult (status=OK):
** end
85
API Guide
Appendices Appendices Contact us Contact us
www.tandberg.com