InMeetingService (Zoom.us SDK API Document)

```
public interface InMeetingService
```
Interfaces of ZOOM services in meeting.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`activeShareUserID()` Get the ID of active presenter in meeting.
`void`	`addListener(InMeetingServiceListener listener)` Register a listener for in-meeting events.
`MobileRTCSDKError`	`allowParticipantsToRename(boolean allow)` Allow participant to rename self
`MobileRTCSDKError`	`allowParticipantsToUnmuteSelf(boolean allow)` Allow participant to unmute self
`MobileRTCSDKError`	`assignCohost(long userId)` Assign a user as co-host in meeting.
`boolean`	`canbeCohost(long userId)` Query if the user can be assigned as co-host in meeting.
`boolean`	`canReclaimHost()` Call this interface to check whether the user can reclaim host
`MobileRTCSDKError`	`changeName(java.lang.String inputName, long userId)` Rename users in meeting.
`boolean`	`claimHostWithHostKey(java.lang.String hostKey)` Set to claim to be a host by host key.
`java.lang.String`	`getCurrentMeetingID()` Get unique ID of current meeting in format such as DVLObefSZizM0xQLhtrCQ==.
`java.lang.String`	`getCurrentMeetingInviteEmailContent()` Get content of email invitation for current meeting.
`java.lang.String`	`getCurrentMeetingInviteEmailSubject()` Get subject of email invitation for current meeting.
`long`	`getCurrentMeetingNumber()` Get current meeting number in format such as 123456789.
`java.lang.String`	`getCurrentMeetingTopic()` Get the topic/title of the current meeting.
`java.lang.String`	`getCurrentMeetingUrl()` Get the URL of the current meeting.
`byte[]`	`getE2EMeetingSecureKey()` Get secure key of current encrypted meeting.
`InMeetingAnnotationController`	`getInMeetingAnnotationController()` Get annotation controller instance in meeting.
`InMeetingAudioController`	`getInMeetingAudioController()` Get audio controller instance in meeting.
`InMeetingBOController`	`getInMeetingBOController()` Get breakout room controller instance in meeting.
`InMeetingChatController`	`getInMeetingChatController()` Get chat controller instance in meeting.
`InMeetingCloudRecordController`	`getInMeetingCloudRecordController()` Get cloud recording controller instance in meeting.
`InMeetingLiveStreamController`	`getInMeetingLiveStreamController()` Get live-streaming controller instance in meeting.
`InMeetingQAController`	`getInMeetingQAController()` Get QA controller instance in meeting.
`InMeetingRemoteController`	`getInMeetingRemoteController()` Get remote controller instance in meeting.
`InMeetingShareController`	`getInMeetingShareController()` Get shared controller instance in meeting.
`int`	`getInMeetingUserCount()` Get the number of participants in meeting.
`java.util.List<java.lang.Long>`	`getInMeetingUserList()` Get the list of all participants in meeting.
`InMeetingVideoController`	`getInMeetingVideoController()` Get video controller instance in meeting.
`InMeetingWaitingRoomController`	`getInMeetingWaitingRoomController()` Get waiting room controller instance in meeting.
`InMeetingWebinarController`	`getInMeetingWebinarController()` Get webinar controller instance in meeting.
`java.lang.String`	`getMeetingPassword()` get the current meeting's password
`long`	`getMyUserID()` Get the current user ID in the meeting.
`InMeetingUserInfo`	`getMyUserInfo()` Get the information of current user in meeting.
`long`	`getParticipantId()` Get the current user participant id.
`InMeetingUserInfo`	`getUserInfoById(long userId)` Get the information of the specified user.
`boolean`	`handleE2EMeetingExternalSessionKeyReady(java.util.Map<EnumComponentType,com.zipow.videobox.util.E2EMeetingExternalSessionKey> params, boolean isLeaveMeeting)` Set session key of custom meeting.
`boolean`	`isExternalMeeting()` Query if the current meeting is external.
`boolean`	`isFailoverMeeting()` Query if the current meeting is failover.
`boolean`	`isHostUser(long userId)` Query if the current user is host.
`boolean`	`isInternalMeeting()` Query if the current meeting is internal.
`boolean`	`isMeetingConnected()` Query if the meeting is connected.
`boolean`	`isMeetingHost()` Query if the current user is the host of the meeting.
`boolean`	`isMeetingLocked()` Query if the meeting is locked by host.
`boolean`	`isMyself(long userId)` Query if the owner of ID is the current user himself.
`boolean`	`isParticipantsRenameAllowed()` Query is allow participant to rename self
`boolean`	`isParticipantsUnmuteSelfAllowed()` Query is allow participant to unmute self
`boolean`	`isPlayChimeOn()` Query if chime is enabled when user joins/leaves meeting.
`boolean`	`isWebinarMeeting()` Query if the current meeting is a webinar.
`void`	`leaveCurrentMeeting(boolean endIfPossible)` Leave the current meeting.
`MobileRTCSDKError`	`lockMeeting(boolean isLock)` Query if the current meeting is locked by host or co-host.
`MobileRTCSDKError`	`lowerAllHands()` The host puts all participants' hands down.
`MobileRTCSDKError`	`lowerHand(long userId)` The current user puts hands down.
`MobileRTCSDKError`	`makeHost(long userId)` Assign a user as the host in meeting.
`int`	`querySessionNetworkStatus(EnumComponentType type, boolean bSending)` Query network status of current meeting.
`MobileRTCSDKError`	`raiseMyHand()` The current user raises hand.
`MobileRTCSDKError`	`reclaimHost()` Reclaim host permission.
`void`	`removeListener(InMeetingServiceListener listener)` Unregister the listener for in-meeting events.
`MobileRTCSDKError`	`removeUser(long userId)` Remove a user from the meeting.
`MobileRTCSDKError`	`revokeCohost(long userId)` Revoke co-host role of user in meeting.
`MobileRTCSDKError`	`setMeetingTopic(java.lang.String topic)` Set a customized meeting topic in meeting, only orginal-host has this permission
`MobileRTCSDKError`	`setPlayChimeOnOff(boolean on)` Set whether to play chime when user joins or leaves meeting.
`void`	`showZoomParticipantsUI(android.app.Activity activity, int requestCode)` Show the views of ZOOM meeting participants.
`void`	`showZoomQAUI(android.app.Activity activity, int requestCode)` Show the views of ZOOM questions and answers.

