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 Methods

The Conference type exposes the following members.

Methods

| Name | Description
--- | --- | ---
| AddParticipant | Add a participant to a call. If the method is called on a 2-party call, the call is escalated to a conference call. This call change is reported via a ConferenceStatusChanged event on the Call object associated with this Conference. If the method is called on a conference call, the participant is added to the conference call using bridge-assisted dial-out. This method may be called multiple times to add multiple participants to the conference call.
| AddParticipantFromCall | If the method is called on a 2-party call, the two calls are merged together to create a conference call. This call status change is reported via a ConferenceStatusChanged event on the Call object associated with this conference. If the method is called on a conference call, the input argument call is transferred over to the conference call represented by this object. If the user wants to create a conference call by merging multiple existing calls, this method can be called multiple times to join multiple calls into the conference.
| AddParticipantToCallCapability | Returns whether the local user can request the conference server to add a participant to current call. The capability returns not supported if the call is a remote agent phone call or if the local user does not have permission to initiate it.
| AddTerminal | Add a terminal to a conference call by terminal IP address. The terminal is added using bridge-assisted dial-out. The method may be called multiple times to add multiple terminals to the conference call.
| EndConference | Ends the conference call for all conference participants.
| ExtendMeeting | Extends the current meeting end time by the specified number of minutes.
| GetAddParticipantFromCallCapability | Returns whether the local user can request the conference server to add a participant from a specified call to current call, for example, to add a new user to the conference call. The capability returns not supported if the conference call does not support the merge feature, or if the local user does not have permission to initiate it.
| GetRecordingDescription | Get meeting recording description.
| GetRecordingName | Get meeting recording name.
| LowerHand | Called to lower the local user's hand on the conference call to indicate that the user no longer wants to get the moderator's attention.
| MuteAllParticipants | Used by a conference moderator to mute all participants on the conference call. Other moderators, lecturers and presenters are not affected by this operation.
| PauseRecording | Pauses conference recording.
| PinVideo | 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.
| RaiseHand | Called to raise the local user's hand on the conference call to get the moderator's attention, who can unmute and hence allow the participant to speak.
| RemoveLastParticipant | Removes the last participant that was added to a conference call either locally or remotely.
| RemoveParticipant | Initiates removal of the selected participant from the conference call.
| RequestToBecomeModerator | Issues a request to promote the local user to become a conference moderator.
| ResumeRecording | Resumes conference recording.
| RetrieveDialInInformation | Retrieves the dial in information for the conference call.
| SendPasscode | Request for admission to enter a conference call that is passcode-protected.
| SendRequestToEnterLockedConference | Request for permission to enter a locked conference call.
| SetContinuationActive | Enables or disables conference continuation mode for the conference call. Call continuation mode allows the conference call to continue after the moderator leaves the conference call.
| SetDisplayVideoParticipantName | Controls whether participant names are displayed in the personal video layout received from the conference server.
| SetEntryExitToneActive | Controls whether entry and exit tones are allowed for the conference call.
| SetLectureModeActive | Enables or disables lecture mode for the conference call. The result of the operation is reported through the completionHandler argument.
| SetLocked | Locks or unlocks the conference call. If the call is not a conference call or the conference call is not locked, an error indication is returned through the completionHandler argument.
| SetMultiplePresentersAllowed | Controls whether there can be multiple presenters (panelists) on the call.
| SetVideoAllowed | Controls whether video is allowed on the conference call.
| SetVideoLayout | Sets the local user's personal video layout preference.
| SetVideoSelfSee | Controls the display of the local user's video in the personal video layout received from the conference server.
| SignIn | Sign in to become a named user in the conference.
| StartRecording(Conference ConferenceActionCompletionHandler) | Starts conference recording.
| StartRecording(Conference ConferenceActionCompletionHandler, String, String) | Starts conference recording.
| StopRecording | Stops conference recording.
| UnmuteAllParticipants | Used by a conference moderator to unmute all participants on the conference call.

Top
See Also

#### Reference

Conference Class
Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.