ZMVideoSDKAudioHelper Class Reference

Provides methods for managing audio in Zoom Video SDK sessions. More...

#include <ZMVideoSDKAudioHelper.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- startAudio
	Start audio with voip.
(ZMVideoSDKErrors)	- stopAudio
	Stop audio.
(ZMVideoSDKErrors)	- muteAudio:
	Mute user's voip audio. 0 means current user (myself).
(ZMVideoSDKErrors)	- unMuteAudio:
	UnMute user's voip audio.
(ZMVideoSDKErrors)	- allowAudioUnmutedBySelf:
	Allow the others to unmute themselves or not. For host or manager.
(ZMVideoSDKErrors)	- muteAllAudio:
	Mute all user's VIOP audio except my self.
(ZMVideoSDKErrors)	- unmuteAllAudio
	Ask to unmute all user's VOIP audio.
(NSArray< ZMVideoSDKSpeakerDevice * > *_Nullable)	- getSpeakerList
	Get speaker device list.
(NSArray< ZMVideoSDKMicDevice * > *_Nullable)	- getMicList
	Get mic device list.
(ZMVideoSDKErrors)	- selectSpeaker:deviceName:
	Select one speaker device as default device.
(ZMVideoSDKErrors)	- selectMic:deviceName:
	Select one mic device as default device.
(ZMVideoSDKErrors)	- subscribe
	Subscribe audio raw data.
(ZMVideoSDKErrors)	- unSubscribe
	UnSubscribe audio raw data.

Detailed Description

Provides methods for managing audio in Zoom Video SDK sessions.

Definition at line 112 of file ZMVideoSDKAudioHelper.h.

Method Documentation

allowAudioUnmutedBySelf:

- (ZMVideoSDKErrors) allowAudioUnmutedBySelf:

(BOOL)

allowUnmute

Allow the others to unmute themselves or not. For host or manager.

Parameters

allowUnmute

Yes means allow the user to unmute themself, otherwise NO.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

getMicList

- (NSArray< ZMVideoSDKMicDevice * > *_Nullable) getMicList

Get mic device list.

Returns

If the function succeeds, the return value is mic device list, otherwise returns nil.

getSpeakerList

- (NSArray< ZMVideoSDKSpeakerDevice * > *_Nullable) getSpeakerList

Get speaker device list.

Returns

If the function succeeds, the return value is speaker device list, otherwise returns nil.

muteAllAudio:

- (ZMVideoSDKErrors) muteAllAudio:

(BOOL)

allowUnmute

Mute all user's VIOP audio except my self.

Parameters

allowUnmute

Yes means means allow the user to unmute themself, otherwise NO.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

muteAudio:

- (ZMVideoSDKErrors) muteAudio:

(ZMVideoSDKUser *)

user

Mute user's voip audio. 0 means current user (myself).

Parameters

user	The pointer of user object.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

selectMic:deviceName:

- (ZMVideoSDKErrors) selectMic:		(NSString *)	deviceId
deviceName:		(NSString *)	name

Select one mic device as default device.

Parameters

deviceId	Device id.
name	Device name.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

selectSpeaker:deviceName:

- (ZMVideoSDKErrors) selectSpeaker:		(NSString *)	deviceId
deviceName:		(NSString *)	name

Select one speaker device as default device.

Parameters

deviceId	Device id.
name	Device name.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

startAudio

- (ZMVideoSDKErrors) startAudio

Start audio with voip.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

stopAudio

- (ZMVideoSDKErrors) stopAudio

Stop audio.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

subscribe

- (ZMVideoSDKErrors) subscribe

Subscribe audio raw data.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

unmuteAllAudio

- (ZMVideoSDKErrors) unmuteAllAudio

Ask to unmute all user's VOIP audio.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

unMuteAudio:

- (ZMVideoSDKErrors) unMuteAudio:

(ZMVideoSDKUser *)

user

UnMute user's voip audio.

Parameters

user	The pointer of user object.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

unSubscribe

- (ZMVideoSDKErrors) unSubscribe

UnSubscribe audio raw data.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.