Avaya Client Services API Reference (OS X)

- Main Page
- Classes
- Files
- Related Pages

- Class List
- Class Index
- Class Hierarchy
- Class Members

Instance Methods | List of all members
<CSConferenceDelegate> Protocol Reference

CSConferenceDelegate is registered as an observer of conference status update notifications. More...

`#import <CSConference.h>`

Inherits <NSObjectNSObject>.

## Instance Methods
(void) | - conferenceWaitingToStart:
| Sent to report that the conference has not started, and the local user is waiting for the conference to start. More...
(void) | - conferenceDidStart:
| Sent when the conference has started. More...
(void) | - conferenceCapabilitiesDidChange:
| Sent when the capabilities of the conference have changed. More...
(void) | - conferenceRecordingDidFail:
| Sent when the conference recording has failed. More...
(void) | - conference:didChangeSubject:
| Sent when the conference subject has changed. More...
(void) | - conference:didChangeBrandName:
| Sent when the conference brand name has changed. More...
(void) | - conference:didChangeLockStatus:
| Sent when the lock status of the conference has changed as a result of a local or remote operation. More...
(void) | - conference:didChangeLectureModeStatus:
| Sent when the lecture mode status of the conference has changed as a result of a local or remote operation. More...
(void) | - conference:didChangeEntryExitToneStatus:
| Sent when the entry/exit tone status of the conference has changed as a result of a local or remote operation. More...
(void) | - conference:didChangeContinuationStatus:
| Sent when the continuation status of the conference has changed as a result of a local or remote operation. More...
(void) | - conference:didChangeRecordingStatus:
| Sent when the recording status of the conference has changed as a result of a local or remote operation. More...
(void) | - conference:didChangeEncryptionStatus:
| Sent when the overall media encryption status of the conference has changed based on the encryption status of current participants on the call. More...
(void) | - conference:didChangeStreamingStatus:
| Sent when the overall streaming status of the conference has changed based on the streaming status of current conference the call. More...
(void) | - conference:didChangeMeetingEndTime:
| Sent when the automatic end time of the conference call has changed. More...
(void) | - conference:didChangeVideoStatus:
| Sent when video is allowed or disallowed for the conference as a result of a local or remote operation. More...
(void) | - conference:didChangeVideoSelfSeeStatus:
| Sent when the option to display self-see video in video image has changed. More...
(void) | - conference:didChangeDisplayParticipantNameOnVideo:
| Sent when the option to display video participant name on video image has changed. More...
(void) | - conference:didChangeAlwaysDisplayActiveSpeakerVideo:
| Sent when the option to always display the active speaker's video has changed. More...
(void) | - conference:didChangeVideoLayout:
| Sent when the current video layout setting has been changed by the conference server. More...
(void) | - conference:didChangeSupportedVideoLayouts:
| Sent when the list of video layouts supported by the conference server for the current call has changed. More...
(void) | - conferenceHandRaised:
| Sent when local user's hand is raised (due to local hand raise operation) More...
(void) | - conferenceHandLowered:
| Sent when local user's hand has been lowered. More...
(void) | - conference:didRequirePasscode:
| Sent when the user needs to provide admission passcode before (s)he can be admitted to the conference call. More...
(void) | - conferenceDidRequirePermissionToEnter:
| Sent to report that the user is trying to join a locked conference call that does not require a passcode for entry. More...
(void) | - conferenceServiceDidBecomeAvailable:
| Sent to report that the conference has a healthy signaling path. More...
(void) | - conference:serviceDidBecomeUnavailable:
| Sent to report that the conference does not have a healthy signaling path. More...
(void) | - conference:participantsDidChange:changedParticipants:
| Sent to report that the list of conference participants has changed. More...
(void) | - conference:droppedParticipantsDidChange:changedParticipants:
| Sent to report that the list of participants that have dropped from the conference has changed. More...
(void) | - conference:pendingParticipantsDidChange:changedParticipants:
| Sent to report that the list of pending conference participants has changed. More...
(void) | - conference:activeTalkersDidChange:changedParticipants:
| Sent to report that the list of active talkers in the conference has changed. More...
(void) | - conference:recentTalkersDidChange:changedParticipants:
| Sent to report that the list of active talkers in the conference has changed. More...
(void) | - conference:didChangeExternalAdmissionStatus:
| Sent when the external admission status for the current conference call has changed. More...
(void) | - conference:videoChannelReceiveStatusDidChange:receiveStatus:
| Sent during a multi video channel conference call when a video channel's receive status changes, e.g., when the server starts or stops sending video packets over a video channel represented by the videoChannel argument. More...
(void) | - conference:didActiveVideoParticipantChange:
| Sent to report during a multi video channel conference call that the active video participant received over a video channel has changed. More...
(void) | - conference:didChangeEventConferenceStatus:
| Sent when conference type has changed. More...