- Method Detail
  - addListener
```
void addListener(InMeetingServiceListener listener)
```
    Register a listener for in-meeting events.
    
    Parameters:
    
    listener - The listener instance.
  - removeListener
```
void removeListener(InMeetingServiceListener listener)
```
    Unregister the listener for in-meeting events.
    
    Parameters:
    
    listener - The listener instance.
  - getInMeetingAudioController
```
InMeetingAudioController getInMeetingAudioController()
```
    Get audio controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingAudioController.
  - getInMeetingVideoController
```
InMeetingVideoController getInMeetingVideoController()
```
    Get video controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingVideoController.
  - getInMeetingShareController
```
InMeetingShareController getInMeetingShareController()
```
    Get shared controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingShareController.
  - getInMeetingChatController
```
InMeetingChatController getInMeetingChatController()
```
    Get chat controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingChatController.
  - getInMeetingAnnotationController
```
InMeetingAnnotationController getInMeetingAnnotationController()
```
    Get annotation controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingAnnotationController.
  - getInMeetingCloudRecordController
```
InMeetingCloudRecordController getInMeetingCloudRecordController()
```
    Get cloud recording controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingCloudRecordController.
  - getInMeetingQAController
```
InMeetingQAController getInMeetingQAController()
```
    Get QA controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingQAController.
  - getInMeetingWaitingRoomController
```
InMeetingWaitingRoomController getInMeetingWaitingRoomController()
```
    Get waiting room controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingWaitingRoomController.
  - getInMeetingRemoteController
```
InMeetingRemoteController getInMeetingRemoteController()
```
    Get remote controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingRemoteController.
  - getInMeetingLiveStreamController
```
InMeetingLiveStreamController getInMeetingLiveStreamController()
```
    Get live-streaming controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingLiveStreamController.
  - getInMeetingWebinarController
```
InMeetingWebinarController getInMeetingWebinarController()
```
    Get webinar controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingWebinarController.
  - getInMeetingBOController
