InMeetingServiceListener (Zoom.us SDK API Document)

All Superinterfaces:

us.zoom.androidlib.util.IListener
```
public interface InMeetingServiceListener
extends us.zoom.androidlib.util.IListener
```
Zoom service listener in meeting.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class InMeetingServiceListener.AudioStatus

static class InMeetingServiceListener.VideoStatus

Nested Classes
Modifier and Type	Interface and Description
`static class`	`InMeetingServiceListener.AudioStatus`
`static class`	`InMeetingServiceListener.VideoStatus`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`onActiveSpeakerVideoUserChanged(long userId)` Sink the event that the speaker of the active user changes.
`void`	`onActiveVideoUserChanged(long userId)` Sink the event that the video of the active user changes.
`void`	`onChatMessageReceived(InMeetingChatMessage msg)` Sink the event that a new chat message is received.
`void`	`onFreeMeetingNeedToUpgrade(FreeMeetingNeedUpgradeType type, java.lang.String giftUrl)` The callback of upgrading the free meeting.
`void`	`onFreeMeetingReminder(boolean isHost, boolean canUpgrade, boolean isFirstGift)` Inform user that free meeting will be ended in 10 minutes.
`void`	`onFreeMeetingUpgradeToGiftFreeTrialStart()` Callback function of starting to upgrade the free meeting by the gift link.
`void`	`onFreeMeetingUpgradeToGiftFreeTrialStop()` Callback function of ending upgrade the free meeting by the gift link.
`void`	`onFreeMeetingUpgradeToProMeeting()` Callback function of free meting upgrades successfully.
`void`	`onHostAskStartVideo(long userId)` Sink the event that host ask unmute user's video.
`void`	`onHostAskUnMute(long userId)` Sink the event that host ask unmute user's audio.
`void`	`onJoinWebinarNeedUserNameAndEmail(InMeetingEventHandler handler)` The function will be invoked when a user joins a webinar that needs username and email.
`void`	`onLowOrRaiseHandStatusChanged(long userId, boolean isRaiseHand)` Sink the event that the hand status changes.
`void`	`onMeetingActiveVideo(long userId)` Sink the event that Active video user changed .
`void`	`onMeetingCoHostChanged(long userId)` Sink the event that meeting co-host changes.
`void`	`onMeetingFail(int errorCode, int internalErrorCode)` Sink the event of meeting starts failed or user joins meeting failed
`void`	`onMeetingHostChanged(long userId)` Sink the event that the host of meeting changes.
`void`	`onMeetingLeaveComplete(long ret)` Sink the event that user has left meeting.
`void`	`onMeetingNeedColseOtherMeeting(InMeetingEventHandler handler)` Sink the event that it is needed to close another ongoing meeting.
`void`	`onMeetingNeedPasswordOrDisplayName(boolean needPassword, boolean needDisplayName, InMeetingEventHandler handler)` Sink the event if the meeting needs a password or a screen name.
`void`	`onMeetingSecureKeyNotification(byte[] key)` Sink the event that meeting needs session key.
`void`	`onMeetingUserJoin(java.util.List<java.lang.Long> userList)` Sink the event of a new user joins the meeting.
`void`	`onMeetingUserLeave(java.util.List<java.lang.Long> userList)` Sink the event that user leaves the meeting.
`void`	`onMeetingUserUpdated(long userId)` Sink the event that user's information in the meeting is upgraded.
`void`	`onMicrophoneStatusError(InMeetingAudioController.MobileRTCMicrophoneError error)` Sink the event of user's microphone errors.
`void`	`onMyAudioSourceTypeChanged(int type)` Sink the event that the output type of the current user's audio source changes.
`void`	`onSilentModeChanged(boolean inSilentMode)` user silent mode change callback
`void`	`onSinkAllowAttendeeChatNotification(int privilege)` The function will be invoked when the chat privilege of attendees changes.
`void`	`onSinkAttendeeChatPriviledgeChanged(int privilege)` The function will be invoked when the chat privilege of attendees changes.
`void`	`onSpotlightVideoChanged(boolean on)` Sink the event that the user video spotlight status changes.
`void`	`onUserAudioStatusChanged(long userId)` Deprecated. replace with `onUserAudioStatusChanged(long)`
`void`	`onUserAudioStatusChanged(long userId, InMeetingServiceListener.AudioStatus audioStatus)` Sink the event that user's audio status changes.
`void`	`onUserAudioTypeChanged(long userId)` Sink the event that user's audio type changes.
`void`	`onUserNameChanged(long userId, java.lang.String name)` Sink the event that user name changed .
`void`	`onUserNetworkQualityChanged(long userId)` Sink the event that user's network quality changes.
`void`	`onUserVideoStatusChanged(long userId)` Deprecated. replace with `onUserVideoStatusChanged(long, VideoStatus)`
`void`	`onUserVideoStatusChanged(long userId, InMeetingServiceListener.VideoStatus status)` Sink the event that user's video status changes.
`void`	`onWebinarNeedRegister()` During the webinar, this callback event will be triggered if the user needs to register.

