Video SDK for iOS API Reference
|
A listener class that groups together the callbacks related to a session. More...
#include <ZoomVideoSDKDelegate.h>
Inherits <NSObject>.
Instance Methods | |
(void) | - onSessionJoin |
Callback: Invoked when the current user joins the session. | |
(void) | - onSessionLeave |
Callback: Invoked when the current user leaves the session. | |
(void) | - onSessionLeave: |
Invoked when the current user leaves the session with reason. | |
(void) | - onError:detail: |
Callback: Invoked when errors occur. | |
(void) | - onUserJoin:users: |
Callback: Invoked when a user joins the session. | |
(void) | - onUserLeave:users: |
Callback: Invoked when a user leaves the session. | |
(void) | - onUserVideoStatusChanged:user: |
Invoked when a user makes changes to their video, such as starting or stopping their video. | |
(void) | - onUserAudioStatusChanged:user: |
Callback: Invoked when a user makes changes to their audio, such as muting or unmuting their audio. | |
(void) | - onUserShareStatusChanged:user:shareAction: |
Invoked when a user makes changes to their sharing status, such as starting screen sharing, starting view sharing, or stopping sharing. | |
(void) | - onFailedToStartShare:user: |
Invoked when a user failed to start sharing. | |
(void) | - onLiveStreamStatusChanged:status: |
Callback: Invoked when a user makes changes to their live stream status. | |
(void) | - onChatPrivilegeChanged:privilege: |
The chat privilege of participant has changed. | |
(void) | - onChatNewMessageNotify:message: |
Callback: Invoked when receiving a chat message. | |
(void) | - onChatMsgDeleteNotification:messageID:deleteBy: |
Callback: Invoked when a user deletes a chat message. | |
(void) | - onUserHostChanged:users: |
Callback: Invoked when the session host changes. | |
(void) | - onUserManagerChanged: |
Callback: Invoked when the manager of the session changes. | |
(void) | - onUserNameChanged: |
Callback: Invoked when a user changes their name. | |
(void) | - onUserActiveAudioChanged:users: |
Callback: Invoked when the active audio changes. | |
(void) | - onSessionNeedPassword: |
Callback: Invoked when the session requires a password to join. | |
(void) | - onSessionPasswordWrong: |
Callback: Invoked when the provided session password is wrong or invalid. | |
(void) | - onMixedAudioRawDataReceived: |
Callback: Invoked when mixed (all users) audio raw data received. | |
(void) | - onOneWayAudioRawDataReceived:user: |
Callback: Invoked when individual user's audio raw data received. | |
(void) | - onSharedAudioRawDataReceived: |
Callback: Invoked when receiving shared raw audio data. | |
(void) | - onInviteByPhoneStatus:failReason: |
Callback: Invoked when the invite by phone status changes to any other valid status such as Calling, Ringing, Success, or Failed. | |
(void) | - onCalloutJoinSuccess:phoneNumber: |
Callback: Invoked when the invite by phone user joined session success. | |
(void) | - onCmdChannelConnectResult: |
Callback: Invoked when the command channel is ready to be used. When the SDK attempts to establish a connection for the command channel when joining a session, this callback is triggered once the connection attempt for the command channel is completed. | |
(void) | - onCommandReceived:sendUser: |
Callback: Invoked when receiving a message, data, or a command from the command channel. Once the command channel is active, this callback is triggered each time a message is received. | |
(void) | - onCameraControlRequestResult:approved: |
Callback for when the current user is granted camera control access. | |
(void) | - onCloudRecordingStatus:recordAgreementHandler: |
Callback: Invoked when cloud recording status has started, paused, stopped, resumed, or otherwise changed. | |
(void) | - onUserRecordAgreementNotification: |
Callback: user agreement status change. | |
(void) | - onHostAskUnmute |
Callback: Invoked when a host requests you to unmute yourself. | |
(void) | - onMultiCameraStreamStatusChanged:parentUser:videoPipe: |
Callback: Invoked when someone in a given session enables or disables multi-camera. All participants in the session receive this callback. | |
(void) | - onMultiCameraStreamStatusChanged:parentUser:videoCanvas: |
Callback: Invoked when someone enables/disables multi-camera. This callback is received by all participants. | |
(void) | - onTestMicStatusChanged: |
Callback: Notify the mic status when testing. | |
(void) | - onMicSpeakerVolumeChanged:speakerVolume: |
Callback: Notify the current mic or speaker volume when testing. | |
(void) | - onSystemPermissionRequired: |
Callback: Invoked when the SDK requires system permissions to continue functioning. | |
(void) | - onLiveTranscriptionStatus: |
Callback: Invoked when live transcription status changes. | |
(void) | - onLiveTranscriptionMsgReceived: |
Callback: when a live transcription message is received. | |
(void) | - onOriginalLanguageMsgReceived: |
Callback: Original language message received callback. | |
(void) | - onLiveTranscriptionMsgError:transLanguage: |
Callback: Invoked when a live translation error occurs. | |
(void) | - onProxySettingNotification: |
The callback will be triggered if the proxy requests to input the username and password.Use the handler to configure the related information. For more details, see ZoomVideoSDKProxySettingHandler . | |
(void) | - onSSLCertVerifiedFailNotification: |
The callback will be triggered when the SSL is verified.Use the handler to check the related information. For more details, see ZoomVideoSDKSSLCertVerificationHandler . | |
(void) | - onUserVideoNetworkStatusChanged:user: |
Callback event of the user's video network quality changes. | |
(void) | - onCallCRCDeviceStatusChanged: |
Callback event of the call CRC device's status. | |
(void) | - onAnnotationHelperCleanUp: |
Callback for the annotation helper clean up. After this callback, SDK will release the ZoomVideoSDKAnnotationHelper as well. | |
(void) | - onAnnotationPrivilegeChange:shareOwner: |
Callback for the annotation privilege change. | |
(void) | - onAnnotationPrivilegeChangeWithUser:shareAction: |
Callback for the annotation privilege change. | |
(void) | - onShareContentChanged:user:shareAction: |
Callback: Invoked when a user makes changes to their share content type, such as switching camera share to normal share. Find the share type in ZoomVideoSDKShareType . | |
(void) | - onVideoCanvasSubscribeFail:user:view: |
Callback event for the subscribed user's video fail reason. | |
(void) | - onShareCanvasSubscribeFail:user:view: |
Callback event for the subscribed user's share fail reason. | |
(void) | - onShareCanvasSubscribeFailWithUser:view:shareAction: |
Callback event for the share canvas that failed to subscribe. | |
(void) | - onSendFileStatus:status: |
Invoked when send file status make change. | |
(void) | - onReceiveFileStatus:status: |
Invoked when send file status make change. | |
(void) | - onVideoAlphaChannelStatusChanged: |
Callback event of video alpha channel mode changes. | |
(void) | - onSpotlightVideoChanged:userList: |
Callback event of spotlighted video user changes. | |
(void) | - onBindIncomingLiveStreamResponse:success:streamKeyID: |
Callback event of binds the incoming live stream. | |
(void) | - onUnbindIncomingLiveStreamResponse:success:streamKeyID: |
Callback event of unbinds the incoming live stream. | |
(void) | - onIncomingLiveStreamStatusResponse:success:streamsStatusList: |
Callback event of gets the streams status. | |
(void) | - onStartIncomingLiveStreamResponse:success:streamKeyID: |
Callback event of starts the binded stream. | |
(void) | - onStopIncomingLiveStreamResponse:success:streamKeyID: |
Callback event of stops the binded stream. | |
(void) | - onShareContentSizeChanged:user:shareAction: |
Invoked when the share content size has changed. | |
(void) | - onUVCCameraStatusChange: |
Callback is invoked when the external UVC camera status changes. | |
A listener class that groups together the callbacks related to a session.
Definition at line 35 of file ZoomVideoSDKDelegate.h.
|
optionalrequired |
Callback for the annotation helper clean up. After this callback, SDK will release the ZoomVideoSDKAnnotationHelper as well.
helper | The helper clean up object. |
|
optionalrequired |
Callback for the annotation privilege change.
enable | YES means the user is able to annotate, NO means the user is not able to annotate. |
user | The user who changed viewer's annotation privilege |
|
optionalrequired |
Callback for the annotation privilege change.
user | The pointer to a user object who changed viewer's annotation privilege. For more details, refer to ZoomVideoSDKUser . |
shareAction | The pointer to a share object. For more details, refer to ZoomVideoSDKShareAction . |
|
optionalrequired |
Callback event of binds the incoming live stream.
helper | Incoming live stream helper utility. |
success | YES is success, otherwise NO. |
streamKeyID | Corresponding stream key ID. |
|
optionalrequired |
Callback event of the call CRC device's status.
state | The call out status. |
|
optionalrequired |
Callback: Invoked when the invite by phone user joined session success.
user | success joined user, See [ZoomVideoSDKUser]. |
phoneNumber | phone number of callout. |
|
optionalrequired |
Callback for when the current user is granted camera control access.
user | The pointer to the user who received the request. |
isApproved | The result of the camera control request. |
|
optionalrequired |
Callback: Invoked when a user deletes a chat message.
helper | Chat helper utility. |
msgID | The deleted message's ID. |
type | Indicates by whom the message was deleted, which is defined in [ZoomVideoSDKChatMsgDeleteBy]. |
|
optionalrequired |
Callback: Invoked when receiving a chat message.
helper | Chat helper utility. |
chatMessage | the object which contains the message content. See [ZoomVideoSDKChatMessage]. |
|
optionalrequired |
The chat privilege of participant has changed.
helper | Chat helper utility. |
currentPrivilege | The new chat privilege. See [ZoomVideoSDKChatPrivilegeType]. |
|
optionalrequired |
Callback: Invoked when cloud recording status has started, paused, stopped, resumed, or otherwise changed.
status | Cloud recording status defined in [ZoomVideoSDKRecordingStatus]. |
handler | could handle the action user Accept or Decline; |
|
optionalrequired |
Callback: Invoked when the command channel is ready to be used. When the SDK attempts to establish a connection for the command channel when joining a session, this callback is triggered once the connection attempt for the command channel is completed.
success | YES,command channel is ready to be used. NO, Failure, command channel was unable to connect. |
|
optionalrequired |
Callback: Invoked when receiving a message, data, or a command from the command channel. Once the command channel is active, this callback is triggered each time a message is received.
commandContent | Received command. |
sendUser | The user who sent the command. |
|
optionalrequired |
Callback: Invoked when errors occur.
ErrorType | Provides error code associated with the error. See [ZoomVideoSDKError] for more information. |
details | The detail of error message. |
|
optionalrequired |
Invoked when a user failed to start sharing.
helper | The pointer to a share helper object, |
user | The pointer to a user object. |
|
optionalrequired |
Callback: Invoked when a host requests you to unmute yourself.
|
optionalrequired |
Callback event of gets the streams status.
helper | Incoming live stream helper utility. |
success | YES is success, otherwise NO. |
streamsStatusList | The streams status list. |
|
optionalrequired |
Callback: Invoked when the invite by phone status changes to any other valid status such as Calling, Ringing, Success, or Failed.
status | Invite by phone status. See [ZoomVideoSDKPhoneStatus]. |
failReason | Invite by phone failed reason. See [ZoomVideoSDKPhoneFailedReason]. |
|
optionalrequired |
Callback: Invoked when a user makes changes to their live stream status.
helper | Live stream helper utility. |
status | Live stream status in enumeration. See [ZoomVideoSDKLiveStreamStatus]. |
|
optionalrequired |
Callback: Invoked when a live translation error occurs.
spokenLanguage | The spoken message language. |
transcriptLanguage | The message language you want to translate. |
|
optionalrequired |
Callback: when a live transcription message is received.
messageInfo | The live transcription message |
|
optionalrequired |
Callback: Invoked when live transcription status changes.
status | The live transcription status. See [ZoomVideoSDKLiveTranscriptionStatus]. |
|
optionalrequired |
Callback: Notify the current mic or speaker volume when testing.
micVolume | Specify the volume of the mic when testing or in session. |
speakerVolume | Specify the volume of the speaker when testing. |
|
optionalrequired |
Callback: Invoked when mixed (all users) audio raw data received.
rawData | Audio raw data. see [ZoomVideoSDKAudioRawData]. |
|
optionalrequired |
Callback: Invoked when someone enables/disables multi-camera. This callback is received by all participants.
status | Status for multipul camera user join or left. See [ZoomVideoSDKMultiCameraStreamStatus]. |
user | The user who enabled multi-camera. See [ZoomVideoSDKUser]. |
videoCanvas | the video canvas for the multi-camera. See [ZoomVideoSDKVideoCanvas]. |
|
optionalrequired |
Callback: Invoked when someone in a given session enables or disables multi-camera. All participants in the session receive this callback.
status | Status for multipul camera user join or left. See [ZoomVideoSDKMultiCameraStreamStatus]. |
user | The user who enabled multi-camera. See [ZoomVideoSDKUser]. |
videoPipe | the data pipe for the multi-camera. See [ZoomVideoSDKRawDataPipe]. |
|
optionalrequired |
Callback: Invoked when individual user's audio raw data received.
rawData | Raw audio data. see [ZoomVideoSDKAudioRawData]. |
user | See [ZoomVideoSDKUser]. |
|
optionalrequired |
Callback: Original language message received callback.
messageInfo | messageInfo The spoken language message, refer to ZoomVideoSDKLiveTranscriptionMessageInfo . |
|
optionalrequired |
The callback will be triggered if the proxy requests to input the username and password.Use the handler to configure the related information. For more details, see ZoomVideoSDKProxySettingHandler
.
handler | The handler will be destroyed once the function calls end. |
|
optionalrequired |
Invoked when send file status make change.
file | The class to receive file object. |
status | The stauts of file transfer. |
|
optionalrequired |
Invoked when send file status make change.
file | The class to sendfile object. |
status | The stauts of file transfer. |
|
optional |
Callback: Invoked when the current user joins the session.
|
optionalrequired |
Callback: Invoked when the current user leaves the session.
|
optionalrequired |
Invoked when the current user leaves the session with reason.
reason | Leave session reason. See [ZoomVideoSDKSessionLeaveReason] for more information. |
|
optionalrequired |
Callback: Invoked when the session requires a password to join.
completion | the block for this callback. |
|
optionalrequired |
Callback: Invoked when the provided session password is wrong or invalid.
completion | the block for this callback. |
|
optionalrequired |
Callback event for the subscribed user's share fail reason.
failReason | The fail reason. For more details, see ZoomVideoSDKSubscribeFailReason . |
user | The pointer to the user whose view we would like to subscribe. For more details, refer to ZoomVideoSDKUser . |
view | The view that failed to subscribe. |
|
optionalrequired |
Callback event for the share canvas that failed to subscribe.
user | The pointer to the user object whose view we would like to subscribe to. For more details, refer to ZoomVideoSDKUser . |
view | The view that failed to subscribe. |
shareAction | The pointer to a share object. For more details, refer to ZoomVideoSDKShareAction . |
|
optionalrequired |
Callback: Invoked when a user makes changes to their share content type, such as switching camera share to normal share. Find the share type in ZoomVideoSDKShareType
.
shareHelper | share helper util |
userInfo | current start or stop share userInfo. |
shareAction | ZoomVideoSDKShareAction |
|
optionalrequired |
Invoked when the share content size has changed.
helper | The pointer to a share helper object, see ZoomVideoSDKShareHelper . |
user | The pointer to a user object who's share content size has changed, see ZoomVideoSDKUser . |
shareAction | The pointer to the ZoomVideoSDKShareAction object. For more details, refer to ZoomVideoSDKShareAction . |
|
optionalrequired |
Callback: Invoked when receiving shared raw audio data.
rawData | rawData Raw audio data. See [ZoomVideoSDKAudioRawData]. |
|
optionalrequired |
Callback event of spotlighted video user changes.
videoHelper | The pointer of video helper object. |
userList | List of users who has been spotlighted. |
|
optionalrequired |
The callback will be triggered when the SSL is verified.Use the handler to check the related information. For more details, see ZoomVideoSDKSSLCertVerificationHandler
.
handler | The handler will be destroyed once the function calls end. |
|
optionalrequired |
Callback event of starts the binded stream.
helper | Incoming live stream helper utility. |
success | YES is success, otherwise NO. |
streamKeyID | Corresponding stream key ID. |
|
optionalrequired |
Callback event of stops the binded stream.
helper | Incoming live stream helper utility. |
success | YES is success, otherwise NO. |
streamKeyID | Corresponding stream key ID. |
|
optionalrequired |
Callback: Invoked when the SDK requires system permissions to continue functioning.
permissionType | The type of system permission that is required. See [ZoomVideoSDKSystemPermissionType]. |
|
optionalrequired |
Callback: Notify the mic status when testing.
status | The mic status. For more details, See [ZoomVideoSDKTestMicStatus]. |
|
optionalrequired |
Callback event of unbinds the incoming live stream.
helper | Incoming live stream helper utility. |
success | YES is success, otherwise NO. |
streamKeyID | Corresponding stream key ID. |
|
optionalrequired |
Callback: Invoked when the active audio changes.
helper | Audio helper utility. |
userArray | Active audio list. |
|
optionalrequired |
Callback: Invoked when a user makes changes to their audio, such as muting or unmuting their audio.
helper | Audio helper utility. |
userArray | List of users who have just left the session. |
|
optionalrequired |
Callback: Invoked when the session host changes.
helper | User helper utility. |
user | The host userInfo. |
|
optionalrequired |
Callback: Invoked when a user joins the session.
helper | User help utility. |
userArray | List of users who have just joined the session. |
|
optionalrequired |
Callback: Invoked when a user leaves the session.
helper | User helper utility. |
userArray | List of users who have just left the session. |
|
optionalrequired |
Callback: Invoked when the manager of the session changes.
user | See [ZoomVideoSDKUser]. |
|
optionalrequired |
Callback: Invoked when a user changes their name.
user | See [ZoomVideoSDKUser]. |
|
optionalrequired |
Callback: user agreement status change.
user | the user which agree the record. |
|
optionalrequired |
Invoked when a user makes changes to their sharing status, such as starting screen sharing, starting view sharing, or stopping sharing.
helper | The pointer to a share helper object, see ZoomVideoSDKShareHelper . |
user | The pointer to a user object. |
shareAction | he pointer to the ZoomVideoSDKShareAction object. For more details, refer to ZoomVideoSDKShareAction . |
|
optionalrequired |
Callback event of the user's video network quality changes.
status | status video network quality. For more details, See ZoomVideoSDKNetworkStatus . |
user | The pointer to the user who speaks the message. For more details, refer to ZoomVideoSDKUser . |
|
optionalrequired |
Invoked when a user makes changes to their video, such as starting or stopping their video.
helper | Video helper utility. |
userArray | List of users who have just left the session. |
|
optionalrequired |
Callback is invoked when the external UVC camera status changes.
status | UVC camera status. |
|
optionalrequired |
Callback event of video alpha channel mode changes.
isAlphaChannelOn | True means that alpha channel mode is on, otherwise off. |
|
optionalrequired |
Callback event for the subscribed user's video fail reason.
failReason | The fail reason. For more details, see ZoomVideoSDKSubscribeFailReason . |
user | The pointer to the user whose view we would like to subscribe. For more details, refer to ZoomVideoSDKUser . |
view | The view that failed to subscribe. |