```
InMeetingBOController getInMeetingBOController()
```
    Get breakout room controller instance in meeting.
    
    Returns:
    
    The instance defined in InMeetingBOController.
  - isMeetingConnected
```
boolean isMeetingConnected()
```
    Query if the meeting is connected.
    
    Returns:
    
    TRUE means connected. FALSE not.
  - isMeetingLocked
```
boolean isMeetingLocked()
```
    Query if the meeting is locked by host.
    
    Returns:
    
    TRUE means locked. FALSE not.
  - lockMeeting
```
MobileRTCSDKError lockMeeting(boolean isLock)
```
    Query if the current meeting is locked by host or co-host.
    
    Parameters:
    
    isLock - TRUE means locked. FALSE unlocked.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - getInMeetingUserCount
```
int getInMeetingUserCount()
```
    Get the number of participants in meeting.
    
    Returns:
    
    The number of participants in meeting
  - changeName
```
MobileRTCSDKError changeName(java.lang.String inputName,
                             long userId)
```
    Rename users in meeting.
    
    Parameters:
    
    inputName - Enter a new screen name for user in meeting.
    
    userId - The ID of user whose screen name is changed in meeting.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - getInMeetingUserList
```
java.util.List<java.lang.Long> getInMeetingUserList()
```
    Get the list of all participants in meeting.
    
    Returns:
    
    List of all users ID.
  - getMyUserID
```
long getMyUserID()
```
    Get the current user ID in the meeting.
    
    Returns:
    
    The current user ID.
  - getParticipantId
```
long getParticipantId()
```
    Get the current user participant id.
    
    Returns:
    
    the current user participant id.
  - getMyUserInfo
```
InMeetingUserInfo getMyUserInfo()
```
    Get the information of current user in meeting.
    
    Returns:
    
    The information of current user, an object of InMeetingUserInfo.
  - getUserInfoById
```
InMeetingUserInfo getUserInfoById(long userId)
```
    Get the information of the specified user.
    
    Parameters:
    
    userId - The ID of specified user.
    
    Returns:
    
    The information of specified user, an object of InMeetingUserInfo.
  - makeHost
```
MobileRTCSDKError makeHost(long userId)
```
    Assign a user as the host in meeting.
    
    Parameters:
    
    userId - The ID of user who is specified as host in meeting.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError. *Note*: The host cannot be assigned as host by himself. And the user should have the power to assign the role.
  - canReclaimHost
```
boolean canReclaimHost()
```
    Call this interface to check whether the user can reclaim host
    
    Returns:
    
    true if the user can reclaim host, otherwise return false *Note*: Only the user is orginal host, but not host now, can reclaim host
  - reclaimHost
```
MobileRTCSDKError reclaimHost()
```
    Reclaim host permission.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError. *Note*: There is a host in the current meeting, but the host permissions are not in the original's hands. The original call this interface to reclaim host permissions.
  - assignCohost
```
MobileRTCSDKError assignCohost(long userId)
```
    Assign a user as co-host in meeting.
    
    Parameters:
    
    userId - The ID of user who is specified as co-host in meeting.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError. *Note*: The co-host cannot be assigned as co-host by himself. And the user should have the power to assign the role.
  - canbeCohost
```
boolean canbeCohost(long userId)
```
    Query if the user can be assigned as co-host in meeting.
    
    Parameters:
    
    userId - The ID of user who will be assigned as co-host in meeting.
    
    Returns:
    
    TRUE means that the user can be assigned as co-host. Otherwise cannot.
  - revokeCohost
```
MobileRTCSDKError revokeCohost(long userId)
```
    Revoke co-host role of user in meeting.
    
    Parameters:
    
    userId - The ID of user who will lose the co-host role.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError. *Note*: The co-host could not revoke the role himself. And the user should have the power to revoke the role.
  - removeUser
```
MobileRTCSDKError removeUser(long userId)
```
    Remove a user from the meeting.
    
    Parameters:
    
    userId - The ID of user to be removed from the meeting.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError. *Note*: Once the user is removed by the host, he can no longer join the current meeting.
  - setPlayChimeOnOff
```
MobileRTCSDKError setPlayChimeOnOff(boolean on)
```
    Set whether to play chime when user joins or leaves meeting.
    
    Parameters:
    
    on - TRUE means enabled. FALSE disabled.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - isPlayChimeOn
