IZoomVideoSDKAudioHelper Class Reference

Audio helper interface. More...

#include <zoom_video_sdk_audio_helper_interface.h>

Public Member Functions
virtual ZoomVideoSDKErrors	startAudio ()=0
	Start audio with voip.
virtual ZoomVideoSDKErrors	stopAudio ()=0
	Stop voip.
virtual ZoomVideoSDKErrors	muteAudio (IZoomVideoSDKUser *pUser)=0
	Mute user's voip audio. 0 means current user (myself).
virtual ZoomVideoSDKErrors	unMuteAudio (IZoomVideoSDKUser *pUser)=0
	Unmute user's voip audio.
virtual ZoomVideoSDKErrors	muteAllAudio (bool allowUnmute)=0
	Mute all user's VOIP audio except my self.
virtual ZoomVideoSDKErrors	allowAudioUnmutedBySelf (bool allowUnmute)=0
	Allow the others unmute themselves or not.
virtual ZoomVideoSDKErrors	unMuteAllAudio ()=0
	Ask unmute all user's VOIP audio.
virtual IVideoSDKVector< IZoomVideoSDKSpeakerDevice * > *	getSpeakerList ()=0
	Get speaker device list.
virtual IVideoSDKVector< IZoomVideoSDKMicDevice * > *	getMicList ()=0
	Get mic device list.
virtual ZoomVideoSDKErrors	selectSpeaker (const zchar_t *deviceId, const zchar_t *deviceName)=0
	Select some speaker device as default device.
virtual ZoomVideoSDKErrors	selectMic (const zchar_t *deviceId, const zchar_t *deviceName)=0
	Select some mic device as default device.
virtual ZoomVideoSDKErrors	subscribe ()=0
	Subscribe audio raw data.
virtual ZoomVideoSDKErrors	unSubscribe ()=0
	UnSubscribe audio raw data.

Detailed Description

Audio helper interface.

Definition at line 38 of file zoom_video_sdk_audio_helper_interface.h.

Member Function Documentation

allowAudioUnmutedBySelf()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioHelper::allowAudioUnmutedBySelf ( bool allowUnmute )

pure virtual

Allow the others unmute themselves or not.

Parameters

allowUnmute

True means allow the user to unmute themself, otherwise false.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

getMicList()

virtual IVideoSDKVector< IZoomVideoSDKMicDevice * > * IZoomVideoSDKAudioHelper::getMicList ( )

pure virtual

Get mic device list.

Returns

If the function succeeds, the return value is mic device list, Otherwise nullptr.

getSpeakerList()

virtual IVideoSDKVector< IZoomVideoSDKSpeakerDevice * > * IZoomVideoSDKAudioHelper::getSpeakerList ( )

pure virtual

Get speaker device list.

Returns

If the function succeeds, the return value is speaker device list, Otherwise nullptr.

muteAllAudio()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioHelper::muteAllAudio ( bool allowUnmute )

pure virtual

Mute all user's VOIP audio except my self.

Parameters

allowUnmute

True means allow the user to unmute themself, otherwise false.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

muteAudio()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioHelper::muteAudio ( IZoomVideoSDKUser * pUser )

pure virtual

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

Parameters

pUser

The user which you want to mute.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

selectMic()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioHelper::selectMic ( const zchar_t * deviceId, const zchar_t * deviceName )

pure virtual

Select some mic device as default device.

Parameters

deviceId	Device id.
deviceName	Device name.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

selectSpeaker()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioHelper::selectSpeaker ( const zchar_t * deviceId, const zchar_t * deviceName )

pure virtual

Select some speaker device as default device.

Parameters

deviceId	Device id.
deviceName	Device name.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

startAudio()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioHelper::startAudio ( )

pure virtual

Start audio with voip.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

stopAudio()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioHelper::stopAudio ( )

pure virtual

Stop voip.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

subscribe()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioHelper::subscribe ( )

pure virtual

Subscribe audio raw data.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

unMuteAllAudio()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioHelper::unMuteAllAudio ( )

pure virtual

Ask unmute all user's VOIP audio.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum. This function will trigger the callback onHostAskUnmute().

unMuteAudio()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioHelper::unMuteAudio ( IZoomVideoSDKUser * pUser )

pure virtual

Unmute user's voip audio.

Parameters

pUser

The user which you want to unMute.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum. This function will trigger the callback onHostAskUnmute().

unSubscribe()

virtual ZoomVideoSDKErrors IZoomVideoSDKAudioHelper::unSubscribe ( )

pure virtual

UnSubscribe audio raw data.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.