key-value 说明

在声网 SDK 提供的插件相关方法和回调中，key 和 value 参数取决于你使用的插件。本页提供依图实时转写插件支持的 key 和 value 说明。

方法 key 和 value

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

方法的 key	value
ip	依图服务器 IP，如 127.0.0.1
port	发送端口，如 8080
devId	依图开发者 ID，如 2333
accessKey	认证公钥，如 dswqeqfs25sq31
command	支持设为以下值： websocketConnect：连接码流 closeAudioTask：关闭任务 turnOnAudioStream：开启音频码流 turnOffAudioStream：关闭音频码流
createTask	任务配置，包含以下参数： audioConfig：JSON Object，音频设置。详见 audioConfig。 speechConfig：JSON Object，转写识别的设置。详见 speechConfig。
adaptAudioSample	插件接收到的码流，如 16000
audioSliceSize	（不建议修改）插件音频切片大小，如 200

回调 key 和 value

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

onEvent 回调的 key	描述
websocketConnectResult	websocket 连接结果，可能为以下值： success：连接成功 authenticationFail：连接失败，原因是认证失败。 remoteClose：服务器断开连接，原因是建立 websocket 连接后 10 秒内无任何操作。
recognizedResult	识别结果，包含以下字段： globalStreamId：String 型，任务 ID。 result：JSON Object，转写结果，详见 result。 status：JSON Object，当前频处理的状态，详见 status。
devId	依图开发者 ID，如 2333

JSON 字段说明

audioConfig

音频设置，包含以下字段：

• aue：String 型，设为 PCM 即可。
• sampleRate：Int 型，当前仅支持设为 16000。

speechConfig

转写识别的设置，包含以下字段：

• lang：String 型，语言模型。
• （可选）customWord：String Array，热词，表示转写优化词，可用于专有名词和场景。最多支持 100 个词。要求如下：
  • 中文 2–4 个字，如"依图"、"新冠肺炎"。
  • 纯英文 2–4 个字母，字母大写且中间有空格，如："N B A"，"A C M"，"M I T" (两个英文字母未通过校验，不包含空格）。
  • 中英混合共 8 个字节，中文和英文之间需要添加空格：如"京 A"，"卡拉 O K"。
  • 数字和英文单词不支持。
• recognizeType：String 型，支持设为以下值：
  • STREAMING：逐字识别。
  • UTTERANCE：逐句识别。
  • ALL：逐字+逐句识别。
• （可选）wordsReplace：JSON Object，用于关键词替换。包含以下字段：
  • keywords：String Array，待替换的文字，最多支持 100 词。
  • replace：String Array，替换后的文字。

result

转写结果，包含以下字段：

• （可选）isFinal：Bool 型，是否为这一片段的最后解析结果。
• bestTranscription：JSON Object，转写结果，包含以下字段：
  • transcribedText：String 型，整句文字。
  • piece：JSON Array，每个文字的识别结果：
    • transcribedText：String 型，每个文字。
    • beginTimestamp：Int 型，开始的时间戳，单位 ms。返回的第一个字没有此字段，表示从 0 ms 开始。
    • endTimestamp：Int 型，表示文字结束的时间戳，单位 ms。
    • transcribedType：Int 型，转写结果的类型，一个结果可以对应多个状态，为以下状态按位与：
      • TOKEN = 1;
      • PUNCTUATION = 2;
      • NUMBER = 4;
      • PATCH = 8;
      • DISFLUENCY = 16;

status

包含以下字段：

• processedTimestamp：Int 型，当前已处理到的音频时间点，单位 ms。从 0 开始。