ZMVideoSDKAudioHelper Class Reference

Audio control interface SeeZMVideoSDK#GetAudioHelper(). More...

Public Member Functions
void	StartAudio (Action< ZMVideoSDKErrors > callback)
	Start audio with voip.
void	StopAudio (Action< ZMVideoSDKErrors > callback)
	Stop voip.
void	UnMuteAudio (ZMVideoSDKUser user, Action< ZMVideoSDKErrors > callback)
	Unmute user's voip audio.
void	MuteAudio (ZMVideoSDKUser user, Action< ZMVideoSDKErrors > callback)
	Mute user's voip audio. 0 means current user (myself).
List< ZMVideoSDKSpeakerDevice >	GetSpeakerList ()
	Get speaker device list.
List< ZMVideoSDKMicDevice >	GetMicList ()
	Get mic device list.
ZMVideoSDKErrors	SelectSpeaker (string deviceID, string deviceName)
	Select a speaker device as default device.
ZMVideoSDKErrors	SelectMic (string deviceID, string deviceName)
	Select a microphone device as default device.
void	Subscribe (Action< ZMVideoSDKErrors > callback)
	Subscribe audio raw data.
void	UnSubscribe (Action< ZMVideoSDKErrors > callback)
	UnSubscribe audio raw data.

Detailed Description

Audio control interface SeeZMVideoSDK#GetAudioHelper().

Definition at line 8 of file ZMVideoSDKAudioHelper.cs.

Member Function Documentation

GetMicList()

List< ZMVideoSDKMicDevice > ZMVideoSDKAudioHelper.GetMicList ( )

inline

Get mic device list.

Returns

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

Definition at line 96 of file ZMVideoSDKAudioHelper.cs.

    {
        return _videoSDKAudioHelper.GetMicList();
    }

GetSpeakerList()

List< ZMVideoSDKSpeakerDevice > ZMVideoSDKAudioHelper.GetSpeakerList ( )

inline

Get speaker device list.

Returns

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

Definition at line 86 of file ZMVideoSDKAudioHelper.cs.

    {
        return _videoSDKAudioHelper.GetSpeakerList();
    }

MuteAudio()

void ZMVideoSDKAudioHelper.MuteAudio ( ZMVideoSDKUser  user, Action< ZMVideoSDKErrors >  callback  )

inline

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

Parameters

user	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 ZMVideoSDKErrors enum.

Definition at line 76 of file ZMVideoSDKAudioHelper.cs.

    {
        _videoSDKAudioHelper.MuteAudio(user, callback);
    }

SelectMic()

ZMVideoSDKErrors ZMVideoSDKAudioHelper.SelectMic ( string  deviceID, string  deviceName  )

inline

Select a microphone device as default device.

Parameters

deviceID	Device id.
deviceName	Device name.

Returns

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

Definition at line 120 of file ZMVideoSDKAudioHelper.cs.

    {
        return _videoSDKAudioHelper.SelectMic(deviceID, deviceName);
    }

SelectSpeaker()

ZMVideoSDKErrors ZMVideoSDKAudioHelper.SelectSpeaker ( string  deviceID, string  deviceName  )

inline

Select a speaker device as default device.

Parameters

deviceID	Device id.
deviceName	Device name.

Returns

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

Definition at line 108 of file ZMVideoSDKAudioHelper.cs.

    {
        return _videoSDKAudioHelper.SelectSpeaker(deviceID, deviceName);
    }

StartAudio()

void ZMVideoSDKAudioHelper.StartAudio ( Action< ZMVideoSDKErrors >  callback )

inline

Start audio with voip.

Parameters

[out]

callback

a callback function to return the ZMVideoSDKErrors status code of this method.

Definition at line 46 of file ZMVideoSDKAudioHelper.cs.

    {
        _videoSDKAudioHelper.StartAudio(callback);
    }

StopAudio()

void ZMVideoSDKAudioHelper.StopAudio ( Action< ZMVideoSDKErrors >  callback )

inline

Stop voip.

Parameters

[out]

callback

a callback function to return the ZMVideoSDKErrors status code of this method.

Definition at line 55 of file ZMVideoSDKAudioHelper.cs.

    {
        _videoSDKAudioHelper.StopAudio(callback);
    }

Subscribe()

void ZMVideoSDKAudioHelper.Subscribe ( Action< ZMVideoSDKErrors >  callback )

inline

Subscribe audio raw data.

Parameters

[out]

callback

a callback function to return the ZMVideoSDKErrors status code of this method.

Definition at line 129 of file ZMVideoSDKAudioHelper.cs.

    {
        _videoSDKAudioHelper.Subscribe(callback);
    }

UnMuteAudio()

void ZMVideoSDKAudioHelper.UnMuteAudio ( ZMVideoSDKUser  user, Action< ZMVideoSDKErrors >  callback  )

inline

Unmute user's voip audio.

Parameters

	user	The user which you want to unMute.
[out]	callback	a callback function to return the ZMVideoSDKErrors status code of this method.

Definition at line 65 of file ZMVideoSDKAudioHelper.cs.

    {
        _videoSDKAudioHelper.UnMuteAudio(user, callback);
    }

UnSubscribe()

void ZMVideoSDKAudioHelper.UnSubscribe ( Action< ZMVideoSDKErrors >  callback )

inline

UnSubscribe audio raw data.

Parameters

[out]

callback

a callback function to return the ZMVideoSDKErrors status code of this method.

Definition at line 138 of file ZMVideoSDKAudioHelper.cs.

    {
        _videoSDKAudioHelper.UnSubscribe(callback);
    }