音视频通讯SDK API参考手册  Windows 1.6.0
tencent::av::AVAccompanyDevice类 参考abstract

伴奏设备。 更多...

#include <av_device.h>

类 tencent::av::AVAccompanyDevice 继承关系图:
tencent::av::AVAudioDevice tencent::av::AVDevice

Public 类型

enum  SourceType { AV_ACCOMPANY_SOURCE_TYPE_NONE = 0, AV_ACCOMPANY_SOURCE_TYPE_SYSTEM = 1, ACCOMPANY_SOURCE_TYPE_PROCESS = 2 }
 伴奏源类型。 更多...
 
- Public 类型 继承自 tencent::av::AVAudioDevice
typedef void(* FrameDataCallback) (AudioFrame *audio_frame, void *custom_data)
 SetFrameDataCallback()的回调函数, 内部使用。 更多...
 
- Public 类型 继承自 tencent::av::AVDevice
enum  DeviceOperation { DEVICE_OPERATION_UNKNOWN = 0, DEVICE_OPERATION_OPEN = 1, DEVICE_OPERATION_CLOSE = 2 }
 设备操作类型。 更多...
 

Public 成员函数

virtual void SetSource (std::string player_path, std::string media_file_path, SourceType source_type)=0
 设置伴奏源。 更多...
 
virtual SourceType GetSourceType ()=0
 获得伴奏源类型。 更多...
 
virtual std::string GetPlayerPath ()=0
 获得播放器进程的路径。 更多...
 
virtual std::string GetMediaFilePath ()=0
 获得影音文件路径。 更多...
 
- Public 成员函数 继承自 tencent::av::AVAudioDevice
virtual uint32 GetVolume ()=0
 获得音频设备音量大小。 更多...
 
virtual void SetVolume (uint32 value)=0
 设置音频设备音量大小。 更多...
 
virtual uint32 GetDynamicVolume ()=0
 获得音频设备动态音量。 更多...
 
virtual void SetFrameDataCallback (FrameDataCallback frame_callback, void *custom_data=NULL)=0
 设置采集回调函数,内部使用。 更多...
 
virtual FrameDataCallback GetFrameDataCallback ()=0
 
virtual void * GetFrameCustomData ()=0
 
- Public 成员函数 继承自 tencent::av::AVDevice
virtual const std::string & GetId () const =0
 获得当前设备Id。 更多...
 
virtual const std::string & GetType () const =0
 获得当前设备类型。 更多...
 
virtual const InfoGetInfo () const =0
 获取设备信息。 更多...
 
virtual void SetInfo (const Info &info)=0
 设置设备信息。 更多...
 
virtual bool IsSelected () const =0
 判断设备是否处于选中状态。 更多...
 
virtual void SetSelect (bool is_select=true)=0
 选中设备 更多...
 

详细描述

伴奏设备是一个虚拟的设备,它既是音频输入设备,也是音频输出设备。 App可以选择系统伴奏或者应用伴奏来添加背景声音,本地和远端都会输出背景声音。

成员枚举类型说明

枚举值
AV_ACCOMPANY_SOURCE_TYPE_NONE 

默认值,无意义。

AV_ACCOMPANY_SOURCE_TYPE_SYSTEM 

系统伴奏,来源为系统的声音。

ACCOMPANY_SOURCE_TYPE_PROCESS 

应用伴奏,来源为播放器进程的声音。

成员函数说明

virtual std::string tencent::av::AVAccompanyDevice::GetMediaFilePath ( )
pure virtual
返回
当伴奏源类型为ACCOMPANY_SOURCE_TYPE_PROCESS时,返回影音文件的路径。
virtual std::string tencent::av::AVAccompanyDevice::GetPlayerPath ( )
pure virtual
返回
当伴奏源类型为ACCOMPANY_SOURCE_TYPE_PROCESS时,返回播放器进程的路径。
virtual SourceType tencent::av::AVAccompanyDevice::GetSourceType ( )
pure virtual
返回
返回伴奏源类型,详情见SourceType的定义。
virtual void tencent::av::AVAccompanyDevice::SetSource ( std::string  player_path,
std::string  media_file_path,
SourceType  source_type 
)
pure virtual

当伴奏源为ACCOMPANY_SOURCE_TYPE_PROCESS,player_path不能为空, 若media_file_path为空,则自动以当前播放器播放的声音为伴奏源; 若media_file_path不为空,会自动使用播放器播放指定歌曲。 当伴奏源为ACCOMPANY_SOURCE_TYPE_ SYSTEM,player_path和media_file_path不需要设置。

参数
player_path播放器路径。
media_file_path使用播放器播放的音频文件路径。
source_type伴奏源。