# 音色转换 API 文档

# 接口说明

• 音色转换是基于深度学习技术，输入一段音频，能够自动合成各种不同音色的音频，包括多种男声、女声、童声，同时可以提供情感音色，使合成的语音更加接近人声。

• 部分开发语言demo如下，其他开发语言请参照文档进行开发，也欢迎热心的开发者到 讯飞开放平台社区 (opens new window) 分享你们的demo。
  音色转换 demo java语言 (opens new window)
  音色转换 demo python语言 (opens new window)

• 集成音色转换时，需按照以下要求:

# 鉴权说明

在调用业务接口时，请求方需要对请求进行签名，服务端通过签名来校验请求的合法性。

# 鉴权方法

通过在请求地址后面加上鉴权相关参数的方式。示例url：

wss://cn-huadong-1.xf-yun.com/v1/private/s5e668773?host=cn-huadong-1.xf-yun.com&date=Wed%2C+07+Dec+2022+07%3A30%3A37+GMT&authorization=YXBpX2tleT0iYTc0NjZkNmY1YTA5OWQzZWQzOTRiM2Y1OTc0NmNlZGIiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iT0dLS3dlbnNDS3NHRVU2Zjl1cWNXelhlcFY1eWJiY0ZScmlMZkR0eDlaYz0i

鉴权参数：

• date参数生成规则：

date必须是UTC+0或GMT时区，RFC1123格式(Wed, 07 Dec 2022 07:30:37 GMT)。
服务端会对date进行时钟偏移检查，最大允许300秒的偏差，超出偏差的请求都将被拒绝。

• authorization参数生成格式：

1）获取接口密钥APIKey 和 APISecret。
在讯飞开放平台控制台，创建一个应用后打开音色转换页面可以获取，均为32位字符串。
2）参数authorization base64编码前（authorization_origin）的格式如下。

api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"

其中 api_key 是在控制台获取的APIKey，algorithm 是加密算法（仅支持hmac-sha256），headers 是参与签名的参数（见下方注释）。
signature 是使用加密算法对参与签名的参数签名后并使用base64编码的字符串，详见下方。

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

3）signature的原始字段(signature_origin)规则如下。

signature原始字段由 host，date，request-line三个参数按照格式拼接成，
拼接的格式为(\n为换行符,’:’后面有一个空格)：

host: $host\ndate: $date\n$request-line

假设

请求url = "wss://cn-huadong-1.xf-yun.com/v1/private/s5e668773"
date = "Wed, 07 Dec 2022 07:39:22 GMT"

那么 signature原始字段(signature_origin)则为：

host: cn-huadong-1.xf-yun.com
date: Wed, 07 Dec 2022 07:39:22 GMT
GET /v1/private/s5e668773 HTTP/1.1 

4）使用hmac-sha256算法结合apiSecret对signature_origin签名，获得签名后的摘要signature_sha。

signature_sha=hmac-sha256(signature_origin,$apiSecret)

其中 apiSecret 是在控制台获取的APISecret

5）使用base64编码对signature_sha进行编码获得最终的signature。

signature=base64(signature_sha)

假设

APISecret = "apisecretXXXXXXXXXXXXXXXXXXXXXXX"	
date = "Wed, 07 Dec 2022 07:39:22 GMT"

则signature为

signature="gXZ6XAYWyGfbDg91WI/IW6E+BsEq8w3NJwBewPdMR/s="

6）根据以上信息拼接authorization base64编码前（authorization_origin）的字符串，示例如下。

api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="/gXZ6XAYWyGfbDg91WI/IW6E+BsEq8w3NJwBewPdMR/s="

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

7）最后再对authorization_origin进行base64编码获得最终的authorization参数。

authorization = base64(authorization_origin)
示例结果为：
YXBpX2tleT0iYTc0NjZkNmY1YTA5OWQzZWQzOTRiM2Y1OTc0NmNlZGIiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iZ1haNlhBWVd5R2ZiRGc5MVdJL0lXNkUrQnNFcTh3M05Kd0Jld1BkTVIvcz0i

# 鉴权结果

如果鉴权失败，则根据不同错误类型返回不同HTTP Code状态码，同时携带错误描述信息，详细错误说明如下：

时钟偏移校验失败示例：

HTTP/1.1 403 Forbidden
Date: Mon, 30 Nov 2020 02:34:33 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
    "message": "HMAC signature does not match, a valid date or x-date header is required for HMAC Authentication"
}

# 请求参数

请求参数示例：

{
	"header": {
		"app_id": "your_appid",
		"status": 0
	},
	"parameter": {
		"xvc": {
			"voiceName": "xiaowanzi",
			"result": {
				"encoding": "lame",
				"sample_rate": 16000,
				"channels": 1,
				"bit_depth": 16,
				"frame_size": 0
			}
		}
	},
	"payload": {
		"input_audio": {
			"encoding": "lame",
			"sample_rate": 16000,
			"channels": 1,
			"bit_depth": 16,
			"status": 0,
			"seq": 0,
			"audio": "SUQzBAAA......",
			"frame_size": 0
		}
	}
}

请求参数说明：

# 返回结果

返回参数示例：

{
	"header": {
		"code": 0,
		"message": "success",
		'sid': 'ase000e48e5@hu184ebb9f44b05c3882',
		'status': 0
	},
	'payload': {
		'result': {
			'audio': 'JiuHMipCAAD......',
			'bit_depth': 16,
			'channels': 1,
			'encoding': 'lame',
			'frame_size': 0,
			'sample_rate': 16000,
			'seq': 1,
			'status': 0
		}
	}
}

返回参数说明:

# 常见问题

# 音色转换的主要功能是什么？

答：音色转换是基于深度学习技术，输入一段音频，能够自动合成各种不同音色的音频，包括多种男声、女声、童声，同时可以提供情感音色，使合成的语音更加接近人声。

# 音色转换支持什么应用平台？

答：目前支持Web API应用平台。

# 音色转换支持合成什么格式的音频？

答：支持合成mp3, speex, opus格式的音频。