调用UpdateCasterSceneAudio更新场景音频配置。
使用说明
先通过CreateCaster接口创建导播台,再调用本接口更新场景音频配置。本接口目前支持的音频模式为混音模式和音频跟随视频模式。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateCasterSceneAudio | 系统规定参数。取值:UpdateCasterSceneAudio。 |
AudioLayer.N.VolumeRate | Float | 否 | 1 | 调节音频流的音量大小倍数。取值范围为0~10.0,默认值为1.0 。
|
AudioLayer.N.FixedDelayDuration | Integer | 否 | 0 | 该字段对视频进行固定延迟设置,可用于字幕同步。 单位:毫秒。取值范围为0~5000。默认值为0。 |
AudioLayer.N.ValidChannel | String | 否 | all | 确定哪些声道可以作为音量输入。取值:
|
AudioLayer.N.Filter | String | 否 | { "enableAgc":0, "enableAns":1 } | 3A美音算法开关。该参数由以下字段组成:
|
MixList.N | String | 否 | RV01 | 资源位置LocationId关联列表。 与AudioLayers顺序保持一致,若启用Channel时,引用Channel的LocationId,否则引用视频源的LocationId。 |
CasterId | String | 是 | LIVEPRODUCER_POST-cn-0pp1czt**** | 导播台ID。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。 |
SceneId | String | 是 | a2b8e671-2fe5-4642-a2ec-bf93880e1**** | 场景ID。如果您通过DescribeCasterScenes接口查询导播台场景列表,请查看DescribeCasterScenes接口调用返回的参数ComponentId值。 |
FollowEnable | Integer | 否 | 1 | 是否启用音频跟随。 默认启用音频跟随,为空则保持最近一次配置不变。取值:
|
请求参数中的N表示第几个的意思。例如:
- AudioLayer.N.VolumeRate表示传入第几个元素的音量倍数。
- AudioLayer.1.VolumeRate表示传入第1个元素的音量倍数。
- AudioLayer.2.VolumeRate表示传入第2个元素的音量倍数。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 | 请求ID。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=UpdateCasterSceneAudio
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&SceneId=a2b8e671-2fe5-4642-a2ec-bf93880e1****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<UpdateCasterSceneAudioResponse>
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</UpdateCasterSceneAudioResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"UpdateCasterSceneAudioResponse" : {
"RequestId" : "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
}
错误码
访问错误中心查看更多错误码。