NIM 跨平台 C++ SDK
载入中...
搜索中...
未找到
静态 Public 成员函数 | 静态 Private 成员函数 | 静态 Private 属性 | 所有成员列表
nim_audio::Audio类 参考

NIM 提供的语音录制和播放接口 更多...

#include <nim_audio_cpp.h>

静态 Public 成员函数

static bool Init (const std::wstring &user_data_parent_path, const std::wstring &dll_path=L"")
 
static void Cleanup ()
 
static bool PlayAudio (const wchar_t *file_path, const char *call_id, const char *res_id, nim_audio_type audio_format)
 
static bool PlayAudio (const wchar_t *file_path, const char *call_id, const char *res_id, nim_audio_type audio_format, int seek)
 
static bool StopPlayAudio ()
 
static bool RegStartPlayCb (nim_rescode_id_cb cb)
 
static bool RegStopPlayCb (nim_rescode_id_cb cb)
 
static bool RegStartCaptureCb (nim_rescode_cb cb)
 
static bool RegStopCaptureCb (nim_stop_capture_cb cb)
 
static bool RegCancelAudioCb (nim_rescode_cb cb)
 
static bool StartCapture (const char *call_id, const char *res_id, nim_audio_type audio_format=AAC, int volume=180, const wchar_t *capture_device=nullptr)
 
static bool StopCapture ()
 
static bool CancelAudio (const wchar_t *file_path)
 
static bool RegEnumCaptureDeviceCb (nim_enum_capture_device_cb cb)
 
static bool EnumCaptureDevice ()
 

静态 Private 成员函数

template<typename F >
static F Function (const char *function_name)
 

静态 Private 属性

static HINSTANCE instance_audio_ = NULL
 

详细描述

NIM 提供的语音录制和播放接口

成员函数说明

◆ CancelAudio()

bool nim_audio::Audio::CancelAudio ( const wchar_t *  file_path)
static

NIM SDK 取消录制并删除临时文件

返回
bool true 调用成功，false 调用失败

◆ Cleanup()

void nim_audio::Audio::Cleanup ( )
static

void Cleanup() NIM SDK 卸载语音模块（只有在主程序关闭时才有必要调用此接口）

返回
bool true 调用成功，false 调用失败

◆ EnumCaptureDevice()

bool nim_audio::Audio::EnumCaptureDevice ( )
static

NIM SDK 枚举本地录音采集设备

返回
bool true 调用成功，false 调用失败

◆ Function()

template<typename F >
static F nim_audio::Audio::Function ( const char *  function_name)
inlinestaticprivate

◆ Init()

bool nim_audio::Audio::Init ( const std::wstring &  user_data_parent_path,
const std::wstring &  dll_path = L"" 
)
static

bool Init(const std::wstring& user_data_parent_path,const std::wstring& dll_path = L"") NIM SDK 初始化语音模块

参数
[in]user_data_parent_path缓存目录
[in]dll_path语音模块所在目录
返回
bool true 调用成功，false 调用失败

◆ PlayAudio() [1/2]

bool nim_audio::Audio::PlayAudio ( const wchar_t *  file_path,
const char *  call_id,
const char *  res_id,
nim_audio_type  audio_format 
)
static

bool PlayAudio(const wchar_t* file_path, const char* call_id, const char* res_id, nim_audio_type audio_format) NIM SDK 播放,通过回调获取开始播放状态

参数
[in]file_path播放文件绝对路径
[in]call_id用以定位资源的一级ID，可选
[in]res_id用以定位资源的二级ID，可选
[in]audio_format播放音频格式，AAC : 0， AMR : 1
返回
bool true 调用成功，false 调用失败

◆ PlayAudio() [2/2]

bool nim_audio::Audio::PlayAudio ( const wchar_t *  file_path,
const char *  call_id,
const char *  res_id,
nim_audio_type  audio_format,
int  seek 
)
static

bool PlayAudio(const wchar_t* file_path, const char* call_id, const char* res_id, nim_audio_type audio_format, int seek) NIM SDK 播放,通过回调获取开始播放状态

参数
[in]file_path播放文件绝对路径
[in]call_id用以定位资源的一级ID，可选
[in]res_id用以定位资源的二级ID，可选
[in]audio_format播放音频格式，AAC : 0， AMR : 1
[in]seek播放的起始位置(时间)，单位ms
返回
bool true 调用成功，false 调用失败

◆ RegCancelAudioCb()

bool nim_audio::Audio::RegCancelAudioCb ( nim_rescode_cb  cb)
static

注册取消录制并删除临时文件事件回调

参数
[in]cb回调函数 见nim_audio_def.h
返回
bool true 调用成功，false 调用失败

◆ RegEnumCaptureDeviceCb()

bool nim_audio::Audio::RegEnumCaptureDeviceCb ( nim_enum_capture_device_cb  cb)
static

注册枚举本地录音采集设备回调

参数
[in]cb回调函数 见nim_audio_def.h
返回
bool true 调用成功，false 调用失败

◆ RegStartCaptureCb()

bool nim_audio::Audio::RegStartCaptureCb ( nim_rescode_cb  cb)
static

注册录制语音回调

参数
[in]cb回调函数 见nim_audio_def.h
返回
bool true 调用成功，false 调用失败

◆ RegStartPlayCb()

bool nim_audio::Audio::RegStartPlayCb ( nim_rescode_id_cb  cb)
static

bool RegStartPlayCb(nim_rescode_id_cb cb) 注册播放开始事件回调

参数
[in]cb回调函数 见nim_audio_def.h
返回
bool true 调用成功，false 调用失败

◆ RegStopCaptureCb()

bool nim_audio::Audio::RegStopCaptureCb ( nim_stop_capture_cb  cb)
static

注册录制语音结束回调

参数
[in]cb回调函数 见nim_audio_def.h
返回
bool true 调用成功，false 调用失败

◆ RegStopPlayCb()

bool nim_audio::Audio::RegStopPlayCb ( nim_rescode_id_cb  cb)
static

bool RegStopPlayCb(nim_rescode_id_cb cb) 注册播放结束事件回调

参数
[in]cb回调函数 见nim_audio_def.h
返回
bool true 调用成功，false 调用失败

◆ StartCapture()

bool nim_audio::Audio::StartCapture ( const char *  call_id,
const char *  res_id,
nim_audio_type  audio_format = AAC,
int  volume = 180,
const wchar_t *  capture_device = nullptr 
)
static
参数
[in]call_id用以定位资源的一级ID，可选
[in]res_id用以定位资源的二级ID，可选
[in]audio_format音频格式，AAC : 0， AMR : 1
[in]volume音量(0 - 255, 默认180)
[in]capture_device采集设备
返回
bool true 调用成功，false 调用失败

◆ StopCapture()

bool nim_audio::Audio::StopCapture ( )
static

NIM SDK 停止录制语音

返回
bool true 调用成功，false 调用失败

◆ StopPlayAudio()

bool nim_audio::Audio::StopPlayAudio ( )
static

bool StopPlayAudio() NIM SDK 停止播放,通过回调获取停止播放状态

返回
bool true 调用成功，false 调用失败

类成员变量说明

◆ instance_audio_

HINSTANCE nim_audio::Audio::instance_audio_ = NULL
staticprivate
该类的文档由以下文件生成: