增加场景音频配置,将原场景音频添加到新场景。
接口说明
先通过 CreateCaster 接口创建导播台,再调用本接口更新场景音频配置。本接口目前支持的音频模式为混音模式和音频跟随视频模式。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:UpdateCasterSceneAudio |
update |
*Caster
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
AudioLayer |
array<object> |
否 |
音频配置。 |
|
object |
否 |
音频配置。 |
||
Filter |
string |
否 |
3A 美音算法开关。该参数由以下字段组成:
说明
为保证更好的降噪效果,建议将 ansMode 取值为 1:音乐降噪。
|
{ "enableAgc":0, "enableAns":1 } |
FixedDelayDuration |
integer |
否 |
该字段对视频进行固定延迟设置,可用于字幕同步。 单位:毫秒。取值范围为0~5000。默认值为 0。 |
0 |
ValidChannel |
string |
否 |
确定哪些声道可以作为音量输入。取值:
|
all |
VolumeRate |
number |
否 |
调节音频流的音量大小倍数。取值范围为0~10.0,默认值为1.0 。
|
1 |
MixList |
array |
否 |
位置关联列表,与 audiolayers 顺序保持一致。 |
RV01 |
string |
否 |
资源位置 LocationId 关联列表。 与 AudioLayers 顺序保持一致,若启用 Channel 时,引用 Channel 的 LocationId,否则引用视频源的 LocationId。 |
RV01 |
|
CasterId |
string |
是 |
导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。 |
LIVEPRODUCER_POST-cn-0pp1czt**** |
SceneId |
string |
是 |
场景 ID。如果您通过 DescribeCasterScenes 接口查询导播台场景列表,请查看 DescribeCasterScenes 接口调用返回的参数 ComponentId 值。 |
a2b8e671-2fe5-4642-a2ec-bf93880e1**** |
FollowEnable |
integer |
否 |
是否启用音频跟随。 默认启用音频跟随,为空则保持最近一次配置不变。取值:
|
1 |
请求参数中的 N 表示第几个的意思。例如:
AudioLayer.N.VolumeRate 表示传入第几个元素的音量倍数。
AudioLayer.1.VolumeRate 表示传入第 1 个元素的音量倍数。
AudioLayer.2.VolumeRate 表示传入第 2 个元素的音量倍数。
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
RequestId |
string |
请求 ID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
示例
正常返回示例
JSON
格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | InvalidCasterId.Malformed | %s | |
400 | InvalidUserId.Malformed | %s | |
400 | InvalidParameter.Malformed | %s | |
400 | InvalidAudioLayersAndMixListSize.Mismatch | %s | |
400 | IncorrectSceneStatus | %s | |
400 | IncorrectSceneStatus.ConfigError | %s | |
400 | InvalidMixList.ExceedNorm | %s | |
401 | IllegalOperation | %s | |
412 | ResourceInChannel.PreConditionFailed | %s | |
412 | ResourceInChannel.Invalid | %s | |
500 | InternalError | %s | |
404 | InvalidCaster.NotFound | %s | |
404 | InvalidScene.NotFound | %s | |
404 | ResourceInChannel.NotFound | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。