Cisco TelePresence SX20 Codec Reference Manual page 75

Application programming interface (api)
Hide thumbs Also See for TelePresence SX20 Codec:
Table of Contents

Advertisement

Cisco TelePresence SX20 Codec
Contents
Introduction
xConfiguration Video Layout Scaling
Define how the system shall adjust the aspect ratio for images or frames when there is a difference
between the image and the frame it is to be placed in.
Requires user role: ADMIN
Value space: <Off/On>
Off: No adjustment of the aspect ratio.
On: Let the system automatically adjust aspect ratio.
Example: xConfiguration Video Layout Scaling: On
xConfiguration Video Layout ScaleToFrame
Define what to do if the aspect ratio of a video input source doesn't match the aspect ratio of the
corresponding image frame in a composition. For example if you have a 4:3 input source (like XGA)
to be displayed on a 16:9 output (like HD720).
Requires user role: ADMIN
Value space: <Manual/MaintainAspectRatio/StretchToFit>
Manual: If the difference in aspect ratio between the video input source and the target image
frame is less than the Video Layout ScaleToFrameThreshold setting (in percent), the image is
stretched to fit. If not, the system will maintain the original aspect ratio.
MaintainAspectRatio: Maintain the aspect ratio of the input source, and fill in black in the rest of the
frame (letter boxing or pillar boxing).
StretchToFit: Stretch (horizontally or vertically) the input source to fit into the image frame. NOTE:
The general limitation is that you cannot upscale in one direction and at the same time downscale
in the other direction. In such situations the codec will apply letterboxing.
Example: xConfiguration Video Layout ScaleToFrame: MaintainAspectRatio
xConfiguration Video Layout ScaleToFrameThreshold
Only applicable if the Video Layout ScaleToFrame setting is set to manual. If the difference
in aspect ratio between the video input source and the target image frame is less than the
ScaleToFrameThreshold setting (in percent), the image is stretched to fit. If not, the system will
maintain the original aspect ratio.
Requires user role: ADMIN
Value space: <0..100>
Range: Select a value between 0 and 100 percent.
Example: xConfiguration Video Layout ScaleToFrameThreshold: 5
SX20 Codec API Reference Guide TC7.3, OCTOBER 2015.
D14949.13
About the API
xConfiguration
xConfiguration
xConfiguration Video PIP ActiveSpeaker DefaultValue Position
xConfiguration Video PIP Presentation DefaultValue Position
75
xCommand
Determine the position on screen of the active speaker picture-in-picture (PiP). The setting only
takes effect when using a video layout where the active speaker is a PiP, i.e. the Overlay layout, or
possibly a Custom layout (see the Video Layout LocalLayoutFamily setting). The setting takes effect
from the next call onwards; if changed during a call, it will have no effect on the current call.
Requires user role: ADMIN
Value space: <Current/UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/LowerLeft/
LowerRight>
Current: The position of the active speaker PiP will be kept unchanged when leaving a call.
UpperLeft: The active speaker PiP will appear in the upper left corner of the screen.
UpperCenter: The active speaker PiP will appear in the upper center position.
UpperRight: The active speaker PiP will appear in the upper right corner of the screen.
CenterLeft: The active speaker PiP will appear in the center left position.
CentreRight: The active speaker PiP will appear in the center right position.
LowerLeft: The active speaker PiP will appear in the lower left corner of the screen.
LowerRight: The active speaker PiP will appear in the lower right corner of the screen.
Example: xConfiguration Video PIP ActiveSpeaker DefaultValue Position: Current
Determine the position on screen of the presentation picture-in-picture (PiP). The setting only takes
effect when the presentation is explicitly minimized to a PiP, for example using the remote control or
the Touch controller. The setting takes effect from the next call onwards; if changed during a call, it
will have no effect on the current call.
Requires user role: ADMIN
Value space: <Current/UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/LowerLeft/
LowerRight>
Current: The position of the presentation PiP will be kept unchanged when leaving a call.
UpperLeft: The presentation PiP will appear in the upper left corner of the screen.
UpperCenter: The presentation PiP will appear in the upper center position.
UpperRight: The presentation PiP will appear in the upper right corner of the screen.
CenterLeft: The presentation PiP will appear in the center left position.
CentreRight: The presentation PiP will appear in the center right position.
LowerLeft: The presentation PiP will appear in the lower left corner of the screen.
LowerRight: The presentation PiP will appear in the lower right corner of the screen.
Example: xConfiguration Video PIP Presentation DefaultValue Position: Current
API Reference Guide
xStatus
Appendices
Copyright © 2015 Cisco Systems, Inc. All rights reserved.

Hide quick links:

Advertisement

Table of Contents
loading

Table of Contents