us.zoom.sdk

Interface InMeetingAudioController

public interface InMeetingAudioController

Audio controller in meeting.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InMeetingAudioController.MobileRTCMicrophoneError Enumeration of Microphone Errors.

Method Summary

Modifier and Type	Method and Description
boolean	canSwitchAudioOutput() Query if it is able to switch audio output source of the current meeting.
boolean	canUnmuteMyAudio() Query if the user can unmute the audio himself.
MobileRTCSDKError	connectAudioWithVoIP() Connect audio with VoIP while joining a meeting.
MobileRTCSDKError	disconnectAudio() Disconnect the audio.
boolean	getLoudSpeakerStatus() Get the speaker status of the current phone.
boolean	isAudioConnected() Query if the audio of the current user is connected.
boolean	isMuteOnEntryOn() Query if is enabled to mute attendees automatically when they join the meeting.
boolean	isMyAudioMuted() Query if the audio of current user is muted.
MobileRTCSDKError	muteAllAttendeeAudio(boolean allowUnmuteSelf) Mute all attendees by the host.
MobileRTCSDKError	muteAttendeeAudio(boolean isMute, long userId) Mute/unmute the attendee's audio by the host.
MobileRTCSDKError	muteMyAudio(boolean mute) Query if the user can mute the audio himself.
MobileRTCSDKError	setLoudSpeakerStatus(boolean on) Set whether to turn on loud-speaker if it is able to switch audio output source of the current meeting.
MobileRTCSDKError	setMuteOnEntry(boolean on) Set if attendees join the meeting with audio muted.
MobileRTCSDKError	unmuteAllAttendeeAudio() Unmute all by the host.

Method Detail

isMyAudioMuted

boolean isMyAudioMuted()

Query if the audio of current user is muted.

Returns:

TRUE means muted. Otherwise not.

canUnmuteMyAudio

boolean canUnmuteMyAudio()

Query if the user can unmute the audio himself.

Returns:

TRUE means that the current user can unmute the audio himself. Otherwise not.

muteMyAudio

MobileRTCSDKError muteMyAudio(boolean mute)

Query if the user can mute the audio himself.

Parameters:

mute - TRUE means able, FALSE not.

Returns:

If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

isAudioConnected

boolean isAudioConnected()

Query if the audio of the current user is connected.

Returns:

TRUE means connected. Otherwise not.

disconnectAudio

MobileRTCSDKError disconnectAudio()

Disconnect the audio.

Returns:

If the funct0ion succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

connectAudioWithVoIP

MobileRTCSDKError connectAudioWithVoIP()

Connect audio with VoIP while joining a meeting.

Returns:

If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

canSwitchAudioOutput

boolean canSwitchAudioOutput()

Query if it is able to switch audio output source of the current meeting.

Returns:

TRUE means able. Otherwise not.

setLoudSpeakerStatus

MobileRTCSDKError setLoudSpeakerStatus(boolean on)

Set whether to turn on loud-speaker if it is able to switch audio output source of the current meeting.

Parameters:

on - TRUE means to turn on the loud-speaker. FALSE not.

Returns:

If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

getLoudSpeakerStatus

boolean getLoudSpeakerStatus()

Get the speaker status of the current phone.

Returns:

TRUE means the loud-speaker is turned on. Otherwise not.

muteAttendeeAudio

MobileRTCSDKError muteAttendeeAudio(boolean isMute,
                                    long userId)

Mute/unmute the attendee's audio by the host.

Parameters:

isMute - TRUE means to mute the attendee's audio. Otherwise not.

userId - The ID of user to be muted/unmuted in meeting.

Returns:

If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

muteAllAttendeeAudio

MobileRTCSDKError muteAllAttendeeAudio(boolean allowUnmuteSelf)

Mute all attendees by the host.

Parameters:

allowUnmuteSelf - Allow attendee to unmute audio by himself.

Returns:

If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

unmuteAllAttendeeAudio

MobileRTCSDKError unmuteAllAttendeeAudio()

Unmute all by the host.

Returns:

If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

setMuteOnEntry

MobileRTCSDKError setMuteOnEntry(boolean on)

Set if attendees join the meeting with audio muted.

Parameters:

on - The attendees are muted automatically when they join the meeting.

Returns:

If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

isMuteOnEntryOn

boolean isMuteOnEntryOn()

Query if is enabled to mute attendees automatically when they join the meeting.

Returns:

TRUE means enabled. Otherwise not.