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 ()
	Determines whether the current user's audio is muted.
boolean	canUnmuteMyAudio ()
	Determines whether the user can unmute their audio.
MobileRTCSDKError	muteMyAudio (boolean mute)
	Mutes or unmutes the user's audio.
boolean	isAudioConnected ()
	Determines whether the current user's audio is connected.
MobileRTCSDKError	disconnectAudio ()
	Disconnects the audio.
MobileRTCSDKError	connectAudioWithVoIP ()
	Connects audio with VoIP while joining a meeting.
boolean	canSwitchAudioOutput ()
	Determines whether it is able to switch audio output source of the current meeting.
MobileRTCSDKError	setLoudSpeakerStatus (boolean on)
	Sets whether to turn on the loudspeaker if it is able to switch audio output source of the current meeting.
boolean	getLoudSpeakerStatus ()
	Gets the loudspeaker status of the current phone.
MobileRTCSDKError	muteAttendeeAudio (boolean isMute, long userId)
	Mutes or unmutes the attendee's audio by the host.
MobileRTCSDKError	muteAllAttendeeAudio (boolean allowUnmuteSelf)
	Mutes all attendees by the host.
MobileRTCSDKError	unmuteAllAttendeeAudio ()
	Unmutes all attendees by the host.
MobileRTCSDKError	setMuteOnEntry (boolean on)
	Sets whether attendees join the meeting with audio muted.
boolean	isMuteOnEntryOn ()
	Determines whether it is enabled to mute attendees automatically when they join the meeting.
MobileRTCSDKError	stopIncomingAudio (boolean bStop)
	Stops the incoming audio.
boolean	isIncomingAudioStopped ()
	Determines whether the incoming audio is stopped.
int	getSupportedMeetingAudioType ()
	Gets supported audio types.
boolean	is3rdPartyTelephonyAudioOn ()
	Determines whether the meeting has third-party telephony audio enabled.
boolean	canEnableMuteOnEntry ()
	Determines whether 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)
	Mutes or unmutes the user after joining the meeting.
boolean	isMuteOnEntryEnabled ()
	Determines whether mute on entry is enabled.
MobileRTCRawDataError	enablePlayMeetingAudio (boolean bEnable)
	Enables or disables SDK to play meeting audio.
boolean	isPlayMeetingAudioEnabled ()
	Determines whether play meeting audio is enabled.
MobileRTCAudioStatisticInfo	getMeetingAudioStatisticInfo ()
	Gets meeting audio statistics information.

Detailed Description

Audio controller in meeting.

Definition at line 6 of file InMeetingAudioController.java.

Member Function Documentation

canEnableMuteOnEntry()

boolean us.zoom.sdk.InMeetingAudioController.canEnableMuteOnEntry

(

)

Determines whether the host or cohost can enable mute on entry. Valid for both Zoom style and user custom interface mode.

Returns

true if the host or cohost can enable mute on entry. Otherwise, false.

canSwitchAudioOutput()

boolean us.zoom.sdk.InMeetingAudioController.canSwitchAudioOutput

(

)

Determines whether it is able to switch audio output source of the current meeting.

Returns

true if it is able to switch. Otherwise, false.

canUnmuteMyAudio()

boolean us.zoom.sdk.InMeetingAudioController.canUnmuteMyAudio

(

)

Determines whether the user can unmute their audio.

Returns

true if the current user can unmute their audio. Otherwise, false.

connectAudioWithVoIP()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.connectAudioWithVoIP

(

)

Connects audio with VoIP while joining a meeting.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

disconnectAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.disconnectAudio

(

)

Disconnects the audio.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

enableMuteOnEntry()

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

Mutes or unmutes the user after joining the meeting.

Parameters

bEnable	true to mute the user after joining the meeting, false otherwise.
allowUnmuteBySelf	true to allow self-unmute, false otherwise.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

enablePlayMeetingAudio()

MobileRTCRawDataError us.zoom.sdk.InMeetingAudioController.enablePlayMeetingAudio

(

boolean

bEnable

)

Enables or disables 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 returns MobileRTCRawDataError.SDKRawDataError_SUCCESS. Otherwise, this function returns an error.

