微软实时语音识别（多语种）插件接口说明

声网 SDK 的 API 参考

本节提供声网 SDK 中插件相关 API 的参考文档。

Android

• RtcEngineConfig 类的 addExtension
• RtcEngine 类的 enableExtension
• RtcEngine 类的 setExtensionProperty
• RtcEngine 类的 getExtensionProperty
• IMediaExtensionObserver 类的 onEvent

iOS

• AgoraRtcEngineKit 类的 enableExtensionWithVendor
• AgoraRtcEngineKit 类的 setExtensionPropertyWithVendor
• AgoraRtcEngineKit 类的 getExtensionPropertyWithVendor
• AgoraMediaFilterEventDelegate 类的 onEvent

插件的 key-value 列表

在声网 SDK 中调用插件相关 API 时，需要传入指定的 key 和 value。本节介绍微软实时语音识别（多语种）插件支持的所有 key 及其对应 value。

方法 key

调用声网 SDK 的 setExtensionProperty/setExtensionPropertyWithVendor 方法时，支持传入以下 key：

setExtensionProperty/setExtensionPropertyWithVendor 方法的 key	描述
init_speech_recognition	初始化语音转写
start_continuous_recognition_async	开始语音转写
stop_continuous_recognition_async	结束语音转写
init_translate_recognition	初始化语音翻译
start_continuous_translate_async	开始语音翻译
stop_continuous_translate_async	结束语音翻译

回调 key

声网 SDK 的 onEvent 回调可能包括以下 key：

onEvent 回调的 key	描述
speech_recognizing	实时转写结果
speech_recognized	最终转写结果
recognized_canceled	转写被取消
recognized_session_stopped	当前转写已结束
recognized_session_started	当前转写已开始
speech_start_detected	开始检测转写的源语种
speech_end_detected	结束检测转写的源语种
translation_recognizing	实时翻译结果
translation_recognized	最终翻译结果
translation_recognized_canceled	翻译被取消
translation_recognized_session_stopped	当前翻译已结束
translation_recognized_session_started	当前翻译已开始
translation_speech_start_detected	开始检测翻译的源语种
translation_speech_end_detected	结束检测翻译的源语种

方法 key 的 value 说明

init_speech_recognition

value 包含以下参数：

value 参数	描述
subscription	String 型，Azure 语音服务资源的订阅密钥。获取方式详见免费试用语音服务。
region	String 型，使用 Azure 语音服务资源的区域。获取方式详见免费试用语音服务。
source_languages	String 型数组，语音转写的源语种，取值详见语音转文本的语言支持。 如果不开启语种自动检测，只能设置一个源语种。 如果开启语种自动检测，可以设置多个源语种。设置的源语种都在自动检测的范围内。
enable_auto_detect	Boolean 型，是否开启语种自动检测。

start_continuous_recognition_async

无 value 参数。

stop_continuous_recognition_async

无 value 参数。

init_translate_recognition

value 包含以下参数：

value 参数	描述
subscription	String 型，Azure 语音服务资源的订阅密钥。获取方式详见免费试用语音服务。
source_languages	String 型数组，语音转写的源语种，取值详见语音转文本的语言支持。 如果不开启语种自动检测，只能设置一个源语种。 如果开启语种自动检测，可以设置多个源语种。设置的源语种都在自动检测的范围内。
target_languages	String 型数组，语音翻译的目标语种。支持设置多个目标语种，取值详见语音翻译的语言支持。
enable_auto_detect	Boolean 型，是否开启语种自动检测。

start_continuous_translate_async

无 value 参数。

stop_continuous_translate_async

无 value 参数。

回调 key 的 value 说明

speech_recognizing

value 包含以下参数：

value 参数	描述
result_id	String 型，识别结果的唯一标识符。
text	String 型，识别的文字。
reason	产生识别结果的原因，详见 enum ResultReason 。
duration	音频时长。
offset	时间偏移。

详细的参数解释请查看微软文档 class RecognitionResult。

speech_recognized

value 包含以下参数：

value 参数	描述
result_id	String 型，识别结果的唯一标识符。
text	String 型，识别的文字。
reason	产生识别结果的原因，详见 enum ResultReason 。
duration	音频时长。
offset	时间偏移。
no_match_reason	当 reason 为 ResultReason::NoMatch 时该参数有值，表示无法转写的原因，详见 enum NoMatchReason。

详细的参数解释请查看微软文档 class RecognitionResult。

recognized_canceled

value 包含以下参数：

value 参数	描述
reason	取消原因。详见 enum CancellationReason。
error_code	错误码。详见 enum CancellationErrorCode 。
error_details	String 型，错误信息。

recognized_session_stopped

value 包含以下参数：

value 参数	描述
session_id	String 型，本次识别的唯一标识符。

recognized_session_started

value 包含以下参数：

value 参数	描述
session_id	String 型，本次识别的唯一标识符。

speech_start_detected

value 包含以下参数：

value 参数	描述
session_id	String 型，本次识别的唯一标识符。

speech_end_detected

value 包含以下参数：

value 参数	描述
session_id	String 型，本次识别的唯一标识符。

translation_recognizing

value 包含以下参数：

value 参数	描述
result_id	String 型，识别结果的唯一标识符。
text	String 型，识别的文字。
translation	String 型，翻译结果。翻译结果中的语言代码参考语音翻译的语言支持。
reason	产生识别结果的原因，详见 enum ResultReason 。
duration	音频时长。
offset	时间偏移。

详细的参数解释请查看微软文档 class RecognitionResult。

translation_recognized

value 包含以下参数：

value 参数	描述
result_id	String 型，识别结果的唯一标识符。
text	String 型，识别的文字。
translation	String 型，翻译结果。翻译结果中的语言代码参考语音翻译的语言支持。
reason	产生识别结果的原因，详见 enum ResultReason 。
duration	音频时长。
offset	时间偏移。
no_match_reason	当 reason 为 ResultReason::NoMatch 时该参数有值，表示无法识别的原因，详见 enum NoMatchReason。

详细的参数解释请查看微软文档 class RecognitionResult。

translation_recognized_canceled

value 包含以下参数：

value 参数	描述
reason	取消原因。详见 enum CancellationReason。
error_code	错误码。详见 enum CancellationErrorCode 。
error_details	String 型，错误信息。

translation_recognized_session_stopped

value 包含以下参数：

value 参数	描述
session_id	String 型，本次识别的唯一标识符。

translation_recognized_session_started

value 包含以下参数：

value 参数	描述
session_id	String 型，本次识别的唯一标识符。

translation_speech_start_detected

value 包含以下参数：

value 参数	描述
session_id	String 型，本次识别的唯一标识符。

translation_speech_end_detected

value 包含以下参数：

value 参数	描述
session_id	String 型，本次识别的唯一标识符。