cn.tee3.avd_SDK-C++  2.1.0
| Public 成员函数 | 静态 Public 成员函数 | Protected 成员函数 | 所有成员列表
tee3::avd::IMAudio类 参考abstract

房间中音频模块接口. 更多...

类 tee3::avd::IMAudio 继承关系图:
tee3::avd::IModule tee3::avd::IModule

class  IListener
 房间中音频模块回调接口. 更多...
 

Public 成员函数

virtual Result setListener (IListener *listener)=0
 设置音频模块回调接口 更多...
 
virtual Result openMicrophone ()=0
 打开本地麦克风发布到房间中 更多...
 
virtual Result closeMicrophone ()=0
 关闭本地麦克风发布到房间中 更多...
 
virtual MicrophoneStatus getMicrophoneStatus () const =0
 获取本地麦克风状态 更多...
 
virtual Result muteMicrophone ()=0
 本地麦克风静默 更多...
 
virtual Result unmuteMicrophone ()=0
 本地麦克风取消静默 更多...
 
virtual bool ismuteMicrophone () const =0
 判断本地麦克风是否静默 更多...
 
virtual Result muteSpeaker ()=0
 本地扬声器静默 更多...
 
virtual Result unmuteSpeaker ()=0
 本地扬声器取消静默 更多...
 
virtual bool ismuteSpeaker () const =0
 判断本地扬声器是否静默 更多...
 
virtual MicrophoneStatus getRemoteMicrophoneStatus (const UserId &userId) const =0
 remote microphone control 更多...
 
virtual Result remotecmdOpenMicrophone (const UserId &userId)=0
 命令远端用户打开麦克风 更多...
 
virtual Result remotecmdCloseMicrophone (const UserId &userId)=0
 命令远端用户关闭麦克风 更多...
 
virtual IAudioDevicegetAudioDevice ()=0
 获取音频设备管理接口 更多...
 
virtual Result monitorAudioLevel ()=0
 开启语音激励功能 更多...
 
virtual Result unmonitorAudioLevel ()=0
 关闭语音激励 更多...
 
virtual bool ismonitorAudioLevel () const =0
 判断是否开启语音激励 更多...
 
virtual Result setMixerDataListener (IAudioRender *listener)=0
 设置获取混音数据回调接口 更多...
 
virtual Result setMixerDataListener (IAudioRender *listener, uint32 sampleRate, uint32 channels)=0
 
virtual Result subscribe (const UserId &userId)=0
 subscribe 更多...
 
virtual Result unsubscribe (const UserId &userId)=0
 取消订阅一个用户的音频 更多...
 
virtual Result setListener (IListener *listener)=0
 设置音频模块回调接口 更多...
 
virtual Result openMicrophone ()=0
 打开本地麦克风发布到房间中 更多...
 
virtual Result closeMicrophone ()=0
 关闭本地麦克风发布到房间中 更多...
 
virtual MicrophoneStatus getMicrophoneStatus () const =0
 获取本地麦克风状态 更多...
 
virtual Result muteMicrophone ()=0
 本地麦克风静默 更多...
 
virtual Result unmuteMicrophone ()=0
 本地麦克风取消静默 更多...
 
virtual bool ismuteMicrophone () const =0
 判断本地麦克风是否静默 更多...
 
virtual Result muteSpeaker ()=0
 本地扬声器静默 更多...
 
virtual Result unmuteSpeaker ()=0
 本地扬声器取消静默 更多...
 
virtual bool ismuteSpeaker () const =0
 判断本地扬声器是否静默 更多...
 
virtual MicrophoneStatus getRemoteMicrophoneStatus (const UserId &userId) const =0
 remote microphone control 更多...
 
virtual Result remotecmdOpenMicrophone (const UserId &userId)=0
 命令远端用户打开麦克风 更多...
 
virtual Result remotecmdCloseMicrophone (const UserId &userId)=0
 命令远端用户关闭麦克风 更多...
 
virtual IAudioDevicegetAudioDevice ()=0
 获取音频设备管理接口 更多...
 
virtual Result monitorAudioLevel ()=0
 开启语音激励功能 更多...
 
