NIM Unity SDK V2.6.0
载入中...
搜索中...
未找到
静态 Public 成员函数 | 所有成员列表
NIMAudio.AudioAPI类 参考

静态 Public 成员函数

static bool InitModule (string userDataParentPath)
 NIM SDK 初始化语音模块
 
static bool UninitModule ()
 NIM SDK 卸载语音模块（只有在主程序关闭时才有必要调用此接口）
 
static bool PlayAudio (string filePath, NIMAudioType audioFormat)
 NIM SDK 播放,通过回调获取开始播放状态。android平台需在主线程调用
 
static bool StopPlayAudio ()
 NIM SDK 停止播放,通过回调获取停止播放状态
 
static bool RegStartPlayCb (PlayCallbackDelegate cb)
 NIM SDK 注册播放开始事件回调
 
static bool RegStopPlayCb (PlayCallbackDelegate cb)
 NIM SDK 注册停止播放事件回调
 
static bool RegPlayEndCb (PlayCallbackDelegate cb)
 NIM SDK 注册播放结束事件回调
 
static bool RegGetCaptureDevices (GetCaptureDevicesCallbackDelegate cb)
 
static bool StartCapture (int audio_format, int volume, int loudness, string capture_device)
 录制语音 android平台需在主线程调用
 
static bool StopCapture ()
 停止录制语音
 
static bool CancelCapture ()
 取消录制并删除临时文件
 
static bool RegStartCaptureCb (StatusCallbackDelegate cb)
 注册录制语音开始回调
 
static bool RegStopCaptureCb (StopCaptureCallbackDelegate cb)
 注册录制语音停止回调
 
static bool RegCancelCaptureCb (StatusCallbackDelegate cb)
 注册录制语音取消回调
 
static bool RegGetCaptureTimeCb (StatusCallbackDelegate cb)
 注册获取当前录制时间的回调
 
static bool RegGetPlayCurrentPositionCb (StatusCallbackDelegate cb)
 注册获取当前播放时间的回调
 
static bool GetCaptureTime ()
 获取采集时间，采集时间由所注册的回调返回
 
static int GetPlayTime ()
 获取播放文件的时长
 
static bool GetPlayCurrentPosition ()
 获取播放时间，播放时间由所注册的回调返回
 
static void SetPlaySpeaker (bool speaker, IntPtr context)
 设置扬声器 ios,android有效
 
static bool GetPlaySpeaker (IntPtr context)
 获取扬声器状态 ios，android有效
 
static bool GetCaptureDevices ()
 枚举采集设备，结果由所注册回调返回。
 
static bool RegCaptureVolumeCb (CaptureVolumeCallbackDelegate cb)
 设置音量值回调
 

成员函数说明

◆ InitModule()

static bool NIMAudio.AudioAPI.InitModule ( string  userDataParentPath)
inlinestatic

NIM SDK 初始化语音模块

参数
userDataParentPath缓存目录
返回
true 调用成功, false 调用失败

◆ UninitModule()

static bool NIMAudio.AudioAPI.UninitModule ( )
inlinestatic

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

返回
true 调用成功, false 调用失败

◆ PlayAudio()

static bool NIMAudio.AudioAPI.PlayAudio ( string  filePath,
NIMAudioType  audioFormat 
)
inlinestatic

NIM SDK 播放,通过回调获取开始播放状态。android平台需在主线程调用

参数
filePath播放文件绝对路径
audioFormat播放音频格式，AAC : 0， AMR : 1
返回
true 调用成功, false 调用失败

◆ StopPlayAudio()

static bool NIMAudio.AudioAPI.StopPlayAudio ( )
inlinestatic

NIM SDK 停止播放,通过回调获取停止播放状态

返回
true 调用成功, false 调用失败

◆ RegStartPlayCb()

static bool NIMAudio.AudioAPI.RegStartPlayCb ( PlayCallbackDelegate  cb)
inlinestatic

NIM SDK 注册播放开始事件回调

参数
cb播放开始事件的回调函数
返回
true 调用成功, false 调用失败

◆ RegStopPlayCb()

static bool NIMAudio.AudioAPI.RegStopPlayCb ( PlayCallbackDelegate  cb)
inlinestatic

NIM SDK 注册停止播放事件回调

参数
cb播放结束事件的回调函数
返回
true 调用成功, false 调用失败

