ConferencePinVideo Method |
Requests for a specific participant's video to be pinned in a certain area of the video image. The source and
destination coordinates can be any point within a video region inside the video image. They do not have to be
a point at the boundary of the video region. In order to undo a previous video pin operation, the application
needs to call
SetVideoLayout(VideoLayoutType, ConferenceConferenceActionCompletionHandler) and specify the
Dynamic layout option.
Namespace:
Avaya.ClientServices
Assembly:
AvayaClientServices (in AvayaClientServices.dll) Version: 550.0.60.0
Syntaxpublic void PinVideo(
float sourceXCoordinate,
float sourceYCoordinate,
float destinationXCoordinate,
float destinationYCoordinate,
ConferenceConferenceActionCompletionHandler completionHandler
)
Parameters
- sourceXCoordinate
- Type: SystemSingle
Horizontal coordinate of the participant's initial video position in the
video image. The float type value in range (0.0, 1.0), with 0.0 referring to the left most side,
and 1.0 to the right most side of the video image. - sourceYCoordinate
- Type: SystemSingle
Vertical coordinate of the participant's initial video position in the video image.
The float type value in range (0.0, 1.0), with 0.0 referring to the top, and 1.0 to the
bottom of the video image. - destinationXCoordinate
- Type: SystemSingle
Horizontal coordinate of the participant's final video position in the
video image. The float type value in range (0.0, 1.0), with 0.0 referring to the left most side,
and 1.0 to the right most side of the video image. - destinationYCoordinate
- Type: SystemSingle
Vertical coordinate of the participant's final video position in the video image.
The float type value in range (0.0, 1.0), with 0.0 referring to the top, and 1.0 to the
bottom of the video image. - completionHandler
- Type: Avaya.ClientServicesConferenceConferenceActionCompletionHandler
The completion handler for this operation. Operation
success or failure is reported through this handler.
ExceptionsException | Condition |
---|
ArgumentOutOfRangeException | Thrown if either of the coordinates is outside of the allowed range (0.0, 1.0). |
See Also