MobileRTCMeetingService(Audio) Category Reference

Instance Methods
(MobileRTCAudioType)	- myAudioType
	Get the in-meeting audio type of the current user. More...
(BOOL)	- connectMyAudio:
	Set whether to connect the audio in the meeting. More...
(MobileRTCAudioOutput)	- myAudioOutputDescription
	Set to retrieve the audio output type of the current user. More...
(BOOL)	- isMyAudioMuted
	Query if the audio of the current user is muted. More...
(BOOL)	- canUnmuteMyAudio
	Query if the user can unmute his audio. More...
(BOOL)	- isMuteOnEntryOn
	Query if is enabled to mute attendees when they join the meeting. More...
(BOOL)	- muteOnEntry:
	Set if attendees join the meeting with audio muted. More...
(BOOL)	- isUserAudioMuted:
	Query if the user's audio is muted. More...
(BOOL)	- muteUserAudio:withUID:
	Set whether to mute user's audio. More...
(BOOL)	- muteAllUserAudio:
	Set to mute audio of all attendees. More...
(BOOL)	- askAllToUnmute
	Ask to unmute audio of all attendees. More...
(BOOL)	- isSupportedVOIP
	Query if the meeting supports VoIP. More...
(BOOL)	- isPlayChimeOn
	Query if chime is enabled when user joins/leaves meeting. More...
(BOOL)	- playChime:
	Set whether chime are enabled when the user joins/leaves meeting. More...
(MobileRTCAudioError)	- muteMyAudio:
	Set to mute the audio of the current user. More...
(MobileRTCAudioError)	- switchMyAudioSource
	Set to switch audio source of the current user.
(void)	- resetMeetingAudioSession
	Reset Meeting Audio Session including Category and Mode.
(void)	- resetMeetingAudioForCallKitHeld
	Reset Meeting Audio Session including Category and Mode. When the call comes in or goes out, click hold or swap in the dial-up UI to restore the zoom sound.

Method Documentation

askAllToUnmute()

- (BOOL) askAllToUnmute

Ask to unmute audio of all attendees.

Returns

YES means that the method is called successfully, otherwise not.

Warning

Only meeting host can run the function.

Extends class MobileRTCMeetingService.

canUnmuteMyAudio()

- (BOOL) canUnmuteMyAudio

Query if the user can unmute his audio.

Returns

YES means that he can unmute his audio, otherwise not.

Extends class MobileRTCMeetingService.

connectMyAudio:()

- (BOOL) connectMyAudio:

(BOOL)

on

Set whether to connect the audio in the meeting.

Parameters

on	YES means to connect, otherwise not.

Returns

YES means that the method is called successfully, otherwise not.

Extends class MobileRTCMeetingService.

isMuteOnEntryOn()

- (BOOL) isMuteOnEntryOn

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

Returns

YES means enabled, otherwise not.

Extends class MobileRTCMeetingService.

isMyAudioMuted()

- (BOOL) isMyAudioMuted

Query if the audio of the current user is muted.

Returns

YES means muted, otherwise not.

Extends class MobileRTCMeetingService.

isPlayChimeOn()

- (BOOL) isPlayChimeOn

Query if chime is enabled when user joins/leaves meeting.

Returns

YES means enabled, otherwise not.

Extends class MobileRTCMeetingService.

isSupportedVOIP()

- (BOOL) isSupportedVOIP

Query if the meeting supports VoIP.

Returns

YES means supported, otherwise not.

Extends class MobileRTCMeetingService.

isUserAudioMuted:()

- (BOOL) isUserAudioMuted:

(NSUInteger)

userID

Query if the user's audio is muted.

Parameters

userID

The ID of user to be checked.

Returns

YES means muted, otherwise not.

Extends class MobileRTCMeetingService.

muteAllUserAudio:()

- (BOOL) muteAllUserAudio:

(BOOL)

allowSelfUnmute

Set to mute audio of all attendees.

Parameters

allowSelfUnmute

YES means that attendee can unmute the audio himself, otherwise not.

Returns

YES means that the method is called successfully, otherwise not.

Warning

Only meeting host can run the function.

Extends class MobileRTCMeetingService.

muteMyAudio:()

- (MobileRTCAudioError) muteMyAudio:

(BOOL)

mute

Set to mute the audio of the current user.

Parameters

mute	YES means the audio is muted, otherwise not.

Returns

The result of operation, muted or not.

Extends class MobileRTCMeetingService.

muteOnEntry:()

- (BOOL) muteOnEntry:

(BOOL)

on

Set if attendees join the meeting with audio muted.

Returns

YES means muted, otherwise not.

Warning

Only meeting host can run the function.

Extends class MobileRTCMeetingService.

muteUserAudio:withUID:()

- (BOOL) muteUserAudio:		(BOOL)	mute
withUID:		(NSUInteger)	userID

Set whether to mute user's audio.

Parameters

mute	YES means to mute, otherwise not.
userID	The ID of user.

Returns

YES means that the method is called successfully, otherwise not.

Warning

Only meeting host can run the function.

Extends class MobileRTCMeetingService.

myAudioOutputDescription()

- (MobileRTCAudioOutput) myAudioOutputDescription

Set to retrieve the audio output type of the current user.

Returns

The descriptions of audio output types.

Extends class MobileRTCMeetingService.

myAudioType()

- (MobileRTCAudioType) myAudioType

Get the in-meeting audio type of the current user.

Returns

The audio type.

Extends class MobileRTCMeetingService.

playChime:()

- (BOOL) playChime:

(BOOL)

on

Set whether chime are enabled when the user joins/leaves meeting.

Returns

YES means enabled, otherwise not.

Warning

Only meeting host/cohost can run the function when in meeting.

Extends class MobileRTCMeetingService.

---

The documentation for this category was generated from the following file:

• MobileRTCMeetingService+Audio.h