#include <IVoiceEngine.h>

类 nertc::wwiseplugin::IVoiceEngine 继承关系图:

Public 成员函数
virtual	~IVoiceEngine ()=default

virtual void	setEvents (IVoiceEngineCallback *callbacks)=0

virtual int	setAuth (uint64_t userID, const char *token, int size)=0

virtual int	setMaxMessageLength (int timestamp)=0

virtual int	startRecording (const char *filePath)=0

virtual int	stopRecording ()=0

virtual int	pauseRecording ()=0

virtual int	resumeRecording ()=0

virtual int	cancelRecording ()=0

virtual int	uploadRecordedFile (const char *filePath)=0

virtual int	downloadRecordedFile (const char fileID, const char filePath)=0

virtual int	playRecordeFile (const char *filePath)=0

virtual int	stopPlayFile ()=0

virtual int	speechToText (const char *fileID)=0

virtual int	getFileSize (const char *filePath)=0

virtual int	getVoiceFileDuration (const char *filePath)=0

virtual int	setMicVolume (int volume)=0

virtual int	getMicVolume ()=0

virtual int	setSpeakerVolume (int volume)=0

virtual int	getSpeakerVolume ()=0

详细描述

语音（消息）转文字相关接口

构造及析构函数说明

◆ ~IVoiceEngine()

virtual nertc::wwiseplugin::IVoiceEngine::~IVoiceEngine ( )

virtualdefault

成员函数说明

◆ setEvents()

virtual void nertc::wwiseplugin::IVoiceEngine::setEvents ( IVoiceEngineCallback * callbacks )

pure virtual

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

参数

[in] callbacks 事件监听句柄对象

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ setAuth()

virtual int nertc::wwiseplugin::IVoiceEngine::setAuth	(	uint64_t	userID,
		const char *	token,
		int	size )

pure virtual

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

参数

[in]	userID	语音功能的唯一ID。不同端的ID不能相同。
[in]	token	鉴权token
[in]	size	token长度

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ setMaxMessageLength()

virtual int nertc::wwiseplugin::IVoiceEngine::setMaxMessageLength ( int timestamp )

pure virtual

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

参数

[in] timestamp 语音消息最大长度，单位毫秒。

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ startRecording()

virtual int nertc::wwiseplugin::IVoiceEngine::startRecording ( const char * filePath )

pure virtual

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

参数

[in] filePath 录制文件路径。

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ stopRecording()

virtual int nertc::wwiseplugin::IVoiceEngine::stopRecording ( )

pure virtual

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

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ pauseRecording()

virtual int nertc::wwiseplugin::IVoiceEngine::pauseRecording ( )

pure virtual

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

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ resumeRecording()

virtual int nertc::wwiseplugin::IVoiceEngine::resumeRecording ( )

pure virtual

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

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ cancelRecording()

virtual int nertc::wwiseplugin::IVoiceEngine::cancelRecording ( )

pure virtual

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

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ uploadRecordedFile()

virtual int nertc::wwiseplugin::IVoiceEngine::uploadRecordedFile ( const char * filePath )

pure virtual

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

参数

[in] filePath 录制文件路径。

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ downloadRecordedFile()

virtual int nertc::wwiseplugin::IVoiceEngine::downloadRecordedFile	(	const char *	fileID,
		const char *	filePath )

pure virtual

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

参数

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

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ playRecordeFile()

virtual int nertc::wwiseplugin::IVoiceEngine::playRecordeFile ( const char * filePath )

pure virtual

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

参数

[in] filePath 录制文件路径。

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ stopPlayFile()

virtual int nertc::wwiseplugin::IVoiceEngine::stopPlayFile ( )

pure virtual

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

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ speechToText()

virtual int nertc::wwiseplugin::IVoiceEngine::speechToText ( const char * fileID )

pure virtual

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

参数

[in] fileID 语音消息文件id。

返回

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

注解

语音转文字功能需要联系网易商务开通。

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ getFileSize()

virtual int nertc::wwiseplugin::IVoiceEngine::getFileSize ( const char * filePath )

pure virtual

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

参数

[in] filePath 文件路径。

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ getVoiceFileDuration()

virtual int nertc::wwiseplugin::IVoiceEngine::getVoiceFileDuration ( const char * filePath )

pure virtual

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

参数

[in] filePath 文件路径。

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ setMicVolume()

virtual int nertc::wwiseplugin::IVoiceEngine::setMicVolume ( int volume )

pure virtual

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

参数

[in] volume 音量值，范围 0-100。

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ getMicVolume()

virtual int nertc::wwiseplugin::IVoiceEngine::getMicVolume ( )

pure virtual

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

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ setSpeakerVolume()

virtual int nertc::wwiseplugin::IVoiceEngine::setSpeakerVolume ( int volume )

pure virtual

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

参数

[in] volume 音量值，范围 0-100。

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

◆ getSpeakerVolume()

virtual int nertc::wwiseplugin::IVoiceEngine::getSpeakerVolume ( )

pure virtual

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

返回

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

在 nertc::wwiseplugin::NertcVoiceEngineImpl 内被实现.

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

IVoiceEngine.h

Public 成员函数

详细描述

构造及析构函数说明

◆ ~IVoiceEngine()

成员函数说明

◆ setEvents()

◆ setAuth()

◆ setMaxMessageLength()

◆ startRecording()

◆ stopRecording()

◆ pauseRecording()

◆ resumeRecording()

◆ cancelRecording()

◆ uploadRecordedFile()

◆ downloadRecordedFile()

◆ playRecordeFile()

◆ stopPlayFile()

◆ speechToText()

◆ getFileSize()

◆ getVoiceFileDuration()

◆ setMicVolume()

◆ getMicVolume()

◆ setSpeakerVolume()

◆ getSpeakerVolume()