- Method Detail
  - onMeetingNeedPasswordOrDisplayName
```
void onMeetingNeedPasswordOrDisplayName(boolean needPassword,
                                        boolean needDisplayName,
                                        InMeetingEventHandler handler)
```
    Sink the event if the meeting needs a password or a screen name.
    
    Parameters:
    
    needPassword - TRUE means that the password is needed. FALSE not.
    
    needDisplayName - TRUE means that the screen name is needed. FALSE not.
    
    handler - This handler provides an interface to set password and name. The interface will be called once the user received the callback event.
  - onWebinarNeedRegister
```
void onWebinarNeedRegister()
```
    During the webinar, this callback event will be triggered if the user needs to register.
  - onJoinWebinarNeedUserNameAndEmail
```
void onJoinWebinarNeedUserNameAndEmail(InMeetingEventHandler handler)
```
    The function will be invoked when a user joins a webinar that needs username and email.
    
    Parameters:
    
    handler - Configure information or leave meeting via InMeetingEventHandler.setRegisterWebinarInfo(String, String, boolean).
  - onMeetingNeedColseOtherMeeting
```
void onMeetingNeedColseOtherMeeting(InMeetingEventHandler handler)
```
    Sink the event that it is needed to close another ongoing meeting. A meeting is running on server, you need to close it before you can start a new one.
    
    Parameters:
    
    handler - End the meeting via InMeetingEventHandler.endOtherMeeting().
  - onMeetingFail
```
void onMeetingFail(int errorCode,
                   int internalErrorCode)
```
    Sink the event of meeting starts failed or user joins meeting failed
    
    Parameters:
    
    errorCode - Meeting errors.MeetingError
    
    internalErrorCode - Internal error code.
  - onMeetingLeaveComplete
```
void onMeetingLeaveComplete(long ret)
```
    Sink the event that user has left meeting.
    
    Parameters:
    
    ret - Reasons for leaving meeting defined in MeetingEndReason.
  - onMeetingUserJoin
```
void onMeetingUserJoin(java.util.List<java.lang.Long> userList)
```
    Sink the event of a new user joins the meeting.
    
    Parameters:
    
    userList - The list of user ID.
  - onMeetingUserLeave
```
void onMeetingUserLeave(java.util.List<java.lang.Long> userList)
```
    Sink the event that user leaves the meeting.
    
    Parameters:
    
    userList - The list of user ID.
  - onMeetingUserUpdated
```
void onMeetingUserUpdated(long userId)
```
    Sink the event that user's information in the meeting is upgraded.
    
    Parameters:
    
    userId - User ID.
  - onMeetingHostChanged
```
void onMeetingHostChanged(long userId)
```
    Sink the event that the host of meeting changes.
    
    Parameters:
    
    userId - The ID of user to be the host.
  - onMeetingCoHostChanged
```
void onMeetingCoHostChanged(long userId)
```
    Sink the event that meeting co-host changes.
    
    Parameters:
    
    userId - The ID of user to be co-host.
  - onActiveVideoUserChanged
