Unreal Engine SDK V5.4.128
载入中...
搜索中...
未找到
Public 成员函数 | 所有成员列表
nertc::IRtcVoiceEngine类 参考abstract

#include <INertcVoiceEngine.h>

Public 成员函数

virtual ~IRtcVoiceEngine ()
 
virtual void setEvent (IRtcVoiceEngineEventHandler *handler)=0
 
virtual int applyAuth (uid_t uid, const char *token, int size)=0
 
virtual int setMaxMessageLength (int msTime)=0
 
virtual int startRecording (const char *file_path)=0
 
virtual int stopRecording ()=0
 
virtual int pauseRecording ()=0
 
virtual int resumeRecording ()=0
 
virtual int cancelRecording ()=0
 
virtual int uploadRecordedFile (const char *file_path)=0
 
virtual int downloadRecordedFile (const char *file_id, const char *file_path)=0
 
virtual int playRecordedFile (const char *file_path)=0
 
virtual int stopPlayFile ()=0
 
virtual int speechToText (const char *file_id)=0
 
virtual int getFileSize (const char *file_path)=0
 
virtual int getVoiceFileDuration (const char *file_path)=0
 
virtual int setMicVolume (int volume)=0
 
virtual int getMicVolume ()=0
 
virtual int setSpeakerVolume (int volume)=0
 
virtual int getSpeakerVolume ()=0
 

详细描述

IRtcChannel 类在指定房间中实现实时音视频功能。通过创建多个 IRtcChannel 对象，用户可以同时加入多个房间。

构造及析构函数说明

◆ ~IRtcVoiceEngine()

virtual nertc::IRtcVoiceEngine::~IRtcVoiceEngine ( )
inlinevirtual

成员函数说明

◆ applyAuth()

virtual int nertc::IRtcVoiceEngine::applyAuth ( uid_t uid,
const char * token,
int size )
pure virtual

语音模块鉴权。
只有鉴权成功后才能继续使用语音模块的其他功能。结果通过onAuth回调通知。

参数
[in]uid用户id
[in]token鉴权token
[in]sizetoken长度
返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ cancelRecording()

virtual int nertc::IRtcVoiceEngine::cancelRecording ( )
pure virtual

取消录制语音消息。
取消录制语音消息，录制完成后会通过onRecordComplete回调通知录制结果。

返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ downloadRecordedFile()

virtual int nertc::IRtcVoiceEngine::downloadRecordedFile ( const char * file_id,
const char * file_path )
pure virtual

下载录制的语音消息。
下载录制的语音消息，下载完成后会通过onDownloadComplete回调通知下载结果。

参数
[in]file_id语音消息文件id。
[in]file_path下载文件路径。
返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ getFileSize()

virtual int nertc::IRtcVoiceEngine::getFileSize ( const char * file_path)
pure virtual

获取文件大小。
获取文件大小，单位字节。

参数
[in]file_path文件路径。
返回
  • >=0: 文件大小；
  • <0: 方法调用失败。

◆ getMicVolume()

virtual int nertc::IRtcVoiceEngine::getMicVolume ( )
pure virtual

获取麦克风录制音量。
获取麦克风录制音量，范围 0-100。

返回
  • >=0: 麦克风录制音量；
  • <0: 方法调用失败。

◆ getSpeakerVolume()

virtual int nertc::IRtcVoiceEngine::getSpeakerVolume ( )
pure virtual

获取语音播放音量。
获取语音播放音量，范围 0-100。

返回
  • >=0: 语音播放音量；
  • <0: 方法调用失败。

◆ getVoiceFileDuration()

virtual int nertc::IRtcVoiceEngine::getVoiceFileDuration ( const char * file_path)
pure virtual

获取语音消息时长。
获取语音消息时长，单位毫秒。

参数
[in]file_path文件路径。
返回
  • >=0: 语音消息时长；
  • <0: 方法调用失败。

◆ pauseRecording()

virtual int nertc::IRtcVoiceEngine::pauseRecording ( )
pure virtual

暂停录制语音消息。
暂停录制语音消息，录制完成后会通过onRecordComplete回调通知录制结果。

返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ playRecordedFile()

virtual int nertc::IRtcVoiceEngine::playRecordedFile ( const char * file_path)
pure virtual

播放录制的语音消息。
播放录制的语音消息，播放完成后会通过onPlayComplete回调通知播放结果。

参数
[in]file_path录制文件路径。
返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ resumeRecording()

virtual int nertc::IRtcVoiceEngine::resumeRecording ( )
pure virtual

恢复录制语音消息。
恢复录制语音消息，录制完成后会通过onRecordComplete回调通知录制结果。

返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ setEvent()

virtual void nertc::IRtcVoiceEngine::setEvent ( IRtcVoiceEngineEventHandler * handler)
pure virtual

设置 IRtcVoiceEngine 对象的事件句柄。
你可以通过设置的事件句柄，监听当前 IRtcVoiceEngine 对象对应的事件。

参数
[in]handler事件监听句柄对象

◆ setMaxMessageLength()

virtual int nertc::IRtcVoiceEngine::setMaxMessageLength ( int msTime)
pure virtual

设置语音消息最大长度。
语音消息最大长度，单位毫秒，默认为60秒。

参数
[in]ms_time语音消息最大长度，单位毫秒。
返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ setMicVolume()

virtual int nertc::IRtcVoiceEngine::setMicVolume ( int volume)
pure virtual

设置麦克风录制音量。
设置麦克风录制音量，范围 0-100。

参数
[in]volume音量值，范围 0-100。
返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ setSpeakerVolume()

virtual int nertc::IRtcVoiceEngine::setSpeakerVolume ( int volume)
pure virtual

设置语音播放音量。
设置语音播放音量，范围 0-100。

参数
[in]volume音量值，范围 0-100。
返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ speechToText()

virtual int nertc::IRtcVoiceEngine::speechToText ( const char * file_id)
pure virtual

语音转文字。
语音转文字，转换完成后会通过onSpeechToTextComplete回调通知转换结果。

参数
[in]file_id语音消息文件id。
返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。
注解
  • 语音转文字功能需要联系网易商务开通。

◆ startRecording()

virtual int nertc::IRtcVoiceEngine::startRecording ( const char * file_path)
pure virtual

开始录制语音消息。
开始录制语音消息，录制完成后会通过onRecordComplete回调通知录制结果。

参数
[in]file_path录制文件路径。
返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ stopPlayFile()

virtual int nertc::IRtcVoiceEngine::stopPlayFile ( )
pure virtual

停止播放录制的语音消息。
停止播放录制的语音消息，播放完成后会通过onPlayComplete回调通知播放结果。

返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ stopRecording()

virtual int nertc::IRtcVoiceEngine::stopRecording ( )
pure virtual

停止录制语音消息。
停止录制语音消息，录制完成后会通过onRecordComplete回调通知录制结果。

返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。

◆ uploadRecordedFile()

virtual int nertc::IRtcVoiceEngine::uploadRecordedFile ( const char * file_path)
pure virtual

上传录制的语音消息。
上传录制的语音消息，上传完成后会通过onUploadComplete回调通知上传结果。

参数
[in]file_path录制文件路径。
返回
  • 0: 方法调用成功；
  • 其他: 方法调用失败。
该类的文档由以下文件生成:
制作者 doxygen 1.12.0