Zoom Android SDK

https://github.com/zoom/zoom-sdk-android
Admin
Zoom Android SDK
Tokens:2,395
Snippets:34
Trust Score:8.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Old API User Start Meeting Logic (Deprecated)

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

This code snippet demonstrates the previous method for starting a meeting for an API user. This approach is deprecated and should be replaced with the new `startMeetingWithParams` method.

```Java
StartMeetingOptions opts = new StartMeetingOptions();
//opts.no_driving_mode = true;
//……………
int ret = meetingService.startMeeting(this, USER_ID, ZOOM_TOKEN,
USER _TYPE, meetingNo, DISPLAY_NAME, opts);
```

--------------------------------

### New API User Start Meeting Logic

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

This code snippet demonstrates the new recommended method for starting a meeting for an API user using `startMeetingWithParams`. It requires a Zoom Access Token (ZAK) retrieved via the REST API.

```Java
StartMeetingParamsWithoutLogin params = new StartMeetingParamsWithoutLogin();
params.userId = USER_ID;
params.zoomToken = ZOOM_TOKEN;
params.userType = STYPE;;
params.displayName = DISPLAY_NAME;
params.zoomAccessToken = ZOOM_ACCESS_TOKEN;
params.meetingNo = meetingNo;

StartMeetingOptions opts = new StartMeetingOptions();
//opts.no_driving_mode = true;
//……………
int ret = meetingService.startMeetingWithParams(this, params, opts);
```

--------------------------------

### InMeetingServiceListener Video Callbacks Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Callbacks added to notify the user when the host/cohost asks them to start video or when their video status changes, specifically when muted by the host.

```Java
onHostAskStartVideo
onUserVideoStatusChanged
VideoStatus.Video_Mute_ByHost
```

--------------------------------

### IBOData Method Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Method added to get the name of the current breakout room the user is in. Provides information about the user's current breakout session.

```Java
IBOData.getCurrentBoName()
```

--------------------------------

### Deprecated Zoom Android SDK Initialization Methods

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

These methods for initializing the Zoom SDK are being deprecated. Developers should transition to using the latest initialization interfaces provided by the SDK.

```Java
initialize(Context context, String appKey, String appSecret, ZoomSDKInitializeListener listener)
```

```Java
initialize(Context context, String appKey, String appSecret, boolean autoRetryVerifyApp, ZoomSDKInitializeListener listener)
```

```Java
initialize(Context context, String appKey, String appSecret, String domain, boolean autoRetryVerifyApp, ZoomSDKInitializeListener listener)
```

```Java
initialize(Context context, String appKey, String appSecret, String domain, boolean autoRetryVerifyApp, ZoomSDKInitializeListener listener, boolean enableLog)
```

```Java
initialize(Context context, String appKey, String appSecret, String domain, boolean autoRetryVerifyApp, ZoomSDKInitializeListener listener, boolean enableLog, int logSize)
```

```Java
initialize(Context context, String appKey, String appSecret, String domain, ZoomSDKInitializeListener listener)
```

```Java
initialize(Context context, String appKey, String appSecret, String domain, ZoomSDKInitializeListener listener, boolean enableLog)
```

```Java
initialize(Context context, String appKey, String appSecret, String domain, ZoomSDKInitializeListener listener, boolean enableLog, int logSize)
```

--------------------------------

### Required Dependencies Gradle

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Specifies the new dependencies that must be added to the SDK project's build configuration. These are required for the SDK to function correctly.

```Gradle
implementation 'com.google.android.material:material:1.2.0-alpha02'
implementation 'com.google.android:flexbox:2.0.1'
implementation 'androidx.swiperefreshlayout:swiperefreshlayout:1.0.0'
```

--------------------------------

### Deprecated Zoom Android SDK Meeting and SDK Methods

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

These methods related to starting/joining meetings and setting app key pairs are deprecated. Developers should update their implementations to use the recommended replacement interfaces.

```Java
MeetingService.joinMeeting(Context, String, String)
```

```Java
MeetingService.joinMeeting(Context, String, String, MeetingOptions)
```

```Java
MeetingService.joinMeeting(Context, String, String, String)
```

```Java
MeetingService.joinMeeting(Context, String, String, String, MeetingOptions)
```

```Java
ZoomSDK.setBoxAppKeyPair(Context, String, String)
```

```Java
ZoomSDK.setDropBoxAppKeyPair(Context, String, String)
```

```Java
ZoomSDK.setGoogleDriveInfo(Context, String, String)
```

```Java
ZoomSDK.setOneDriveClientId(Context, String)
```

```Java
MeetingService.startInstantMeeting(Context, String, String, int, String)
```