getLoudSpeakerStatus()

boolean us.zoom.sdk.InMeetingAudioController.getLoudSpeakerStatus

(

)

Gets the loudspeaker status of the current phone.

Returns

true if the loudspeaker is turned on. Otherwise, false.

getMeetingAudioStatisticInfo()

MobileRTCAudioStatisticInfo us.zoom.sdk.InMeetingAudioController.getMeetingAudioStatisticInfo

(

)

Gets meeting audio statistics information.

Returns

If the function succeeds, it returns a MobileRTCAudioStatisticInfo instance containing audio stats. Otherwise, this function fails and returns null if there is no ongoing meeting or if data is unavailable.

getSupportedMeetingAudioType()

int us.zoom.sdk.InMeetingAudioController.getSupportedMeetingAudioType

(

)

Gets supported audio types.

Returns

If the function succeeds, it returns the type. The value is the bitwise OR of each supported audio type. Otherwise, this function fails and returns 0.

is3rdPartyTelephonyAudioOn()

boolean us.zoom.sdk.InMeetingAudioController.is3rdPartyTelephonyAudioOn

(

)

Determines whether the meeting has third-party telephony audio enabled.

Returns

true if third-party telephony audio is enabled. Otherwise, false.

isAudioConnected()

boolean us.zoom.sdk.InMeetingAudioController.isAudioConnected

(

)

Determines whether the current user's audio is connected.

Returns

true if the audio is connected. Otherwise, false.

isIncomingAudioStopped()

boolean us.zoom.sdk.InMeetingAudioController.isIncomingAudioStopped

(

)

Determines whether the incoming audio is stopped.

Returns

true if the incoming audio is stopped. Otherwise, false.

isMuteOnEntryEnabled()

boolean us.zoom.sdk.InMeetingAudioController.isMuteOnEntryEnabled

(

)

Determines whether mute on entry is enabled.

Returns

true if mute on entry is enabled. Otherwise, false.

isMuteOnEntryOn()

boolean us.zoom.sdk.InMeetingAudioController.isMuteOnEntryOn

(

)

Determines whether it is enabled to mute attendees automatically when they join the meeting.

Returns

true if the feature is enabled. Otherwise, false.

isMyAudioMuted()

boolean us.zoom.sdk.InMeetingAudioController.isMyAudioMuted

(

)

Determines whether the current user's audio is muted.

Returns

true if the audio is muted. Otherwise, false.

isPlayMeetingAudioEnabled()

boolean us.zoom.sdk.InMeetingAudioController.isPlayMeetingAudioEnabled

(

)

Determines whether play meeting audio is enabled.

Returns

true if the feature is enabled. Otherwise, false.

muteAllAttendeeAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.muteAllAttendeeAudio

(

boolean

allowUnmuteSelf

)

Mutes all attendees by the host.

Parameters

allowUnmuteSelf

true to allow attendees to unmute their audio, false otherwise.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

muteAttendeeAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.muteAttendeeAudio	(	boolean	isMute,
		long	userId )

Mutes or unmutes the attendee's audio by the host.

Parameters

isMute	true to mute the attendee's audio, false to unmute.
userId	The user's ID to be muted or unmuted in the meeting.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

muteMyAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.muteMyAudio

(

boolean

mute

)

Mutes or unmutes the user's audio.

Parameters

mute	true to mute, false to unmute.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

setLoudSpeakerStatus()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.setLoudSpeakerStatus

(

boolean

on

)

Sets whether to turn on the loudspeaker if it is able to switch audio output source of the current meeting.

Parameters

on	true to turn on the loudspeaker, false otherwise.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

setMuteOnEntry()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.setMuteOnEntry

(

boolean

on

)

Sets whether attendees join the meeting with audio muted.

Parameters

on	true to mute attendees automatically when they join the meeting, false otherwise.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

stopIncomingAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.stopIncomingAudio

(

boolean

bStop

)

Stops the incoming audio.

Parameters

bStop

true to stop, false otherwise.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

unmuteAllAttendeeAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingAudioController.unmuteAllAttendeeAudio

(

)

Unmutes all attendees by the host.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.