```
void onActiveVideoUserChanged(long userId)
```
    Sink the event that the video of the active user changes.
    
    Parameters:
    
    userId - The ID of active user.
  - onActiveSpeakerVideoUserChanged
```
void onActiveSpeakerVideoUserChanged(long userId)
```
    Sink the event that the speaker of the active user changes.
    
    Parameters:
    
    userId - The ID of active user.
  - onSpotlightVideoChanged
```
void onSpotlightVideoChanged(boolean on)
```
    Sink the event that the user video spotlight status changes.
    
    Parameters:
    
    on - TRUE means that spotlight mode is on, otherwise not.
  - onUserVideoStatusChanged
```
void onUserVideoStatusChanged(long userId)
```
    Deprecated. replace with onUserVideoStatusChanged(long, VideoStatus)
    
    Sink the event that user's video status changes.
    
    Parameters:
    
    userId - The user ID.
  - onUserVideoStatusChanged
```
void onUserVideoStatusChanged(long userId,
                              InMeetingServiceListener.VideoStatus status)
```
    Sink the event that user's video status changes.
    
    Parameters:
    
    userId - The user ID.
    
    status - current status.
  - onUserNetworkQualityChanged
```
void onUserNetworkQualityChanged(long userId)
```
    Sink the event that user's network quality changes.
    
    Parameters:
    
    userId - The user ID.
  - onMicrophoneStatusError
```
void onMicrophoneStatusError(InMeetingAudioController.MobileRTCMicrophoneError error)
```
    Sink the event of user's microphone errors.
    
    Parameters:
    
    error - Error types defined in InMeetingAudioController.MobileRTCMicrophoneError.
  - onUserAudioStatusChanged
```
void onUserAudioStatusChanged(long userId)
```
    Deprecated. replace with onUserAudioStatusChanged(long)
    
    Sink the event that user's audio status changes.
    
    Parameters:
    
    userId - The user ID.
  - onUserAudioStatusChanged
```
void onUserAudioStatusChanged(long userId,
                              InMeetingServiceListener.AudioStatus audioStatus)
```
    Sink the event that user's audio status changes.
    
    Parameters:
    
    userId - The user ID.
    
    audioStatus - InMeetingServiceListener.AudioStatus
  - onHostAskUnMute
```
void onHostAskUnMute(long userId)
```
    Sink the event that host ask unmute user's audio.
    
    Parameters:
    
    userId - The user ID.
  - onHostAskStartVideo
```
void onHostAskStartVideo(long userId)
```
    Sink the event that host ask unmute user's video.
    
    Parameters:
    
    userId - The user ID.
  - onUserAudioTypeChanged
```
void onUserAudioTypeChanged(long userId)
```
    Sink the event that user's audio type changes.
    
    Parameters:
    
    userId - The user ID.
  - onMyAudioSourceTypeChanged
```
void onMyAudioSourceTypeChanged(int type)
```
    Sink the event that the output type of the current user's audio source changes.
    
    Parameters:
    
    type - Audio types defined in AudioSourceType.
  - onLowOrRaiseHandStatusChanged
```
void onLowOrRaiseHandStatusChanged(long userId,
                                   boolean isRaiseHand)
```
    Sink the event that the hand status changes.
    
    Parameters:
    
    userId - The user ID.
    
    isRaiseHand - TRUE means raising hands. FALSE put hands down.
  - onMeetingSecureKeyNotification
```
void onMeetingSecureKeyNotification(byte[] key)
```
    Sink the event that meeting needs session key.
    
    Parameters:
    
    key - The key currently in use.
  - onChatMessageReceived
```
void onChatMessageReceived(InMeetingChatMessage msg)
```
    Sink the event that a new chat message is received.
    
    Parameters:
    
    msg - The message object.
  - onSilentModeChanged
```
void onSilentModeChanged(boolean inSilentMode)
```
    user silent mode change callback
    
    Parameters:
    
    inSilentMode - True is in silent mode
  - onFreeMeetingReminder
```
void onFreeMeetingReminder(boolean isHost,
                           boolean canUpgrade,
                           boolean isFirstGift)
```
    Inform user that free meeting will be ended in 10 minutes.
    
    Parameters:
    
    isHost - True means the original host of the current meeting, otherwise not.
    
    canUpgrade - True means the current meeting can be upgraded.
    
    isFirstGift - True means we will upgrade this free meeting automatically.
  - onMeetingActiveVideo
```
void onMeetingActiveVideo(long userId)
```
    Sink the event that Active video user changed .
    
    Parameters:
    
    userId - The user ID.
  - onSinkAttendeeChatPriviledgeChanged
```
void onSinkAttendeeChatPriviledgeChanged(int privilege)
```
    The function will be invoked when the chat privilege of attendees changes. only NORMAL MEETING(non webinar meeting) can get the callback.
    
    Parameters:
    
    privilege - current privilege The chat privilege of the current attendee.
  - onSinkAllowAttendeeChatNotification
```
void onSinkAllowAttendeeChatNotification(int privilege)
```
    The function will be invoked when the chat privilege of attendees changes. only WEBINAR meeting can get the callback.
    
    Parameters:
    
    privilege - current privilege The chat privilege of the current attendee.
  - onUserNameChanged
```
void onUserNameChanged(long userId,
                       java.lang.String name)
```
    Sink the event that user name changed .
    
    Parameters:
    
    userId - The user ID.
    
    name - The new name
  - onFreeMeetingNeedToUpgrade
```
void onFreeMeetingNeedToUpgrade(FreeMeetingNeedUpgradeType type,
                                java.lang.String giftUrl)
```
    The callback of upgrading the free meeting.
    
    Parameters:
    
    type - Type of upgrading the free meeting,FreeMeetingNeedUpgradeType
    
    giftUrl - Upgrade the free meeting by the gift link. When and only when the value of type_ is FreeMeetingNeedUpgradeType_BY_GIFTURL, this parameter is meaningful
  - onFreeMeetingUpgradeToGiftFreeTrialStart
```
void onFreeMeetingUpgradeToGiftFreeTrialStart()
```
    Callback function of starting to upgrade the free meeting by the gift link.
  - onFreeMeetingUpgradeToGiftFreeTrialStop
```
void onFreeMeetingUpgradeToGiftFreeTrialStop()
```
    Callback function of ending upgrade the free meeting by the gift link.
  - onFreeMeetingUpgradeToProMeeting
```
void onFreeMeetingUpgradeToProMeeting()
```
    Callback function of free meting upgrades successfully.

Interface InMeetingServiceListener

Nested Class Summary

Method Summary

Method Detail

onMeetingNeedPasswordOrDisplayName

onWebinarNeedRegister

onJoinWebinarNeedUserNameAndEmail

onMeetingNeedColseOtherMeeting

onMeetingFail

onMeetingLeaveComplete

onMeetingUserJoin

onMeetingUserLeave

onMeetingUserUpdated

onMeetingHostChanged

onMeetingCoHostChanged

onActiveVideoUserChanged

onActiveSpeakerVideoUserChanged

onSpotlightVideoChanged

onUserVideoStatusChanged

onUserVideoStatusChanged

onUserNetworkQualityChanged

onMicrophoneStatusError

onUserAudioStatusChanged

onUserAudioStatusChanged

onHostAskUnMute

onHostAskStartVideo

onUserAudioTypeChanged

onMyAudioSourceTypeChanged

onLowOrRaiseHandStatusChanged

onMeetingSecureKeyNotification

onChatMessageReceived

onSilentModeChanged

onFreeMeetingReminder

onMeetingActiveVideo

onSinkAttendeeChatPriviledgeChanged

onSinkAllowAttendeeChatNotification

onUserNameChanged

onFreeMeetingNeedToUpgrade

onFreeMeetingUpgradeToGiftFreeTrialStart

onFreeMeetingUpgradeToGiftFreeTrialStop

onFreeMeetingUpgradeToProMeeting