Video SDK for Android API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKDelegate.java
Go to the documentation of this file.
1package us.zoom.sdk;
2
3import android.content.Intent;
4import android.view.View;
5
6import java.util.List;
7
8
14public interface ZoomVideoSDKDelegate {
15
20
25 @Deprecated
27
33
38 void onError(int errorCode);
39
45 void onUserJoin(ZoomVideoSDKUserHelper userHelper, List<ZoomVideoSDKUser> userList);
46
52 void onUserLeave(ZoomVideoSDKUserHelper userHelper, List<ZoomVideoSDKUser> userList);
53
59 void onUserVideoStatusChanged(ZoomVideoSDKVideoHelper videoHelper, List<ZoomVideoSDKUser> userList);
60
67 @Deprecated
68 void onShareNetworkStatusChanged(ZoomVideoSDKNetworkStatus shareNetworkStatus, boolean isSendingShare);
69
75 void onUserAudioStatusChanged(ZoomVideoSDKAudioHelper audioHelper, List<ZoomVideoSDKUser> userList);
76
88
100
109
116
123
131
138
146
152
158
159
165 void onUserActiveAudioChanged(ZoomVideoSDKAudioHelper audioHelper, List<ZoomVideoSDKUser> list);
166
175
184
185
191
198
199
205
212 void onCommandReceived(ZoomVideoSDKUser sender, String strCmd);
213
220 void onCommandChannelConnectResult(boolean isSuccess);
221
228
233
240
241
249
257
263
269
275
282
288
295
302
310 void onCameraControlRequestResult(ZoomVideoSDKUser user, boolean isApproved);
311
321
329 @Deprecated
331
337
344
353
362
371
378
379
387
395
404
410 void onMicSpeakerVolumeChanged(int micVolume, int speakerVolume);
411
417 void onCalloutJoinSuccess(ZoomVideoSDKUser user, String phoneNumber);
418
425
432
439 void onUVCCameraStatusChange(String cameraId, UVCCameraStatus status);
440
445 void onVideoAlphaChannelStatusChanged(boolean isAlphaModeOn);
446
452 void onSpotlightVideoChanged(ZoomVideoSDKVideoHelper videoHelper, List<ZoomVideoSDKUser> userList);
453
460
467 void onBindIncomingLiveStreamResponse(boolean bSuccess, String streamKeyID);
468
475 void onUnbindIncomingLiveStreamResponse(boolean bSuccess, String streamKeyID);
476
483 void onIncomingLiveStreamStatusResponse(boolean bSuccess, List<IncomingLiveStreamStatus> streamsStatusList);
484
491 void onStartIncomingLiveStreamResponse(boolean bSuccess, String streamKeyID);
492
499 void onStopIncomingLiveStreamResponse(boolean bSuccess, String streamKeyID);
500
511
517 void onSubSessionStatusChanged(ZoomVideoSDKSubSessionStatus status, List<SubSessionKit> subSessionKitList);
518
525
532
539
546 void onBroadcastMessageFromMainSession(String message, String userName);
547
554
561
568
574 void onStartBroadcastResponse(boolean bSuccess, String channelID);
575
580 void onStopBroadcastResponse(boolean bSuccess);
581
588
594
601
608
614 void onCanvasSnapshotTaken(ZoomVideoSDKUser user, boolean isShare);
615
621
622
628
636
643
650 void onAudioLevelChanged(int level, boolean audioSharing, ZoomVideoSDKUser user);
651
657
663}
Zoom Video SDK chat message bean.
Zoom Video SDK video canvas view.
Enumeration of failure reasons for real-time media streams.
Enumeration of real-time media streams status.
Enumeration of the type for annotation tool. For more information, please visit https://support....
Enumerates the statuses of a CRC call.
Enumerates the types of remote camera control requests.
Enumerates the types of the chat message delete.
Enumeration of the data type for network quality monitoring.
Enumeration of supported export formats for content, such as whiteboard.
Enumerations representing the status of a file transfer.
Enumeration of live streaming statuses.
Enumeration of the network statuses.
Enumerates the various reasons for a phone call failure.
Enumerates the statuses of a phone call.
Enumerates the possible reasons for leaving a session.
Enumeration of Zoom Video SDK share setting types.
Enumerates the status of sharing.
Enumeration of test microphone status.
Enumeration of subsession user help request results.
Enumerates the reasons for a failed video subscription attempt.
Represents an audio device in the Zoom Video SDK.
Audio control interface. See ZoomVideoSDK#getAudioHelper().
Zoom Video SDK audio raw data bean.
A listener class that groups together the callbacks related to a session.
void onSubSessionUsersUpdate(SubSessionKit subSessionKit)
Callback event when the subsession users are updated.
void onOriginalLanguageMsgReceived(ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionMessageInfo messageInfo)
Callback event when an original language message is received.
void onAnnotationHelperCleanUp(ZoomVideoSDKAnnotationHelper helper)
Callback for the annotation helper clean up. After this callback, SDK will release the ZoomVideoSDKAn...
void onSessionLeave()
Callback event when the current user leaves the session.
void onAudioLevelChanged(int level, boolean audioSharing, ZoomVideoSDKUser user)
Notification of the audio level changes for a participant (excluding self).
void onFailedToStartShare(ZoomVideoSDKShareHelper shareHelper, ZoomVideoSDKUser user)
Callback event when a user failed to start sharing.
void onMyAudioSourceTypeChanged(ZoomVideoSDKAudioHelper.ZoomVideoSDKAudioDevice device)
Callback invoked when the current user's audio output device changes.
void onSubSessionParticipantHandle(ZoomVideoSDKSubSessionParticipant participant)
Callback event when a user gains or loses SubSession participant privileges.
void onCalloutJoinSuccess(ZoomVideoSDKUser user, String phoneNumber)
Callback event when the callout user successfully joins the session.
void onUserOverallNetworkStatusChanged(ZoomVideoSDKNetworkStatus level, ZoomVideoSDKUser user)
Notification of a user's overall network status changes.
void onStopIncomingLiveStreamResponse(boolean bSuccess, String streamKeyID)
Callback event that stops the bound stream.
void onChatNewMessageNotify(ZoomVideoSDKChatHelper chatHelper, ZoomVideoSDKChatMessage messageItem)
Callback event when receiving a chat message.
void onProxySettingNotification(ZoomVideoSDKProxySettingHandler handler)
The callback will be triggered when the SSL is verified.
void onSessionJoin()
Callback event when the current user joins the session.
void onUserHostChanged(ZoomVideoSDKUserHelper userHelper, ZoomVideoSDKUser userInfo)
Callback event when the session host changes. ZoomVideoSDKUserHelper#makeHost(ZoomVideoSDKUser).
void onCanvasSnapshotTaken(ZoomVideoSDKUser user, boolean isShare)
Callback invoked when a canvas snapshot is successfully taken.
void onVideoAlphaChannelStatusChanged(boolean isAlphaModeOn)
Callback event when video alpha channel mode changes.
void onShareCanvasSubscribeFail(ZoomVideoSDKUser pUser, ZoomVideoSDKVideoView view, ZoomVideoSDKShareAction shareAction)
Callback event for the subscribed user's share view failure reason.
void onChatPrivilegeChanged(ZoomVideoSDKChatHelper chatHelper, ZoomVideoSDKChatPrivilegeType currentPrivilege)
Callback event when the chat privilege of participant has changed.
void onAnnotationToolTypeChanged(ZoomVideoSDKAnnotationHelper helper, ZoomVideoSDKVideoView view, ZoomVideoSDKAnnotationToolType toolType)
Notification of the annotation tool type changed.
void onHostAskUnmute()
Callback event when a host requests you to unmute yourself.
void onStopBroadcastResponse(boolean bSuccess)
Notificates the response of stopping broadcast streaming.
void onShareAudioRawDataReceived(ZoomVideoSDKAudioRawData rawData)
Callback event when receiving shared raw audio data.
void onCommandChannelConnectResult(boolean isSuccess)
Callback event when the command channel is ready to be used. When the SDK attempts to establish a con...
void onUserLeave(ZoomVideoSDKUserHelper userHelper, List< ZoomVideoSDKUser > userList)
Callback event when a user leaves the session.
void onUserShareStatusChanged(ZoomVideoSDKShareHelper shareHelper, ZoomVideoSDKUser userInfo, ZoomVideoSDKShareStatus status)
Callback event when a user makes changes to their sharing status, such as starting screen sharing,...
void onRealTimeMediaStreamsStatus(RealTimeMediaStreamsStatus status)
Notification of real-time media streams' status changed.
void onSubSessionManagerHandle(ZoomVideoSDKSubSessionManager manager)
Callback event when a user gains or loses subsession manager privileges.
void onMixedAudioRawDataReceived(ZoomVideoSDKAudioRawData rawData)
Callback event when mixed (all users) audio raw data is received.
void onReceiveFileStatus(ZoomVideoSDKReceiveFile file, ZoomVideoSDKFileTransferStatus status)
Callback event when receive file status changes.
void onIncomingLiveStreamStatusResponse(boolean bSuccess, List< IncomingLiveStreamStatus > streamsStatusList)
Callback event that gets the streams status.
void onSubSessionStatusChanged(ZoomVideoSDKSubSessionStatus status, List< SubSessionKit > subSessionKitList)
Callback event for when the subsession status changes.
void onUnbindIncomingLiveStreamResponse(boolean bSuccess, String streamKeyID)
Callback event that unbinds the incoming live stream.
void onLiveTranscriptionStatus(ZoomVideoSDKLiveTranscriptionHelper.ZoomVideoSDKLiveTranscriptionStatus status)
Callback event when live transcription status changes.
void onBindIncomingLiveStreamResponse(boolean bSuccess, String streamKeyID)
Callback event that binds the incoming live stream.
void onChatDeleteMessageNotify(ZoomVideoSDKChatHelper chatHelper, String msgID, ZoomVideoSDKChatMessageDeleteType deleteBy)
Callback event when a user deletes a chat message.
void onUserManagerChanged(ZoomVideoSDKUser user)
Callback event when the manager of the session changes.
void onUserAudioStatusChanged(ZoomVideoSDKAudioHelper audioHelper, List< ZoomVideoSDKUser > userList)
Callback event when a user makes changes to their audio, such as muting or unmuting their audio.
void onUVCCameraStatusChange(String cameraId, UVCCameraStatus status)
Callback is invoked when external uvc camera status changes.
void onShareSettingChanged(ZoomVideoSDKShareSetting setting)
Notification when the share setting has changed.
void onSubSessionUserHelpRequest(SubSessionUserHelpRequestHandler handler)
Callback event when the user receives a help request from a SubSession.
void onError(int errorCode)
Callback event when errors occur.
void onCameraControlRequestResult(ZoomVideoSDKUser user, boolean isApproved)
Callback for when the current user is granted camera control access. Once the current user sends the ...
void onCanvasSnapshotIncompatible(ZoomVideoSDKUser user)
Callback invoked when a canvas snapshot is attempted but cannot be taken due to compatibility issues ...
void onLiveStreamStatusChanged(ZoomVideoSDKLiveStreamHelper liveStreamHelper, ZoomVideoSDKLiveStreamStatus status)
Callback event when a user makes changes to their live stream status.
void onShareContentChanged(ZoomVideoSDKShareHelper shareHelper, ZoomVideoSDKUser userInfo, ZoomVideoSDKShareAction shareAction)
Callback event when a user makes changes to their share content type, such as switching camera share ...
void onCameraControlRequestReceived(ZoomVideoSDKUser user, ZoomVideoSDKCameraControlRequestType requestType, ZoomVideoSDKCameraControlRequestHandler requestHandler)
Callback interface for when the current user has received a camera control request....
void onUserVideoNetworkStatusChanged(ZoomVideoSDKNetworkStatus status, ZoomVideoSDKUser user)
Callback event of the user's video network quality changes.
void onBroadcastMessageFromMainSession(String message, String userName)
Callback event when the user receives a main session broadcast message.
void onUserActiveAudioChanged(ZoomVideoSDKAudioHelper audioHelper, List< ZoomVideoSDKUser > list)
Callback event when the active audio changes.
void onWhiteboardExported(ZoomVideoSDKExportFormat format, byte[] data)
Callback invoked when a whiteboard file export completes.
void onLiveTranscriptionMsgInfoReceived(ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionMessageInfo messageInfo)
Callback event when a live transcription message is received.
void onUserJoin(ZoomVideoSDKUserHelper userHelper, List< ZoomVideoSDKUser > userList)
Callback event when a user joins the session.
void onUserRecordingConsent(ZoomVideoSDKUser user)
Callback event when a user consents to individual recording.
void onStartBroadcastResponse(boolean bSuccess, String channelID)
Notificates of the response of starting broadcast streaming.
void onShareContentSizeChanged(ZoomVideoSDKShareHelper shareHelper, ZoomVideoSDKUser user, ZoomVideoSDKShareAction shareAction)
Callback event when the share content size has changed. Call function ZoomVideoSDKShareAction#getShar...
void onStreamingJoinStatusChanged(ZoomVideoSDKStreamingJoinStatus status)
Notificates when the viewer's join status changes.
void onSendFileStatus(ZoomVideoSDKSendFile file, ZoomVideoSDKFileTransferStatus status)
Callback event when send file status changes.
void onRealTimeMediaStreamsFail(RealTimeMediaStreamsFailReason failReason)
Notification of real-time media streams' failure reason.
void onMultiCameraStreamStatusChanged(ZoomVideoSDKMultiCameraStreamStatus status, ZoomVideoSDKUser user, ZoomVideoSDKRawDataPipe videoPipe)
Callback event when someone in a given session enables or disables multi-camera. All participants in ...
void onUserVideoStatusChanged(ZoomVideoSDKVideoHelper videoHelper, List< ZoomVideoSDKUser > userList)
Callback event when a user makes changes to their video, such as starting or stopping their video.
void onUserNameChanged(ZoomVideoSDKUser user)
Callback event when a user changes their name.
void onSSLCertVerifiedFailNotification(ZoomVideoSDKSSLCertificateInfo info)
The callback will be triggered when the SSL verified fail.
void onSessionPasswordWrong(ZoomVideoSDKPasswordHandler handler)
Callback event when the provided session password is wrong or invalid.
void onSpokenLanguageChanged(ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage spokenLanguage)
Notification that the spoken language has changed.
void onSpotlightVideoChanged(ZoomVideoSDKVideoHelper videoHelper, List< ZoomVideoSDKUser > userList)
Callback event when the video spotlight user list changes.
void onMultiCameraStreamStatusChanged(ZoomVideoSDKMultiCameraStreamStatus status, ZoomVideoSDKUser user, ZoomVideoSDKVideoCanvas canvas)
Callback event when someone enables or disables multi-camera. This callback is received by all partic...
void onUserNetworkStatusChanged(ZoomVideoSDKDataType type, ZoomVideoSDKNetworkStatus level, ZoomVideoSDKUser user)
Notification of a user's network status changes for a specific data type.
void onInviteByPhoneStatus(ZoomVideoSDKPhoneStatus status, ZoomVideoSDKPhoneFailedReason reason)
Callback event when the invite by phone status changes to any other valid status such as Calling,...
void onAnnotationPrivilegeChange(ZoomVideoSDKUser shareOwner, ZoomVideoSDKShareAction shareAction)
Callback for the annotation privilege change.
void onShareNetworkStatusChanged(ZoomVideoSDKNetworkStatus shareNetworkStatus, boolean isSendingShare)
Callback event when the current user's share network quality changes.
void onSessionLeave(ZoomVideoSDKSessionLeaveReason reason)
Callback event when the current user leaves the session with reason.
void onUserShareStatusChanged(ZoomVideoSDKShareHelper shareHelper, ZoomVideoSDKUser userInfo, ZoomVideoSDKShareAction shareAction)
Callback event when a user makes changes to their sharing status, such as starting screen sharing,...
void onCommandReceived(ZoomVideoSDKUser sender, String strCmd)
Callback event when receiving a message, data, or a command from the command channel....
void onSessionNeedPassword(ZoomVideoSDKPasswordHandler handler)
Callback event when the session requires a password to join.
void onUserWhiteboardShareStatusChanged(ZoomVideoSDKUser user, ZoomVideoSDKWhiteboardHelper helper)
Callback invoked when a user changes their whiteboard sharing status, such as starting or stopping wh...
void onShareCanvasSubscribeFail(ZoomVideoSDKVideoSubscribeFailReason fail_reason, ZoomVideoSDKUser pUser, ZoomVideoSDKVideoView view)
Callback event of subscribe user's share view fail reason.
void onStartIncomingLiveStreamResponse(boolean bSuccess, String streamKeyID)
Callback event that starts the bound stream.
void onOneWayAudioRawDataReceived(ZoomVideoSDKAudioRawData rawData, ZoomVideoSDKUser user)
Callback event when individual user's audio raw data is received.
void onCloudRecordingStatus(ZoomVideoSDKRecordingStatus status, ZoomVideoSDKRecordingConsentHandler handler)
Callback event when cloud recording status has paused, stopped, resumed, or otherwise changed.
void onCallCRCDeviceStatusChanged(ZoomVideoSDKCRCCallStatus status)
Callback event of the call CRC device's status.
void onSubSessionUserHelpRequestResult(ZoomVideoSDKUserHelpRequestResult eResult)
Callback event when the user receives a help request from a SubSession.
void onLiveTranscriptionMsgError(ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage spokenLanguage, ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage transcriptLanguage)
Callback event when a live translation error occurs.
void onTestMicStatusChanged(ZoomVideoSDKTestMicStatus status)
Notify the mic status when testing.
void onMicSpeakerVolumeChanged(int micVolume, int speakerVolume)
Notify the current mic or speaker volume.
void onGetBroadcastControlStatus(boolean bSuccess, ZoomVideoSDKBroadcastControlStatus status)
Notificates the response of getting broadcast status.
void onVideoCanvasSubscribeFail(ZoomVideoSDKVideoSubscribeFailReason fail_reason, ZoomVideoSDKUser pUser, ZoomVideoSDKVideoView view)
Callback event of subscribe user's video fail reason.
Live stream control interface. Zoom Video SDK supports live streaming of a session to Facebook Live,...
Live transcription language interface for retrieving the ID and name of the language....
Live transcription interface. Zoom Video SDK supports live transcription (an additional add-on servic...
Interface for handling proxy settings and authentication.
Interface for user to subscribe/unSubscribe video raw data. ZoomVideoSDKUser#getVideoPipe().
Zoom Video SDK user information.
Interface for subscribing or unsubscribing to a specific user's video or share canvas....
An interface to control video and manage cameras during a video session.