A class to operate the audio action. More...

#include <ZoomVideoSDKAudioHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- startAudio
	Start audio.

(ZoomVideoSDKError)	- stopAudio
	Stop audio.

(ZoomVideoSDKError)	- muteAudio:
	Mute user's audio.

(ZoomVideoSDKError)	- unmuteAudio:
	Ask unmute user's audio.

(ZoomVideoSDKError)	- muteAllAudio:
	Mute all user's VOIP audio except my self.

(ZoomVideoSDKError)	- allowAudioUnmutedBySelf:
	Allow the others to unmute themselves or not.

(ZoomVideoSDKError)	- unmuteAllAudio
	Ask unmute all user's VOIP audio.

(ZoomVideoSDKError)	- subscribe
	Call the function to subscribe audio rawdata.

(ZoomVideoSDKError)	- unSubscribe
	Call the function to unSubscribe audio rawdata.

(BOOL)	- resetAudioSession
	Reset Audio Session including Category and Mode for ZoomVideoSDK Audio Session Environment When developer change audio session in session.

(BOOL)	- setSDKAudioSessionEnv
	Set the AVAudio Session Environment for Zoom Video SDK Session.

(void)	- cleanAudioSession
	Clean Audio Session including Category and Mode.

Detailed Description

A class to operate the audio action.

Definition at line 16 of file ZoomVideoSDKAudioHelper.h.

Method Documentation

◆ allowAudioUnmutedBySelf:

- (ZoomVideoSDKError) allowAudioUnmutedBySelf: (BOOL) allowUnmute

Allow the others to unmute themselves or not.

Parameters

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

Returns: The result of it.

Warning: Only host or manager can chagne this property.

◆ cleanAudioSession

- (void) cleanAudioSession

Clean Audio Session including Category and Mode.

Warning: SDK will restore audio session status after session end. if developer call overrideOutputAudioPort interface wtth AVAudioSessionPortBuiltInSpeaker in AVAudioSessionCategoryPlayAndRecord Category before join session, then sdk can not restore audio session BuiltInSpeaker output when session end,

◆ muteAllAudio:

- (ZoomVideoSDKError) muteAllAudio: (BOOL) allowUnmute

Mute all user's VOIP audio except my self.

Parameters

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

Returns: The result of it.

Warning: Only host or manager can mute all user's audio.

◆ muteAudio:

- (ZoomVideoSDKError) muteAudio: (ZoomVideoSDKUser *_Nullable) user

Mute user's audio.

Returns: the result of it

Warning: If mute self use userid=0.; Only host or manager can mute others audio.

◆ resetAudioSession

- (BOOL) resetAudioSession

Reset Audio Session including Category and Mode for ZoomVideoSDK Audio Session Environment When developer change audio session in session.

Returns: Yes means set auidio success, otherwise failed.

◆ setSDKAudioSessionEnv

- (BOOL) setSDKAudioSessionEnv

Set the AVAudio Session Environment for Zoom Video SDK Session.

Warning: Developer change AVAudio Session by self special needs in SDK session，will cause the audio output abnormal. Then developer can set SDK AVAudio Session environment

Returns: Yes means set audio success, otherwise failed.

◆ startAudio

- (ZoomVideoSDKError) startAudio

Start audio.

Returns: the result of it

◆ stopAudio

- (ZoomVideoSDKError) stopAudio

Stop audio.

Returns: the result of it

◆ subscribe

- (ZoomVideoSDKError) subscribe

Call the function to subscribe audio rawdata.

Warning: please check the callack "- (void)onMixedAudioRawDataReceived:(ZoomVideoSDKAudioRawData *)rawData"; " - (void)onOneWayAudioRawDataReceived:(ZoomVideoSDKAudioRawData *)rawData user:(ZoomVideoSDKUser *)user

◆ unmuteAllAudio

- (ZoomVideoSDKError) unmuteAllAudio

Ask unmute all user's VOIP audio.

Returns: The result of it.

Warning: Only host or manager can ask unmute all user's audio.; This functinon will trigger the callback onHostAskUnmute.

◆ unmuteAudio:

- (ZoomVideoSDKError) unmuteAudio: (ZoomVideoSDKUser *_Nullable) user

Ask unmute user's audio.

Returns: the result of it

Warning: If unmute self use userid=0.; Only host or manager can unmute others audio.; This functinon will trigger the callback onHostAskUnmute.

◆ unSubscribe

- (ZoomVideoSDKError) unSubscribe

Call the function to unSubscribe audio rawdata.

Warning: please check the callack "- (void)onMixedAudioRawDataReceived:(ZoomVideoSDKAudioRawData *)rawData"; " - (void)onOneWayAudioRawDataReceived:(ZoomVideoSDKAudioRawData *)rawData user:(ZoomVideoSDKUser *)user

Instance Methods