```Java
MeetingService.startInstantMeeting(Context, String, String, int, String, MeetingOptions)
```

```Java
MeetingService.startMeeting(Context, String)
```

```Java
MeetingService.startMeeting(Context, String, MeetingOptions)
```

```Java
MeetingService.startMeeting(Context, String, String, int, String, String)
```

```Java
MeetingService.startMeeting(Context, String, String, int, String, String, MeetingOptions)
```

--------------------------------

### InMeetingServiceListener Free Meeting Callbacks Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Callbacks added to notify the user about events related to free meeting upgrades. These indicate when an upgrade is needed or the status of a free trial upgrade.

```Java
onFreeMeetingNeedToUpgrade
onFreeMeetingUpgradeToGiftFreeTrialStart
onFreeMeetingUpgradeToGiftFreeTrialStop
onFreeMeetingUpgradeToProMeeting
```

--------------------------------

### IDirectShareServiceHelper Interface Methods Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Provides methods to manage the direct share feature in Zoom Rooms. Use these methods to check direct share capability, status, and initiate or stop sharing.

```Java
void setEvent(IDirectShareServiceHelperEvent listener)
boolean canStartDirectShare()
boolean isDirectShareInProgress()
MobileRTCSDKError startDirectShare()
MobileRTCSDKError stopDirectShare()
```

--------------------------------

### JoinMeetingParams Property Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Property added to the JoinMeetingParams class to support joining a webinar using a token. Provides an alternative authentication method for webinars.

```Java
JoinMeetingParams.webinarToken
```

--------------------------------

### IMeetingInterpretationControllerEvent Callbacks Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Callbacks for receiving events related to language interpretation status and interpreter changes. Implement this interface to be notified of interpretation lifecycle events.

```Java
void onInterpretationStart()
void onInterpretationStop()
void onInterpreterRoleChanged(int userID, boolean isInterpreter)
void onInterpreterActiveLanguageChanged(int userID, int activeLanID)
void onInterpreterLanguageChanged(int lanID1, int lanID2)
void onAvailableLanguageListUpdated(List<IInterpretationLanguage> pAvailableLanguageList)
```

--------------------------------

### Accessing In-Meeting Interpretation Controller Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Provides access to the controller for managing language interpretation features within a meeting. This is the entry point to interact with interpretation functionalities.

```Java
InMeetingInterpretationController getInMeetingInterpretationController()
```

--------------------------------

### InMeetingQAController Methods Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Methods added to manage Questions and Answers within a meeting. Allows deleting specific questions or answers by their ID.

```Java
InMeetingQAController.deleteQuestion(String questionID)
InMeetingQAController.deleteAnswer(String answerID)
```

--------------------------------

### IInterpreter Interface Methods Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Defines the methods available on an object representing a meeting interpreter. These methods allow retrieving details about the interpreter and their assigned languages.

```Java
long getUserID()
int getLanguageID1()
int getLanguageID2()
```

--------------------------------

### IInterpretationLanguage Interface Methods Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Defines the methods available on an object representing an interpretation language. These methods allow retrieving details about a specific language.

```Java
int getLanguageID()
String getLanguageAbbreviations()
String getLanguageName()
```

--------------------------------

### IDirectShareServiceHelperEvent Callback Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Callback interface for receiving updates on the direct share status. Implement this to handle changes in the direct share process.

```Java
void onDirectShareStatusUpdate(DirectShareStatus status, IDirectShareViaMeetingIDOrPairingCodeHandler handler)
```

--------------------------------

### InMeetingInterpretationController Methods Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Provides methods to control and query the state of language interpretation in a meeting. This includes setting events, checking status, managing interpreters, and joining language channels.

```Java
void setEvent(IMeetingInterpretationControllerEvent event)
boolean isInterpretationEnabled()
boolean isInterpretationStarted()
boolean isInterpreter()
IInterpretationLanguage getInterpretationLanguageByID(int lanID)
List<IInterpretationLanguage> getAllLanguageList()
List<IInterpreter> getInterpreterList()
boolean addInterpreter(long  userID, int lanID1, int lanID2)
boolean removeInterpreter(long  userID)
boolean modifyInterpreter(long  userID, int lanID1, int lanID2)
MobileRTCSDKError startInterpretation()
MobileRTCSDKError stopInterpretation()
List<IInterpretationLanguage> getAvailableLanguageList()
MobileRTCSDKError joinLanguageChannel(int lanID)
int getJoinedLanguageID()
MobileRTCSDKError turnOffMajorAudio()
MobileRTCSDKError turnOnMajorAudio()
boolean isMajorAudioTurnOff()
List<Integer> getInterpreterLans();
MobileRTCSDKError setInterpreterActiveLan(int activeLanID);
int getInterpreterActiveLan()
```