## Detailed Description

CSConferenceDelegate is registered as an observer of conference status update notifications.

The client application is notified about status updates reported by the conference server through the CSConferenceDelegate object. These updates may be the result of local operations on the CSConference object as well as remote changes initiated by either the server or other users on the conference call. For example if the local user is a conference moderator, (s)he may call startRecordingWithCompletionHandler: (CSConference), resulting in the delegate conference:didChangeRecordingStatus: (CSConferenceDelegate-p) being invoked. Similarly, a remote conference moderator may start conference recording, which will result in receipt of a network notification, invoking the same delegate.

It should be noted that the set of notifications depends on the capabilities of the conference server. In some conference server environments, some of the delegates may never be invoked because the server does not support the underlying services/features that result in those notifications.

See also
  CSConference

## Method Documentation

- (void) conference: |  | (CSConference *) | conference
activeTalkersDidChange: |  | (CSDataCollectionChangeType) | changeType
changedParticipants: |  | (NSArray *) | changedParticipants
| optional

Sent to report that the list of active talkers in the conference has changed.

Parameters

  conference | The conference sending the message.
  changeType | The type of change that has occurred to the participant list.
  changedParticipants | An array of CSActiveParticipant objects that have changed. For a delete change, the supplied objects have been removed from the list. For a "collection cleared" change, this array will be empty.

See also
  CSConference::activeTalkers

- (void) conference: |  | (CSConference *) | conference
didActiveVideoParticipantChange: |  | (CSActiveParticipant *) | participant
| optional

Sent to report during a multi video channel conference call that the active video participant received over a video channel has changed.

The video channel id information is provided in participant argument. This information can be used to render the display name of the video participant in the video rendering area associated with the specified video channel.

Parameters

  conference | The conference sending the message.
  participant | Participant whose video is received over specified video channel identified by CSActiveParticipant::videoChannelId:.

See also
  CSActiveParticipant::videoChannelId

- (void) conference: |  | (CSConference *) | conference
didChangeAlwaysDisplayActiveSpeakerVideo: |  | (BOOL) | active

Sent when the option to always display the active speaker's video has changed.

Parameters

  conference | The conference sending the message.
  active | `YES` if the option to always display the active speaker's video is active, `NO` if it is not active.

See also
  CSConference::activeSpeakerVideoAlwaysDisplayed

- (void) conference: |  | (CSConference *) | conference
didChangeBrandName: |  | (NSString *) | brandName

Sent when the conference brand name has changed.

Parameters

  conference | The conference sending the message.
  brandName | The new brand name of the conference.

- (void) conference: |  | (CSConference *) | conference
didChangeContinuationStatus: |  | (BOOL) | active

Sent when the continuation status of the conference has changed as a result of a local or remote operation.

Parameters

  conference | The conference sending the message.
  active | `YES` if continuation is active, `NO` if it is inactive.

See also
  CSConference::continuationActive
  - setContinuationActive:completionHandler: (CSConference)

- (void) conference: |  | (CSConference *) | conference
didChangeDisplayParticipantNameOnVideo: |  | (BOOL) | active

Sent when the option to display video participant name on video image has changed.

Parameters

  conference | The conference sending the message.
  active | `YES` if the option to display video participant name on video image is active, `NO` if it is not active.

See also
  CSConference::participantNameDisplayActive
  - setDisplayVideoParticipantNameActive:completionHandler: (CSConference)