◆ RegPlayEndCb()

static bool NIMAudio.AudioAPI.RegPlayEndCb ( PlayCallbackDelegate  cb)
inlinestatic

NIM SDK 注册播放结束事件回调

参数
cb播放结束事件的回调函数
返回
true 调用成功, false 调用失败

◆ StartCapture()

static bool NIMAudio.AudioAPI.StartCapture ( int  audio_format,
int  volume,
int  loudness,
string  capture_device 
)
inlinestatic

录制语音 android平台需在主线程调用

参数
audio_format音频格式，AAC : 0， AMR : 1
volume音量(0 - 500, 默认100)增益值为(volume/100),值为0时,sdk底层已默认值处理
loudness默认0 pc有效
capture_devicecapture_device 录音设备 pc有效
返回
true 调用成功, false 调用失败

◆ StopCapture()

static bool NIMAudio.AudioAPI.StopCapture ( )
inlinestatic

停止录制语音

返回
true 调用成功, false 调用失败

◆ CancelCapture()

static bool NIMAudio.AudioAPI.CancelCapture ( )
inlinestatic

取消录制并删除临时文件

参数
filepath
返回
true 调用成功, false 调用失败

◆ RegStartCaptureCb()

static bool NIMAudio.AudioAPI.RegStartCaptureCb ( StatusCallbackDelegate  cb)
inlinestatic

注册录制语音开始回调

参数
cb回调函数
返回
true 调用成功, false 调用失败

◆ RegStopCaptureCb()

static bool NIMAudio.AudioAPI.RegStopCaptureCb ( StopCaptureCallbackDelegate  cb)
inlinestatic

注册录制语音停止回调

参数
cb回调函数
返回
true 调用成功, false 调用失败

◆ RegCancelCaptureCb()

static bool NIMAudio.AudioAPI.RegCancelCaptureCb ( StatusCallbackDelegate  cb)
inlinestatic

注册录制语音取消回调

参数
cb回调函数
返回
true 调用成功, false 调用失败

◆ RegGetCaptureTimeCb()

static bool NIMAudio.AudioAPI.RegGetCaptureTimeCb ( StatusCallbackDelegate  cb)
inlinestatic

注册获取当前录制时间的回调

参数
cb
返回
true 调用成功, false 调用失败

◆ RegGetPlayCurrentPositionCb()

static bool NIMAudio.AudioAPI.RegGetPlayCurrentPositionCb ( StatusCallbackDelegate  cb)
inlinestatic

注册获取当前播放时间的回调

参数
cb
返回
true 调用成功, false 调用失败

◆ GetCaptureTime()

static bool NIMAudio.AudioAPI.GetCaptureTime ( )
inlinestatic

获取采集时间，采集时间由所注册的回调返回

返回
true 调用成功, false 调用失败

◆ GetPlayTime()

static int NIMAudio.AudioAPI.GetPlayTime ( )
inlinestatic

获取播放文件的时长

返回
播放文件的时长，异常为-1

◆ GetPlayCurrentPosition()

static bool NIMAudio.AudioAPI.GetPlayCurrentPosition ( )
inlinestatic

获取播放时间，播放时间由所注册的回调返回

返回
true 调用成功, false 调用失败

◆ SetPlaySpeaker()

static void NIMAudio.AudioAPI.SetPlaySpeaker ( bool  speaker,
IntPtr  context 
)
inlinestatic

设置扬声器 ios,android有效

参数
speakertrue:扬声器开启.false:扬声器关闭
context当前上下文，android 必须.ios无效

◆ GetPlaySpeaker()

static bool NIMAudio.AudioAPI.GetPlaySpeaker ( IntPtr  context)
inlinestatic

获取扬声器状态 ios，android有效

参数
context当前上下文，android 必须.ios无效
返回
true 扬声器开启 false 扬声器关闭

◆ GetCaptureDevices()

static bool NIMAudio.AudioAPI.GetCaptureDevices ( )
inlinestatic

枚举采集设备，结果由所注册回调返回。

返回
true 调用成功, false 调用失败

◆ RegCaptureVolumeCb()

static bool NIMAudio.AudioAPI.RegCaptureVolumeCb ( CaptureVolumeCallbackDelegate  cb)
inlinestatic

设置音量值回调

参数
cb回调函数
返回
该类的文档由以下文件生成:
制作者 doxygen 1.9.7