us.zoom.sdk.InMeetingAudioController Interface Reference

Audio controller in meeting. More...

Data Structures
enum	MobileRTCMicrophoneError
	Enumeration of Microphone Errors. More...

Public Member Functions
boolean	isMyAudioMuted ()
	Query if the audio of current user is muted.
boolean	canUnmuteMyAudio ()
	Query if the user can unmute the audio himself.
MobileRTCSDKError	muteMyAudio (boolean mute)
	Query if the user can mute the audio himself.
boolean	isAudioConnected ()
	Query if the audio of the current user is connected.
MobileRTCSDKError	disconnectAudio ()
	Disconnect the audio.
MobileRTCSDKError	connectAudioWithVoIP ()
	Connect audio with VoIP while joining a meeting.
boolean	canSwitchAudioOutput ()
	Query if it is able to switch audio output source of the current meeting.
MobileRTCSDKError	setLoudSpeakerStatus (boolean on)
	Set whether to turn on loud-speaker if it is able to switch audio output source of the current meeting.
boolean	getLoudSpeakerStatus ()
	Get the speaker status of the current phone.
MobileRTCSDKError	muteAttendeeAudio (boolean isMute, long userId)
	Mute/unmute the attendee's audio by the host.
MobileRTCSDKError	muteAllAttendeeAudio (boolean allowUnmuteSelf)
	Mute all attendees by the host.
MobileRTCSDKError	unmuteAllAttendeeAudio ()
	Unmute all by the host.
MobileRTCSDKError	setMuteOnEntry (boolean on)
	Set if attendees join the meeting with audio muted.
boolean	isMuteOnEntryOn ()
	Query if is enabled to mute attendees automatically when they join the meeting.
MobileRTCSDKError	stopIncomingAudio (boolean bStop)
	Stop the incoming audio.
boolean	isIncomingAudioStopped ()
	Determine if the incoming audio is stopped.
int	getSupportedMeetingAudioType ()
	Get supported audio types.
boolean	is3rdPartyTelephonyAudioOn ()
	Determine if the meeting has third party telephony audio enabled.
boolean	canEnableMuteOnEntry ()
	Check if the host or cohost can enable mute on entry. Valid for both ZOOM style and user custom interface mode.
MobileRTCSDKError	enableMuteOnEntry (boolean bEnable, boolean allowUnmuteBySelf)
	mute or umute the user after joining the meeting.
boolean	isMuteOnEntryEnabled ()
	Determine if mute on entry is enabled.
MobileRTCRawDataError	enablePlayMeetingAudio (boolean bEnable)
	Enable or disable SDK to play meeting audio.
boolean	isPlayMeetingAudioEnabled ()
	Determine if play meeting audio is enabled or not.

Detailed Description

Audio controller in meeting.

Definition at line 7 of file InMeetingAudioController.java.

Member Function Documentation

canEnableMuteOnEntry()

boolean us.zoom.sdk.InMeetingAudioController.canEnableMuteOnEntry

(

)

Check if the host or cohost can enable mute on entry. Valid for both ZOOM style and user custom interface mode.

Returns

true indicates that the host or cohost can enable mute on entry. Otherwise not.

canSwitchAudioOutput()

boolean us.zoom.sdk.InMeetingAudioController.canSwitchAudioOutput

(

)

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

Returns

TRUE means able. Otherwise not.

canUnmuteMyAudio()

boolean us.zoom.sdk.InMeetingAudioController.canUnmuteMyAudio

(

)

Query if the user can unmute the audio himself.

Returns

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

connectAudioWithVoIP()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.connectAudioWithVoIP

(

)

Connect audio with VoIP while joining a meeting.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

disconnectAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.disconnectAudio

(

)

Disconnect the audio.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

enableMuteOnEntry()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.enableMuteOnEntry	(	boolean	bEnable,
		boolean	allowUnmuteBySelf )

mute or umute the user after joining the meeting.

Parameters

bEnable	true indicates to mute the user after joining the meeting.
allowUnmuteBySelf	allow self unMute

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

enablePlayMeetingAudio()

MobileRTCRawDataError us.zoom.sdk.InMeetingAudioController.enablePlayMeetingAudio

(

boolean

bEnable

)

Enable or disable SDK to play meeting audio.

Parameters

bEnable

true means that SDK will play meeting audio, false means that SDK will not play meeting audio.

Returns

If the function succeeds, it will return MobileRTCRawData_Success. Otherwise failed.

getLoudSpeakerStatus()

boolean us.zoom.sdk.InMeetingAudioController.getLoudSpeakerStatus

(

)

Get the speaker status of the current phone.

Returns

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

getSupportedMeetingAudioType()

int us.zoom.sdk.InMeetingAudioController.getSupportedMeetingAudioType

(

)

Get supported audio types.

Returns

If the function succeeds, it will return the type. The value is the 'bitwise OR' of each supported audio type.InMeetingSupportAudioType

is3rdPartyTelephonyAudioOn()

boolean us.zoom.sdk.InMeetingAudioController.is3rdPartyTelephonyAudioOn

(

)

Determine if the meeting has third party telephony audio enabled.

Returns

true means enabled, otherwise it is not enabled.

isAudioConnected()

boolean us.zoom.sdk.InMeetingAudioController.isAudioConnected

(

)

Query if the audio of the current user is connected.

Returns

TRUE means connected. Otherwise not.

isIncomingAudioStopped()

boolean us.zoom.sdk.InMeetingAudioController.isIncomingAudioStopped

(

)

Determine if the incoming audio is stopped.

Returns

true indicates that the incoming audio is stopped.

isMuteOnEntryEnabled()

boolean us.zoom.sdk.InMeetingAudioController.isMuteOnEntryEnabled

(

)

Determine if mute on entry is enabled.

Returns

true indicates that mute on entry is enabled

isMuteOnEntryOn()

boolean us.zoom.sdk.InMeetingAudioController.isMuteOnEntryOn

(

)

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

Returns

TRUE means enabled. Otherwise not.

isMyAudioMuted()

boolean us.zoom.sdk.InMeetingAudioController.isMyAudioMuted

(

)

Query if the audio of current user is muted.

Returns

TRUE means muted. Otherwise not.

isPlayMeetingAudioEnabled()

boolean us.zoom.sdk.InMeetingAudioController.isPlayMeetingAudioEnabled

(

)

Determine if play meeting audio is enabled or not.

Returns

true means enabled, otherwise it is not enabled.

muteAllAttendeeAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.muteAllAttendeeAudio

(

boolean

allowUnmuteSelf

)

Mute all attendees by the host.

Parameters

allowUnmuteSelf

Allow attendee to unmute audio by himself.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

muteAttendeeAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.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, it will return SDKERR_SUCCESS. Otherwise failed.

muteMyAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.muteMyAudio

(

boolean

mute

)

Query if the user can mute the audio himself.

Parameters

mute	TRUE means able, FALSE not.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

setLoudSpeakerStatus()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.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, it will return SDKERR_SUCCESS. Otherwise failed.

setMuteOnEntry()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.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, it will return SDKERR_SUCCESS. Otherwise failed.

stopIncomingAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.stopIncomingAudio

(

boolean

bStop

)

Stop the incoming audio.

Parameters

bStop

Ture means stop

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

unmuteAllAttendeeAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.unmuteAllAttendeeAudio

(

)

Unmute all by the host.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.