- (void) conference: |  | (CSConference *) | conference
didChangeEncryptionStatus: |  | (CSConferenceEncryptionStatus) | status

Sent when the overall media encryption status of the conference has changed based on the encryption status of current participants on the call.

Parameters

  conference | The conference sending the message.
  status | New media encryption status.

See also
  CSConference::encryptionStatus

- (void) conference: |  | (CSConference *) | conference
didChangeEntryExitToneStatus: |  | (BOOL) | active

Sent when the entry/exit tone status of the conference has changed as a result of a local or remote operation.

Parameters

  conference | The conference sending the message.
  active | `YES` if lecture mode is active, `NO` if it is inactive.

See also
  CSConference::entryExitToneActive
  - setEntryExitToneActive:completionHandler: (CSConference)

- (void) conference: |  | (CSConference *) | conference
didChangeEventConferenceStatus: |  | (BOOL) | eventConferenceStatus
| optional

Sent when conference type has changed.

Event conference is a large meeting (up to 2000 active participants) which is mainly used for large events and training.

Parameters

  conference | The conference sending the message.
  eventConferenceStatus | True if conference type changed to Event type. False - changed to Regular.

- (void) conference: |  | (CSConference *) | conference
didChangeExternalAdmissionStatus: |  | (BOOL) | required
| optional

Sent when the external admission status for the current conference call has changed.

Parameters

  conference | The conference sending the message.
  required | Current conference's external admission status.

- (void) conference: |  | (CSConference *) | conference
didChangeLectureModeStatus: |  | (BOOL) | active

Sent when the lecture mode status of the conference has changed as a result of a local or remote operation.

Parameters

  conference | The conference sending the message.
  active | `YES` if lecture mode is active, `NO` if it is inactive.

See also
  CSConference::lectureModeActive
  - setLectureModeActive:completionHandler: (CSConference)

- (void) conference: |  | (CSConference *) | conference
didChangeLockStatus: |  | (BOOL) | locked

Sent when the lock status of the conference has changed as a result of a local or remote operation.

Parameters

  conference | The conference sending the message.
  locked | The new lock status.

See also
  CSConference::locked
  - setLocked:completionHandler: (CSConference)

- (void) conference: |  | (CSConference *) | conference
didChangeMeetingEndTime: |  | (NSDate *) | meetingEndTime

Sent when the automatic end time of the conference call has changed.

Parameters

  conference | The conference sending the message.
  meetingEndTime | End time of the conference call.

See also
  - extendMeeting:completionHandler: (CSConference)

- (void) conference: |  | (CSConference *) | conference
didChangeRecordingStatus: |  | (CSConferenceRecordingStatus) | status

Sent when the recording status of the conference has changed as a result of a local or remote operation.

Parameters

  conference | The conference sending the message.
  status | New conference recording status.

See also
  CSConference::recordingActive
  CSConference::recordingPaused
  - startRecordingWithCompletionHandler: (CSConference)
  - stopRecordingWithCompletionHandler: (CSConference)
  - pauseRecordingWithCompletionHandler: (CSConference)
  - resumeRecordingWithCompletionHandler: (CSConference)

- (void) conference: |  | (CSConference *) | conference
didChangeStreamingStatus: |  | (CSConferenceStreamingStatus) | status

Sent when the overall streaming status of the conference has changed based on the streaming status of current conference the call.

Parameters

  conference | The conference sending the message.
  status | New streaming status.

See also
  CSConference::streamingStatus

- (void) conference: |  | (CSConference *) | conference
didChangeSubject: |  | (NSString *) | subject

Sent when the conference subject has changed.

Parameters

  conference | The conference sending the message.
  subject | The new subject of the conference.

- (void) conference: |  | (CSConference *) | conference
didChangeSupportedVideoLayouts: |  | (NSArray *) | layouts

Sent when the list of video layouts supported by the conference server for the current call has changed.

Parameters

  conference | The conference sending the message.
  layouts | List of supported video layouts.

See also
  CSConference::supportedVideoLayouts

- (void) conference: |  | (CSConference *) | conference
didChangeVideoLayout: |  | (CSVideoLayout) | layout