```
boolean isPlayChimeOn()
```
    Query if chime is enabled when user joins/leaves meeting.
    
    Returns:
    
    TRUE means enabled. FALSE not.
  - activeShareUserID
```
long activeShareUserID()
```
    Get the ID of active presenter in meeting.
    
    Returns:
    
    The ID of active presenter.
  - isHostUser
```
boolean isHostUser(long userId)
```
    Query if the current user is host.
    
    Parameters:
    
    userId - The ID of user to be checked.
    
    Returns:
    
    TRUE means host. FALSE not.
  - isMyself
```
boolean isMyself(long userId)
```
    Query if the owner of ID is the current user himself.
    
    Parameters:
    
    userId - The ID of user to be checked.
    
    Returns:
    
    TRUE means user himself. FALSE not.
  - raiseMyHand
```
MobileRTCSDKError raiseMyHand()
```
    The current user raises hand.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - lowerHand
```
MobileRTCSDKError lowerHand(long userId)
```
    The current user puts hands down.
    
    Parameters:
    
    userId - The ID of user to put hands down.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - lowerAllHands
```
MobileRTCSDKError lowerAllHands()
```
    The host puts all participants' hands down.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - isMeetingHost
```
boolean isMeetingHost()
```
    Query if the current user is the host of the meeting.
    
    Returns:
    
    TRUE means that the current user is the host of the meeting. FALSE not.
  - leaveCurrentMeeting
```
void leaveCurrentMeeting(boolean endIfPossible)
```
    Leave the current meeting.
    
    Parameters:
    
    endIfPossible - If it is true and the current user is the meeting host, the meeting will be ended when he click the button.
  - getCurrentMeetingID
```
java.lang.String getCurrentMeetingID()
```
    Get unique ID of current meeting in format such as DVLObefSZizM0xQLhtrCQ==.
    
    Returns:
    
    Current meeting ID.
  - getCurrentMeetingNumber
```
long getCurrentMeetingNumber()
```
    Get current meeting number in format such as 123456789.
    
    Returns:
    
    Current meeting number.
  - getCurrentMeetingTopic
```
java.lang.String getCurrentMeetingTopic()
```
    Get the topic/title of the current meeting.
    
    Returns:
    
    The topic/title of the current meeting.
  - getCurrentMeetingUrl
```
java.lang.String getCurrentMeetingUrl()
```
    Get the URL of the current meeting.
    
    Returns:
    
    The URL of the current meeting
  - getCurrentMeetingInviteEmailSubject
```
java.lang.String getCurrentMeetingInviteEmailSubject()
```
    Get subject of email invitation for current meeting.
    
    Returns:
    
    Subject of email invitation.
  - getCurrentMeetingInviteEmailContent
```
java.lang.String getCurrentMeetingInviteEmailContent()
```
    Get content of email invitation for current meeting.
    
    Returns:
    
    Content of email invitation.
  - getE2EMeetingSecureKey
```
byte[] getE2EMeetingSecureKey()
```
    Get secure key of current encrypted meeting.
    
    Returns:
    
    Secure key.
  - handleE2EMeetingExternalSessionKeyReady
```
boolean handleE2EMeetingExternalSessionKeyReady(java.util.Map<EnumComponentType,com.zipow.videobox.util.E2EMeetingExternalSessionKey> params,
                                                boolean isLeaveMeeting)
```
    Set session key of custom meeting.
    
    Parameters:
    
    params - Meeting session keys mapping.
    
    isLeaveMeeting - TRUE means to leave meeting directly; FALSE not.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - isExternalMeeting
```
boolean isExternalMeeting()
```
    Query if the current meeting is external.
    
    Returns:
    
    TRUE means that the current meeting is external. FALSE not.
  - isInternalMeeting
```
boolean isInternalMeeting()
```
    Query if the current meeting is internal.
    
    Returns:
    
    TRUE means that the current meeting is internal. FALSE not.
  - isFailoverMeeting
```
boolean isFailoverMeeting()
```
    Query if the current meeting is failover.
    
    Returns:
    
    TRUE means that the current meeting is failover. FALSE not.
  - querySessionNetworkStatus
