nertc.IRtcVoiceEngine类 参考

类 nertc.IRtcVoiceEngine 继承关系图:

Public 成员函数
void	SetEvents (IVoiceEngineCallback callbacks)
int	ApplyAuth (ulong uid, string token)
int	SetMaxMessageLength (int time)
int	StartRecording (string filePath)
int	StopRecording ()
int	PauseRecording ()
int	ResumeRecording ()
int	CancelRecording ()
int	UploadRecordedFile (string filePath)
int	DownloadRecordedFile (string fileID, string filePath)
int	PlayRecordedFile (string filePath)
int	StopPlayFile ()
int	SpeechToText (string fileID)
int	GetFileSize (string filePath)
int	GetVoiceFileDuration (string filePath)
int	SetMicVolume (int volume)
int	GetMicVolume ()
int	SetSpeakerVolume (int volume)
int	GetSpeakerVolume ()

成员函数说明

SetEvents()

void nertc.IRtcVoiceEngine.SetEvents ( IVoiceEngineCallback callbacks )

abstract

设置 语音消息相关接口的事件句柄。
你可以通过设置的事件句柄，监听当前语音消息相关接口对应的事件。

参数

[in]

callbacks

事件监听句柄对象

ApplyAuth()

int nertc.IRtcVoiceEngine.ApplyAuth ( ulong uid, string token )

abstract

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

参数

[in]	uid	用户唯一ID。
[in]	token	鉴权 token。

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

SetMaxMessageLength()

int nertc.IRtcVoiceEngine.SetMaxMessageLength ( int time )

abstract

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

参数

[in]

time

语音消息最大长度，单位毫秒。

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

StartRecording()

int nertc.IRtcVoiceEngine.StartRecording ( string filePath )

abstract

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

参数

[in]

filePath

录制文件路径。

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

StopRecording()

int nertc.IRtcVoiceEngine.StopRecording ( )

abstract

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

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

PauseRecording()

int nertc.IRtcVoiceEngine.PauseRecording ( )

abstract

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

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

ResumeRecording()

int nertc.IRtcVoiceEngine.ResumeRecording ( )

abstract

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

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

CancelRecording()

int nertc.IRtcVoiceEngine.CancelRecording ( )

abstract

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

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

UploadRecordedFile()

int nertc.IRtcVoiceEngine.UploadRecordedFile ( string filePath )

abstract

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

参数

[in]

filePath

录制文件路径。

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

DownloadRecordedFile()

int nertc.IRtcVoiceEngine.DownloadRecordedFile ( string fileID, string filePath )

abstract

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

参数

[in]	fileID	语音消息文件 ID。
[in]	filePath	下载文件路径。

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

PlayRecordedFile()

int nertc.IRtcVoiceEngine.PlayRecordedFile ( string filePath )

abstract

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

参数

[in]

filePath

录制文件路径。

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

StopPlayFile()

int nertc.IRtcVoiceEngine.StopPlayFile ( )

abstract

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

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

SpeechToText()

int nertc.IRtcVoiceEngine.SpeechToText ( string fileID )

abstract

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

参数

[in]

fileID

语音消息文件 ID。

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

注解

• 语音转文字功能需要联系您的网易云信商务经理开通。

GetFileSize()

int nertc.IRtcVoiceEngine.GetFileSize ( string filePath )

abstract

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

参数

[in]

filePath

文件路径。

返回

• >=0: 文件大小。
• <0: 方法调用失败。

GetVoiceFileDuration()

int nertc.IRtcVoiceEngine.GetVoiceFileDuration ( string filePath )

abstract

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

参数

[in]

filePath

文件路径。

返回

• >=0: 语音消息时长。
• <0: 方法调用失败。

SetMicVolume()

int nertc.IRtcVoiceEngine.SetMicVolume ( int volume )

abstract

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

参数

[in]

volume

音量值，范围 0-100。

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

GetMicVolume()

int nertc.IRtcVoiceEngine.GetMicVolume ( )

abstract

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

返回

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

SetSpeakerVolume()

int nertc.IRtcVoiceEngine.SetSpeakerVolume ( int volume )

abstract

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

参数

[in]

volume

音量值，范围 0-100。

返回

• 0: 方法调用成功。
• 其他：方法调用失败。

GetSpeakerVolume()

int nertc.IRtcVoiceEngine.GetSpeakerVolume ( )

abstract

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

返回

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

---

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

• RtcVoiceEngine.cs