Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
Conference Class
Conference Methods
AddParticipant Method
AddParticipantFromCall Method
AddParticipantToCallCapability Method
AddTerminal Method
EndConference Method
ExtendMeeting Method
GetAddParticipantFromCallCapability Method
GetRecordingDescription Method
GetRecordingName Method
LowerHand Method
MuteAllParticipants Method
PauseRecording Method
PinVideo Method
RaiseHand Method
RemoveLastParticipant Method
RemoveParticipant Method
RequestToBecomeModerator Method
ResumeRecording Method
RetrieveDialInInformation Method
SendPasscode Method
SendRequestToEnterLockedConference Method
SetContinuationActive Method
SetDisplayVideoParticipantName Method
SetEntryExitToneActive Method
SetLectureModeActive Method
SetLocked Method
SetMultiplePresentersAllowed Method
SetVideoAllowed Method
SetVideoLayout Method
SetVideoSelfSee Method
SignIn Method
StartRecording Method
StopRecording Method
UnmuteAllParticipants Method

Conference PinVideo 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, Conference
ConferenceActionCompletionHandler) and specify the Dynamic layout option.

Namespace: Avaya.ClientServices
Assembly: AvayaClientServices (in AvayaClientServices.dll) Version: 592.1.30.0
Syntax
C#
Copy

    public void PinVideo(
    	float sourceXCoordinate,
    	float sourceYCoordinate,
    	float destinationXCoordinate,
    	float destinationYCoordinate,
    	ConferenceConferenceActionCompletionHandler completionHandler
    )

#### Parameters

sourceXCoordinate
  Type: System
  Single
  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: System
  Single
  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: System
  Single
  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: System
  Single
  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.ClientServices
  Conference
  ConferenceActionCompletionHandler
  The completion handler for this operation. Operation success or failure is reported through this handler.

Exceptions

Exception | Condition
--- | ---
ArgumentOutOfRangeException | Thrown if either of the coordinates is outside of the allowed range (0.0, 1.0).

See Also

#### Reference

Conference Class
Avaya.ClientServices Namespace
Conference
VideoPinCapability

© 2017 Avaya LLC. All Rights Reserved.