--------------------------------

### PreMeetingService Method Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Method added to check if the Personal Meeting ID (PMI) option is disabled on the account. Useful for determining available meeting options.

```Java
PreMeetingService.isDisabledPMI
```

--------------------------------

### MeetingSettingsHelper Method Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Method added related to the 'Always show video preview when joining a video meeting' feature. Allows disabling this preview option.

```Java
MeetingSettingsHelper.disableShowVideoPreviewWhenJoinMeeting
```

--------------------------------

### MeetingSettingsHelper Method Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Method added to enable or disable the 'Use Original Sound' option in meeting settings. Provides control over audio processing.

```Java
MeetingSettingsHelper.enableMicOriginalInput
```

--------------------------------

### IDirectShareViaMeetingIDOrPairingCodeHandler Interface Methods Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Handler for attempting direct share using a meeting number or pairing code. Provides methods to initiate the connection attempt or cancel it.

```Java
MobileRTCSDKError tryWithMeetingNumber(long meetingNumber)
MobileRTCSDKError tryWithPairingCode(String pairingCode)
MobileRTCSDKError cancel()
```

--------------------------------

### ZoomUIService Method Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Method added to enable or disable the mini meeting window feature. Provides control over the meeting UI behavior.

```Java
ZoomUIService.enableMinimizeMeeting(boolean enable)
```

--------------------------------

### CallOutRoomSystemStatus Values Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

New status values added to the H323 callout status enumeration. These indicate specific states like busy or declined for room system callouts.

```Java
CallOutRoomSystemStatus.CallOutRoomSystem_Busy
CallOutRoomSystemStatus.CallOutRoomSystem_Decline
```

--------------------------------

### InMeetingService Method Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Method added to modify the meeting topic displayed on the 'meeting information' page during a meeting. Allows dynamic updating of the topic.

```Java
InMeetingService.setMeetingTopic
```

--------------------------------

### InMeetingService Methods Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Methods added to control participant permissions during a meeting. Allows the host/cohost to enable or disable participants' ability to unmute or rename themselves.

```Java
InMeetingService.allowParticipantsToUnmuteSelf(boolean allow)
InMeetingService.allowParticipantsToRename(boolean allow)
```

--------------------------------

### InMeetingQAController Delete Callbacks Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Callbacks added to notify the user when questions or answers are deleted in the Q&A session. Provides lists of the IDs of the deleted items.

```Java
InMeetingQAController.onDeleteQuestion(List<String> questionList)
InMeetingQAController. onDeleteAnswer(List<String> answerList)
```

--------------------------------

### MeetingSettingsHelper Method Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Method added to control the ability to copy the Zoom meeting URL when long-pressing the meeting ID. Allows disabling this option for security or UI reasons.

```Java
void disableCopyMeetingUrl(boolean disable)
```

--------------------------------

### ZoomUIService Method Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Method added to show or hide the 'Disconnect audio' button in the meeting UI. Allows customization of the audio control options.

```Java
ZoomUIService.hideDisconnectAudio
```

--------------------------------

### InMeetingUserInfo Method Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Method added to retrieve the unique participant ID for a user in the meeting. Useful for identifying participants programmatically.

```Java
InMeetingUserInfo.getParticipantID()
```

--------------------------------

### InMeetingServiceListener Callback Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Callback added to notify when a user's name has changed during the meeting. Useful for updating participant lists or UI elements.

```Java
InMeetingServiceListener.onUserNameChanged
```

--------------------------------

### ICustomizedVideoSink Callback Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Callback added to notify the user if their video subscription fails when using a Custom Meeting UI. Useful for handling video rendering issues.

```Java
void onSubscribeUserFail(int errorCode, int size, long userId)
```

--------------------------------

### ZoomSDKInitParams Property Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Property added to enable or disable the generation of crash dumps (Java and native). Useful for debugging crashes.

```Java
ZoomSDKInitParams.enableGenerateDump
```

--------------------------------

### Deprecated Attendee Chat Methods Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

These methods for allowing or disallowing attendee chat have been deprecated. Developers should use alternative methods for managing chat permissions.

```Java
MobileRTCSDKError allowAttendeeChat()
MobileRTCSDKError disallowAttendeeChat()
```

--------------------------------

### InMeetingChatMessage Method Java

Source: https://github.com/zoom/zoom-sdk-android/blob/master/CHANGELOG.md

Method added to determine the type of a chat message within the meeting. Useful for processing different types of chat messages.

```Java
InMeetingChatMessage.getChatMessageType()
```
Tokens:
Raw