virtual Result unmonitorAudioLevel ()=0
 关闭语音激励 更多...
 
virtual bool ismonitorAudioLevel () const =0
 判断是否开启语音激励 更多...
 
- Public 成员函数 继承自 tee3::avd::IModule
virtual IRoomgetRoom ()=0
 获取房间接口指针 更多...
 
virtual IMUserManagergetUserManager ()=0
 获取房间用户管理模块指针 更多...
 
virtual bool isSelfUser (const UserId &userId) const =0
 判断是否是自己的用户Id 更多...
 
virtual bool isSelfDevice (const DeviceId &deviceId) const =0
 判断设备Id是否是属于自己的 更多...
 
virtual const UserId getOwnerId (const DeviceId &deviceId) const =0
 获取设备Id的关联用户Id 更多...
 
virtual const StringgetOwnerName (const DeviceId &deviceId) const =0
 获取设备Id的关联用户名称 更多...
 

静态 Public 成员函数

static IMAudiogetAudio (IRoom *room)
 获取音频模块接口 更多...
 
static IMAudiogetAudio (IRoom *room)
 获取音频模块接口 更多...
 

Protected 成员函数

virtual ~IMAudio ()
 
virtual ~IMAudio ()
 
- Protected 成员函数 继承自 tee3::avd::IModule
virtual ~IModule ()
 

详细描述

房间中音频模块接口.

房间音频模块定义房间音频相关如麦克风、扬声器相关操作功能接口。

构造及析构函数说明

◆ ~IMAudio() [1/2]

virtual tee3::avd::IMAudio::~IMAudio ( )
protectedvirtual

◆ ~IMAudio() [2/2]

virtual tee3::avd::IMAudio::~IMAudio ( )
protectedvirtual

成员函数说明

◆ closeMicrophone() [1/2]

virtual Result tee3::avd::IMAudio::closeMicrophone ( )
pure virtual

关闭本地麦克风发布到房间中

返回
返回错误代码。
注解
为异步操作,操作结果在 onCloseMicrophoneResult 中返回。
参见
onCloseMicrophoneResult

◆ closeMicrophone() [2/2]

virtual Result tee3::avd::IMAudio::closeMicrophone ( )
pure virtual

关闭本地麦克风发布到房间中

返回
返回错误代码。
注解
为异步操作,操作结果在 onCloseMicrophoneResult 中返回。
参见
onCloseMicrophoneResult

◆ getAudio() [1/2]

static IMAudio* tee3::avd::IMAudio::getAudio ( IRoom room)
static

获取音频模块接口

参数
[in]room房间对象指针。
返回
返回音频模块接口指针。

◆ getAudio() [2/2]

static IMAudio* tee3::avd::IMAudio::getAudio ( IRoom room)
static

获取音频模块接口

参数
[in]room房间对象指针。
返回
返回音频模块接口指针。

◆ getAudioDevice() [1/2]

virtual IAudioDevice* tee3::avd::IMAudio::getAudioDevice ( )
pure virtual

获取音频设备管理接口

返回
返回音频设备管理接口指针。
参见
IAudioDevice

◆ getAudioDevice() [2/2]

virtual IAudioDevice* tee3::avd::IMAudio::getAudioDevice ( )
pure virtual

获取音频设备管理接口

返回
返回音频设备管理接口指针。
参见
IAudioDevice

◆ getMicrophoneStatus() [1/2]

virtual MicrophoneStatus tee3::avd::IMAudio::getMicrophoneStatus ( ) const
pure virtual

获取本地麦克风状态

返回
返回麦克风状态。

◆ getMicrophoneStatus() [2/2]

virtual MicrophoneStatus tee3::avd::IMAudio::getMicrophoneStatus ( ) const
pure virtual

获取本地麦克风状态

返回
返回麦克风状态。

◆ getRemoteMicrophoneStatus() [1/2]

virtual MicrophoneStatus tee3::avd::IMAudio::getRemoteMicrophoneStatus ( const UserId userId) const
pure virtual

remote microphone control

获取远端麦克风状态

参数
[in]userId关联用户Id。
返回
返回麦克风状态。

