UpdateCasterSceneAudio - 更新场景音频配置

增加场景音频配置,将原场景音频添加到新场景。

接口说明

使用说明

先通过 CreateCaster 接口创建导播台,再调用本接口更新场景音频配置。本接口目前支持的音频模式为混音模式和音频跟随视频模式。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:UpdateCasterSceneAudioupdate
  • Caster
    acs:live:*:{#accountId}:caster/{#CasterId}

请求参数

名称类型必填描述示例值
AudioLayerarray<object>

音频配置。

object
Filterstring

3A 美音算法开关。该参数由以下字段组成:

  • enableAgc:(可选)3A 算法的智能增益算法开关。0:不开启(默认值); 1:开启。

  • enableAns:(可选)3A 算法的智能降噪算法开关。0:不开启(默认值);1:开启。

  • ansMode:(可选)智能降噪算法的模式,该字段只有在 enableAns 取值为 1 时有效。0:语音降噪(默认值);1:音乐降噪。

说明 为保证更好的降噪效果,建议将 ansMode 取值为 1:音乐降噪。
  • enableBeautify:(可选)美声处理开关。 0:不开启(默认值);1:开启。

  • voiceBeautifyMode:(可选)美声模式,该字段只有在 enableBeautify 取值为 1 时有效。0:磁性男声(默认值);1:清新女声。

{ "enableAgc":0, "enableAns":1 }
FixedDelayDurationinteger

该字段对视频进行固定延迟设置,可用于字幕同步。

单位:毫秒。取值范围为0~5000。默认值为 0

0
ValidChannelstring

确定哪些声道可以作为音量输入。取值:

  • leftChannel:左声道。
  • rightChannel:右声道。
  • all(默认值):双声道。
all
VolumeRatefloat

调节音频流的音量大小倍数。取值范围为0~10.0,默认值为1.0

  • 1.0:保持原有音量。
  • 小于 1:降低音量的倍数。
  • 大于 1:放大音量的倍数。
1
MixListarray

位置关联列表,与 audiolayers 顺序保持一致。

string

资源位置 LocationId 关联列表。

与 AudioLayers 顺序保持一致,若启用 Channel 时,引用 Channel 的 LocationId,否则引用视频源的 LocationId。

RV01
CasterIdstring

导播台 ID。

  • 如果您通过 CreateCaster 接口创建导播台,请查看 CreateCaster 接口调用返回的参数 CasterId 值。

  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。

说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
LIVEPRODUCER_POST-cn-0pp1czt****
SceneIdstring

场景 ID。如果您通过 DescribeCasterScenes 接口查询导播台场景列表,请查看 DescribeCasterScenes 接口调用返回的参数 ComponentId 值。

a2b8e671-2fe5-4642-a2ec-bf93880e1****
FollowEnableinteger

是否启用音频跟随。 默认启用音频跟随,为空则保持最近一次配置不变。取值:

  • 0:混音模式。
  • 1:音频跟随视频模式。
1

请求参数中的 N 表示第几个的意思。例如:

  • AudioLayer.N.VolumeRate 表示传入第几个元素的音量倍数。
  • AudioLayer.1.VolumeRate 表示传入第 1 个元素的音量倍数。
  • AudioLayer.2.VolumeRate 表示传入第 2 个元素的音量倍数。

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

错误码

HTTP status code错误码错误信息
400InvalidCasterId.Malformed%s
400InvalidUserId.Malformed%s
400InvalidParameter.Malformed%s
400InvalidAudioLayersAndMixListSize.Mismatch%s
400IncorrectSceneStatus%s
400IncorrectSceneStatus.ConfigError%s
400InvalidMixList.ExceedNorm%s
401IllegalOperation%s
404InvalidCaster.NotFound%s
404InvalidScene.NotFound%s
404ResourceInChannel.NotFound%s
412ResourceInChannel.PreConditionFailed%s
412ResourceInChannel.Invalid%s
500InternalError%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-06OpenAPI 错误码发生变更查看变更详情