Sent when the current video layout setting has been changed by the conference server.

Parameters

  conference | The conference sending the message.
  layout | Current video layout.

See also
  CSConference::videoLayout
  - setVideoLayout:completionHandler: (CSConference)

- (void) conference: |  | (CSConference *) | conference
didChangeVideoSelfSeeStatus: |  | (BOOL) | active

Sent when the option to display self-see video in video image has changed.

Parameters

  conference | The conference sending the message.
  active | `YES` if the self-see video option is active, `NO` if it is not active.

See also
  CSConference::videoSelfSeeActive
  - setVideoSelfSeeActive:completionHandler: (CSConference)

- (void) conference: |  | (CSConference *) | conference
didChangeVideoStatus: |  | (BOOL) | allowed

Sent when video is allowed or disallowed for the conference as a result of a local or remote operation.

Parameters

  conference | The conference sending the message.
  allowed | `YES` if video is allowed, `NO` if it is disallowed.

See also
  CSConference::videoAllowed
  - setVideoAllowed:completionHandler: (CSConference)

- (void) conference: |  | (CSConference *) | conference
didRequirePasscode: |  | (BOOL) | permissionToEnterLockedConferenceRequired

Sent when the user needs to provide admission passcode before (s)he can be admitted to the conference call.

Upon receiving this event, the client application should prompt user for the conference admission passcode. If user chooses to enter the conference room, the client application needs to call sendPasscode:completionHandler: (CSConference), after collecting the passcode from the end user. If user chooses not to enter the conference room, the client application needs to end (CSCall): to end the connection to the conference call.

Parameters

  conference | The conference sending the message.
  permissionToEnterLockedConferenceRequired | `YES` if the conference room is locked and passcode is required to get in. @ NO if the conference room is not locked, but passcode is required to get in.

- (void) conference: |  | (CSConference *) | conference
droppedParticipantsDidChange: |  | (CSDataCollectionChangeType) | changeType
changedParticipants: |  | (NSArray *) | changedParticipants
| optional

Sent to report that the list of participants that have dropped from the conference has changed.

Parameters

  conference | The conference sending the message.
  changeType | The type of change that has occurred to the participant list.
  changedParticipants | An array of CSDroppedParticipant objects that have changed. For a delete change, the supplied objects have been removed from the list. For a "collection cleared" change, this array will be empty.

See also
  CSConference::droppedParticipants

- (void) conference: |  | (CSConference *) | conference
participantsDidChange: |  | (CSDataCollectionChangeType) | changeType
changedParticipants: |  | (NSArray *) | changedParticipants
| optional

Sent to report that the list of conference participants has changed.

Parameters

  conference | The conference sending the message.
  changeType | The type of change that has occurred to the participant list.
  changedParticipants | An array of CSActiveParticipant objects that have changed. For a delete change, the supplied objects have been removed from the list. For a "collection cleared" change, this array will be empty.

See also
  CSConference::participants

- (void) conference: |  | (CSConference *) | conference
pendingParticipantsDidChange: |  | (CSDataCollectionChangeType) | changeType
changedParticipants: |  | (NSArray *) | changedParticipants
| optional

Sent to report that the list of pending conference participants has changed.

Parameters

  conference | The conference sending the message.
  changeType | The type of change that has occurred to the participant list.
  changedParticipants | An array of CSPendingParticipant objects that have changed. For a delete change, the supplied objects have been removed from the list. For a "collection cleared" change, this array will be empty.

See also
  CSConference::pendingParticipants

- (void) conference: |  | (CSConference *) | conference
recentTalkersDidChange: |  | (CSDataCollectionChangeType) | changeType
changedParticipants: |  | (NSArray *) | changedParticipants
| optional

Sent to report that the list of active talkers in the conference has changed.

Parameters

  conference | The conference sending the message.
  changeType | The type of change that has occurred to the participant list.
  changedParticipants | An array of CSActiveParticipant objects that have changed. For a delete change, the supplied objects have been removed from the list. For a "collection cleared" change, this array will be empty.

See also
  CSConference::recentTalkers

- (void) conference: |  | (CSConference *) | conference
serviceDidBecomeUnavailable: |  | (NSError *) | error

Sent to report that the conference does not have a healthy signaling path.

Depending on the network topology, the call session and the conference controls may share the same signaling connection (e.g., SIP and tunnel CCMP), or may use different connections. This is why separate service available/unavailable callback is provided for the CSConference object.

Parameters

  conference | The conference sending the message.
  error | code describing why the conference service became unavailable.

- (void) conference: |  | (CSConference *) | conference
videoChannelReceiveStatusDidChange: |  | (CSVideoChannel *) | videoChannel
receiveStatus: |  | (BOOL) | receiving
| optional

Sent during a multi video channel conference call when a video channel's receive status changes, e.g., when the server starts or stops sending video packets over a video channel represented by the videoChannel argument.

Server may stop sending video, when, for example, the number of video participants falls below a certain number, no long requiring a negotiated video channel. It is recommended that the video renderer associated with the video channel remain allocated, as the number of video participants on the call may increase, resulting in video transmission by the server over the video channel.

Parameters

  conference | The conference sending the message.
  videoChannel | Video channel whose video receive status has changed.
  receiving | `YES` if video channel has started receiving video packets, `NO` the channel has stopped receiving video packets.

- (void) conferenceCapabilitiesDidChange: |  | (CSConference *) | conference |

Sent when the capabilities of the conference have changed.

The listener can query the CSConference object to find out about the capability that changed. Usually, the capabilities changed notification is tied to the features supported by the conference server as well as the local user's role (e.g., moderator, presenter, lecturer, etc.) for the conference call.

Parameters

  conference | The conference sending the message.

- (void) conferenceDidRequirePermissionToEnter: |  | (CSConference *) | conference |

Sent to report that the user is trying to join a locked conference call that does not require a passcode for entry.

If the user chooses to request permission from the moderator to enter the call, the application should call sendRequestToEnterLockedConferenceWithCompletionHandler: (CSConference). If the user chooses not to request permission, the application should end (CSCall): to end the connection to the conference call. It should be noted that a locked conference call may also require admission passcode. In this case, CSConference:conference:didRequirePasscode: is called with permissionToEnterLockedConferenceRequired set to YES.

Parameters

  conference | The conference sending the message.

- (void) conferenceDidStart: |  | (CSConference *) | conference |

Sent when the conference has started.

Called only when conferenceWaitingToStart: is previously called.

Parameters

  conference | The conference sending the message.

- (void) conferenceHandLowered: |  | (CSConference *) | conference |

Sent when local user's hand has been lowered.

This can occur when either the conference moderator or the local user lowers the hand.

Parameters

  conference | The conference sending the message.

See also
  CSConference::handRaised
  - raiseHandWithCompletionHandler: (CSConference)
  - lowerHandWithCompletionHandler: (CSConference)

- (void) conferenceHandRaised: |  | (CSConference *) | conference |

Sent when local user's hand is raised (due to local hand raise operation)

Parameters

  conference | The conference sending the message.

See also
  CSConference::handRaised
  - raiseHandWithCompletionHandler: (CSConference)
  - lowerHandWithCompletionHandler: (CSConference)

- (void) conferenceRecordingDidFail: |  | (CSConference *) | conference |

Sent when the conference recording has failed.

Parameters

  conference | The conference sending the message.

- (void) conferenceServiceDidBecomeAvailable: |  | (CSConference *) | conference |

Sent to report that the conference has a healthy signaling path.

Depending on the network topology, the call session and the conference controls may share the same signaling connection (e.g., SIP and tunnel CCMP), or may use different connections. This is why separate service available/unavailable callback is provided for the CSConference object.

Parameters

  conference | The conference sending the message.

- (void) conferenceWaitingToStart: |  | (CSConference *) | conference |

Sent to report that the conference has not started, and the local user is waiting for the conference to start.

At this point, the conference server may provide wait treatment to the end user, e.g., by playing music and/or displaying a still video image. This information is reported based on an indication received from the conference server and may not be provided depending on the server's capabilities.

Parameters

  conference | The conference sending the message.

The documentation for this protocol was generated from the following file:

- CSConference.h