◆ getRemoteMicrophoneStatus() [2/2]

virtual MicrophoneStatus tee3::avd::IMAudio::getRemoteMicrophoneStatus ( const UserId userId) const
pure virtual

remote microphone control

获取远端麦克风状态

参数
[in]userId关联用户Id。
返回
返回麦克风状态。

◆ ismonitorAudioLevel() [1/2]

virtual bool tee3::avd::IMAudio::ismonitorAudioLevel ( ) const
pure virtual

判断是否开启语音激励

◆ ismonitorAudioLevel() [2/2]

virtual bool tee3::avd::IMAudio::ismonitorAudioLevel ( ) const
pure virtual

判断是否开启语音激励

◆ ismuteMicrophone() [1/2]

virtual bool tee3::avd::IMAudio::ismuteMicrophone ( ) const
pure virtual

判断本地麦克风是否静默

返回
麦克风是否被静默。

◆ ismuteMicrophone() [2/2]

virtual bool tee3::avd::IMAudio::ismuteMicrophone ( ) const
pure virtual

判断本地麦克风是否静默

返回
麦克风是否被静默。

◆ ismuteSpeaker() [1/2]

virtual bool tee3::avd::IMAudio::ismuteSpeaker ( ) const
pure virtual

判断本地扬声器是否静默

◆ ismuteSpeaker() [2/2]

virtual bool tee3::avd::IMAudio::ismuteSpeaker ( ) const
pure virtual

判断本地扬声器是否静默

◆ monitorAudioLevel() [1/2]

virtual Result tee3::avd::IMAudio::monitorAudioLevel ( )
pure virtual

开启语音激励功能

返回
返回错误代码。

◆ monitorAudioLevel() [2/2]

virtual Result tee3::avd::IMAudio::monitorAudioLevel ( )
pure virtual

开启语音激励功能

返回
返回错误代码。

◆ muteMicrophone() [1/2]

virtual Result tee3::avd::IMAudio::muteMicrophone ( )
pure virtual

本地麦克风静默

返回
返回错误代码。
注解
麦克风静默表示本地没有声音传递到房间中,房间中用户不会听到本地的任何声音。

◆ muteMicrophone() [2/2]

virtual Result tee3::avd::IMAudio::muteMicrophone ( )
pure virtual

本地麦克风静默

返回
返回错误代码。
注解
麦克风静默表示本地没有声音传递到房间中,房间中用户不会听到本地的任何声音。

◆ muteSpeaker() [1/2]

virtual Result tee3::avd::IMAudio::muteSpeaker ( )
pure virtual

本地扬声器静默

返回
返回错误代码。
注解
扬声器静默表示房间中的声音不会在本地扬声器播放,本用户不会听到任何房间中的声音。

◆ muteSpeaker() [2/2]

virtual Result tee3::avd::IMAudio::muteSpeaker ( )
pure virtual

本地扬声器静默

返回
返回错误代码。
注解
扬声器静默表示房间中的声音不会在本地扬声器播放,本用户不会听到任何房间中的声音。

◆ openMicrophone() [1/2]

virtual Result tee3::avd::IMAudio::openMicrophone ( )
pure virtual

打开本地麦克风发布到房间中

返回
返回错误代码。
注解
为异步操作,操作结果在 onOpenMicrophoneResult 中返回。
参见
onOpenMicrophoneResult

◆ openMicrophone() [2/2]

virtual Result tee3::avd::IMAudio::openMicrophone ( )
pure virtual

打开本地麦克风发布到房间中

返回
返回错误代码。
注解
为异步操作,操作结果在 onOpenMicrophoneResult 中返回。
参见
onOpenMicrophoneResult

◆ remotecmdCloseMicrophone() [1/2]

virtual Result tee3::avd::IMAudio::remotecmdCloseMicrophone ( const UserId userId)
pure virtual

命令远端用户关闭麦克风

参数
[in]userId关联用户Id。
返回
返回错误代码。

◆ remotecmdCloseMicrophone() [2/2]

virtual Result tee3::avd::IMAudio::remotecmdCloseMicrophone ( const UserId userId)
pure virtual

命令远端用户关闭麦克风