```
int querySessionNetworkStatus(EnumComponentType type,
                              boolean bSending)
```
    Query network status of current meeting.
    
    Parameters:
    
    type - Component types defined in EnumComponentType. Note: you can only get the status: AS/VIDEO/AUDIO
    
    bSending - TRUE means to get data sending status; FALSE means receiving status.
    
    Returns:
    
    Quality levels defined in SessionNetQualityLevel.
  - claimHostWithHostKey
```
boolean claimHostWithHostKey(java.lang.String hostKey)
```
    Set to claim to be a host by host key.
    
    Parameters:
    
    hostKey - Host key got from web.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - isWebinarMeeting
```
boolean isWebinarMeeting()
```
    Query if the current meeting is a webinar.
    
    Returns:
    
    TRUE means that the current meeting is a webinar. FALSE not.
  - showZoomParticipantsUI
```
void showZoomParticipantsUI(android.app.Activity activity,
                            int requestCode)
```
    Show the views of ZOOM meeting participants.
    
    Parameters:
    
    activity - Make calls.
    
    requestCode - Reply a request code.
  - showZoomQAUI
```
void showZoomQAUI(android.app.Activity activity,
                  int requestCode)
```
    Show the views of ZOOM questions and answers.
    
    Parameters:
    
    activity - Make calls.
    
    requestCode - Reply a request code.
  - getMeetingPassword
```
java.lang.String getMeetingPassword()
```
    get the current meeting's password
    
    Returns:
    
    The current meeting's password
  - setMeetingTopic
```
MobileRTCSDKError setMeetingTopic(java.lang.String topic)
```
    Set a customized meeting topic in meeting, only orginal-host has this permission
    
    Parameters:
    
    topic - The customized topic
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - allowParticipantsToRename
```
MobileRTCSDKError allowParticipantsToRename(boolean allow)
```
    Allow participant to rename self
    
    Parameters:
    
    allow - true: allow, false: disallow
    
    Returns:
    
    error MobileRTCSDKError
  - isParticipantsRenameAllowed
```
boolean isParticipantsRenameAllowed()
```
    Query is allow participant to rename self
    
    Returns:
    
    true: allow, false: disallow
  - allowParticipantsToUnmuteSelf
```
MobileRTCSDKError allowParticipantsToUnmuteSelf(boolean allow)
```
    Allow participant to unmute self
    
    Parameters:
    
    allow - true: allow, false: disallow
    
    Returns:
    
    error MobileRTCSDKError
  - isParticipantsUnmuteSelfAllowed
```
boolean isParticipantsUnmuteSelfAllowed()
```
    Query is allow participant to unmute self
    
    Returns:
    
    true: allow, false: disallow

Interface InMeetingService

Method Summary

Method Detail

addListener

removeListener

getInMeetingAudioController

getInMeetingVideoController

getInMeetingShareController

getInMeetingChatController

getInMeetingAnnotationController

getInMeetingCloudRecordController

getInMeetingQAController

getInMeetingWaitingRoomController

getInMeetingRemoteController

getInMeetingLiveStreamController

getInMeetingWebinarController

getInMeetingBOController

isMeetingConnected

isMeetingLocked

lockMeeting

getInMeetingUserCount

changeName

getInMeetingUserList

getMyUserID

getParticipantId

getMyUserInfo

getUserInfoById

makeHost

canReclaimHost

reclaimHost

assignCohost

canbeCohost

revokeCohost

removeUser

setPlayChimeOnOff

isPlayChimeOn

activeShareUserID

isHostUser

isMyself

raiseMyHand

lowerHand

lowerAllHands

isMeetingHost

leaveCurrentMeeting

getCurrentMeetingID

getCurrentMeetingNumber

getCurrentMeetingTopic

getCurrentMeetingUrl

getCurrentMeetingInviteEmailSubject

getCurrentMeetingInviteEmailContent

getE2EMeetingSecureKey

handleE2EMeetingExternalSessionKeyReady

isExternalMeeting

isInternalMeeting

isFailoverMeeting

querySessionNetworkStatus

claimHostWithHostKey

isWebinarMeeting

showZoomParticipantsUI

showZoomQAUI

getMeetingPassword

setMeetingTopic

allowParticipantsToRename

isParticipantsRenameAllowed

allowParticipantsToUnmuteSelf

isParticipantsUnmuteSelfAllowed