ZMVideoSDKAudioHelper Class Reference

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

#include <ZMVideoSDKAudioHelper.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- startAudio
	Starts audio with voip.
(ZMVideoSDKErrors)	- stopAudio
	Stops audio.
(ZMVideoSDKErrors)	- muteAudio:
	Mutes user's voip audio. 0 means current user (myself).
(ZMVideoSDKErrors)	- unMuteAudio:
	UnMute user's voip audio.
(ZMVideoSDKErrors)	- allowAudioUnmutedBySelf:
	Allows the others to unmute themselves or not. For host or manager.
(ZMVideoSDKErrors)	- muteAllAudio:
	Mutes all user's VIOP audio except my self.
(ZMVideoSDKErrors)	- unmuteAllAudio
	Ask to unmute all user's VOIP audio.
(NSArray< ZMVideoSDKSpeakerDevice * > *_Nullable)	- getSpeakerList
	Gets speaker device list.
(NSArray< ZMVideoSDKMicDevice * > *_Nullable)	- getMicList
	Gets 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
	Subscribes 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

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

Parameters

allowUnmute

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

Returns

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

getMicList

- (NSArray< ZMVideoSDKMicDevice * > *_Nullable) getMicList

Gets mic device list.

Returns

If the function succeeds, it returns mic device list. Otherwise, this function fails and returns nil.

References getMicList.

Referenced by getMicList.

getSpeakerList

- (NSArray< ZMVideoSDKSpeakerDevice * > *_Nullable) getSpeakerList

Gets speaker device list.

Returns

If the function succeeds, it returns speaker device list. Otherwise, this function fails and returns nil.

References getSpeakerList.

Referenced by getSpeakerList.

muteAllAudio:

- (ZMVideoSDKErrors) muteAllAudio:

(BOOL)

allowUnmute

Mutes all user's VIOP audio except my self.

Parameters

allowUnmute

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

Returns

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

muteAudio:

- (ZMVideoSDKErrors) muteAudio:

(ZMVideoSDKUser *)

user

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

Parameters

user	The pointer of user object.

Returns

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

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 returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

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 returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

startAudio

- (ZMVideoSDKErrors) startAudio

Starts audio with voip.

Returns

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

References startAudio.

Referenced by startAudio.

stopAudio

- (ZMVideoSDKErrors) stopAudio

Stops audio.

Returns

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

References stopAudio.

Referenced by stopAudio.

subscribe

- (ZMVideoSDKErrors) subscribe

Subscribes audio raw data.

Returns

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

References subscribe.

Referenced by subscribe.

unmuteAllAudio

- (ZMVideoSDKErrors) unmuteAllAudio

Ask to unmute all user's VOIP audio.

Returns

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

References unmuteAllAudio.

Referenced by unmuteAllAudio.

unMuteAudio:

- (ZMVideoSDKErrors) unMuteAudio:

(ZMVideoSDKUser *)

user

UnMute user's voip audio.

Parameters

user	The pointer of user object.

Returns

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

unSubscribe

- (ZMVideoSDKErrors) unSubscribe

UnSubscribe audio raw data.

Returns

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

References unSubscribe.

Referenced by unSubscribe.