参数
[in]userId关联用户Id。
返回
返回错误代码。

◆ remotecmdOpenMicrophone() [1/2]

virtual Result tee3::avd::IMAudio::remotecmdOpenMicrophone ( const UserId userId)
pure virtual

命令远端用户打开麦克风

参数
[in]userId关联用户Id。
返回
返回错误代码。

◆ remotecmdOpenMicrophone() [2/2]

virtual Result tee3::avd::IMAudio::remotecmdOpenMicrophone ( const UserId userId)
pure virtual

命令远端用户打开麦克风

参数
[in]userId关联用户Id。
返回
返回错误代码。

◆ setListener() [1/2]

virtual Result tee3::avd::IMAudio::setListener ( IListener listener)
pure virtual

设置音频模块回调接口

参数
[in]*listener音频模块回调接口指针。
返回
返回错误代码。
参见
IListener

◆ setListener() [2/2]

virtual Result tee3::avd::IMAudio::setListener ( IListener listener)
pure virtual

设置音频模块回调接口

参数
[in]*listener音频模块回调接口指针。
返回
返回错误代码。
参见
IListener

◆ setMixerDataListener() [1/2]

virtual Result tee3::avd::IMAudio::setMixerDataListener ( IAudioRender listener)
pure virtual

设置获取混音数据回调接口

参数
[in]listener混音数据回调指针。
[in]sampleRate导出混音数据的采样率:16000,44100,48000。
[in]channels导出混音数据的通道数:1,2。
返回
返回错误代码。
参见
IAudioRender
ro_audio_mixerdata_callback_buffered 单次混音数据回调“10ms数据”还是“1024samples数据”
注解
如果音视频同时混合出流,建议先设置视频,再设置音频的回调接口,有助于音视频时间戳对齐。

◆ setMixerDataListener() [2/2]

virtual Result tee3::avd::IMAudio::setMixerDataListener ( IAudioRender listener,
uint32  sampleRate,
uint32  channels 
)
pure virtual

◆ subscribe()

virtual Result tee3::avd::IMAudio::subscribe ( const UserId userId)
pure virtual

subscribe

订阅一个用户的音频

参数
[in]userId用户Id。
返回
返回错误代码。
注解
订阅操作为异步操作,操作结果在 onSubscribeResult 中返回。房间中发布的音频缺省已经订阅,所以一般不需要调用 此函数,只有调用了unsubscribe后,若又需要此音频时才调用此函数。
参见
onSubscribeResult

◆ unmonitorAudioLevel() [1/2]

virtual Result tee3::avd::IMAudio::unmonitorAudioLevel ( )
pure virtual

关闭语音激励

返回
返回错误代码。

◆ unmonitorAudioLevel() [2/2]

virtual Result tee3::avd::IMAudio::unmonitorAudioLevel ( )
pure virtual

关闭语音激励

返回
返回错误代码。

◆ unmuteMicrophone() [1/2]

virtual Result tee3::avd::IMAudio::unmuteMicrophone ( )
pure virtual

本地麦克风取消静默

返回
返回错误代码。

◆ unmuteMicrophone() [2/2]

virtual Result tee3::avd::IMAudio::unmuteMicrophone ( )
pure virtual

本地麦克风取消静默

返回
返回错误代码。

◆ unmuteSpeaker() [1/2]

virtual Result tee3::avd::IMAudio::unmuteSpeaker ( )
pure virtual

本地扬声器取消静默

返回
返回错误代码。

◆ unmuteSpeaker() [2/2]

virtual Result tee3::avd::IMAudio::unmuteSpeaker ( )
pure virtual

本地扬声器取消静默

返回
返回错误代码。

◆ unsubscribe()

virtual Result tee3::avd::IMAudio::unsubscribe ( const UserId userId)
pure virtual

取消订阅一个用户的音频

参数
[in]userId用户Id。
返回
返回错误代码。
注解
取消订阅操作为异步操作,操作结果在 onUnsubscribeResult 中返回。房间中发布的音频缺省已经订阅,如果不想听某 用户的声音,可以调用此函数来取消订阅。
参见
onUnsubscribeResult

该类的文档由以下文件生成: