TaskId

String

否

Your_TaskId

要查询的转推直播任务 ID。通过服务端发起时，该值为调用 OpenAPI 时传入的 TaskId。通过客户端 SDK 发起时，TaskId 是按照 userId@@taskId 格式拼接而成的字符串；当传入的 taskId 为空时，这里的 TaskId 为 userId。
TaskId 和 UserId 均为非必填参数，但是你需要至少填一个参数以保证可以正常发起请求。

UserId

String

否

Your_UserId

客户端发起转推任务的用户 ID。
你在客户端发起多个任务，当使用该接口进行查询时：

• 查询第一个任务时，UserId 可以传入发起转推任务的用户 UserId，TaskId 传入空字符串；或直接将该用户的 UserId 传入 TaskId。
• 查询第二个以上任务时，UserId 和 TaskId 为发起转推任务的用户 UserId 和 TaskId。

Status

Long

3

任务状态。

• 0：未知异常状态
• 1：未开始
• 2： 运行中
• 3： 已结束
• 4： 任务运行失败

StopReason

String

StopByAPI

任务停止的原因

• 返回为空：表示任务未结束
• UnknownStopReason：未知停止原因
• StopByAPI：用户主动调用 服务端 OpenAPI 停止
• StartTaskFailed：任务启动失败
• IdleTimeOut：任务超过最大空闲时间
• UserDisconnect：客户端用户主动退房/调用停止转推接口

PushStreamState

Integer

6

推流状态

• 0：运行中，未获取到任务状态，建议稍后重新查询
• 1：未开始推流
• 2：首次连接 CDN 服务
• 3：正在重连 CDN 服务
• 4：连接 CDN 服务成功，正在尝试推流。
• 5：连接 CDN 服务成功，推流成功
• 6：已停止推流。
  仅当Status=2 时，PushStreamState 有实际意义；当Status=3 时，PushStreamState=6; status 为其他值时，PushStreamState 均为0。

VideoBitrate

Integer

/

输出视频码率。取值范围 [1,10000]，单位为 Kbps，默认值为自适应。值不合法时，自动调整为默认值。
自适应码率模式下，RTC 默认不会设置超高码率。如果订阅屏幕流，建议自行设置高码率。不同场景下设置码率等视频发布参数,请参考设置视频发布参数。

AudioProfile

Integer

0

音频配置文件类型，在使用 aac 编码时生效。取值范围为 {0, 1, 2}。

• 0 :采用 LC 规格；
• 1: 采用 HE-AAC v1 规格；
• 2: 采用 HE-AAC v2 规格。取 2 时，只支持输出流音频声道数为双声道。
  默认值为 0。

AudioBitrate

Integer

/

音频码率。取值范围为 [32,192],单位为 Kbps，默认值为 64，值不合法时，自动调整为默认值。
当AudioProfile=0时：
若输入参数取值范围为 [32,192]，编码码率等于输入码率。
当AudioProfile=1时：

• 若输入参数取值范围为 [32,128]，编码码率等于输入码率。
• 若输入参数取值范围为 [128,192]，编码码率固定为128。
  当AudioProfile=2时：
• 若输入参数取值范围为 [32,64]，编码码率等于输入码率。
• 若输入参数取值范围为 [64,192]，编码码率固定为64。

AudioChannels

Integer

2

音频声道数。

• 1：单声道
• 2：双声道。
  默认值为 2。值不合法时，自动调整为默认值。

LayoutMode

Integer

0

布局模式。默认值为 0，值的范围为 {0, 1, 2, 3}。

• 0 为自适应布局模式。参看自适应布局。
• 1 为垂直布局模式。参看垂直布局。
• 2 为自定义布局模式。
• 3 为并排布局模式。参看并排布局

FrameInterpolationMode

Integer

0

选择补帧模式。默认值为0，可以取0和1。0为补最后一帧，1为补黑帧。值不合法时会自动调整为默认值。
自动布局模式下，没有补帧的逻辑。
补帧是指在音视频录制或合流转推时，视频的帧率通常是固定的。但是，因为网络波动或其他原因，实际帧率可能无法达到预设的帧率。此时，需要补帧以保持视频流畅。补最后一帧意味着补充的视频帧和中断前的最后一帧相同，此时看到的画面可能会有短暂静止；补黑帧意味着补充的视频帧是全黑的。
使用占位图、补帧和上一帧的关系:
你可以在 Region 中传入 Alternateimage 字段设置占位图,在 Control 中传入FrameInterpolationMode 字段设置补帧模式,但占位图优先级高于补帧模式。

• 在 Region.StreamIndex 对应的视频流停止发布时, Region 对应的画布空间会根据设置填充占位图或补帧。但当视频流为屏幕流时，补帧模式不生效。
• 当 Region.StreamIndex 对应的视频流发布后停止采集或推送时, Region 对应的画布空间会填充上一帧。
• 当 Region.StreamIndex 对应的视频流发布时,设置的占位图或补顿模式不造成任何影响。

PushStreamMode

Integer

0

转推直播推流模式，用于控制触发推流的时机。取值为0或1。默认值为0。

• 0：房间内有用户推 RTC 流时即触发 CDN 推流。
• 1：调用接口发起推流任务后，无论房间内是否有用户推 RTC 流,均可触发 CDN 推流。
  值不合法时，自动调整为默认值。
  任务超时逻辑不变，依然是无用户推流即判定为超时。

Regions

Array of Region

在自定义布局模式下，你可以使用 Regions 对每一路视频流进行画面布局设置。其中，每个 Region 对一路视频流进行画面布局设置。
自定义布局模式下，对于 StreamList 中的每个 Stream，Regions 中都需要给出对应的布局信息，否则会返回请求不合法的错误。即 Regions.Region.StreamIndex 要与 TargetStreams.StreamList.Stream.Index 的值一一对应，否则自定义布局设置失败，返回 InvalidParameter 错误码。

当传入的必填参数值不合法时，返回错误码 InvalidParameter 。
当传入的选填参数值不合法时，自动调整为默认值。

PassthroughRTCSEIMessage

Boolean

true

是否透传 RTC 流里的 SEI 信息。

• true：是。
• false：否。
  默认值为 true。

VolumeIndicationMode

Boolean

false

(仅对转推直播有效）是否开启音量指示模式。

• true：是。此时非关键帧中也可能携带 SEI 信息。
• false：否。此时只会在关键帧中携带 SEI 信息。
  默认值为 false。
  若 VolumeIndicationMode = true 的同时设置 MediaType = 1，该流推向 CDN 地址时，服务端会补黑帧。 关于音量指示模式的用法，参看 音量指示模式。

AddVolumeValue

Boolean

false

SEI 中是否包含用户说话音量值。

• false：否。
• true：是。
  默认值为 false。值不合法时自动调整为默认值。

SEIContentMode

Integer

0

开启音量指示模式后，非关键帧携带 SEI 包含的信息类型。

• 0：全量信息。
• 1：只有音量信息和时间戳。
  关于 SEI 结构，参看服务端合流转推 SEI 结构

SEIPayloadUUID

String

566f6c63656e67696e65525443534549

该字段为长度为 32 位的 16 进制字符，每个字符的范围为 a-f，A-F，0-9，不可包含 -。如果校验失败，会返回错误码 InvalidParameter。
仅当 SEIPayLoadType=5时，该字段需要填写，SEIPayLoadType=100时，该字段内容会被忽略。
此参数仅对 RTC 透传SEI 生效。当用户设置 SEIPayloadType = 5 时，服务端合流转推SEI 的 SEIPayloadUUID 为固定值：566f6c63656e67696e65525443534549，对应16位字符串 VolcengineRTCSEI。

BackgroundImage

String

/

背景图片的 URL。长度最大为 1024 byte。可以传入的图片的格式包括：JPG, JPEG, PNG。如果背景图片的宽高和整体屏幕的宽高不一致，背景图片会缩放到铺满屏幕。
如果你设置了背景图片，背景图片会覆盖背景色。

LocationX

Integer

0

视频流对应区域左上角的横坐标相对整体画面左上角原点的横向位移，取值的范围为 [0.0, Canvas.Width)。默认值为 0。若传入该参数，服务端会对该参数进行校验，若不合法会返回错误码 InvalidParameter。
视频流对应区域左上角的实际坐标是通过画面尺寸和相对位置比例相乘，并四舍五入取整得到的。假如，画布尺寸为1920, 视频流对应区域左上角的横坐标相对整体画面的比例为 0.33，那么该画布左上角的横坐标为 634（1920*0.33=633.6，四舍五入取整）。

RenderMode

Integer

0

画面的渲染模式，值的范围为 {0, 1, 2，3}, 默认值为 0：

• 0 表示按照指定的宽高直接缩放。如果原始画面宽高比与指定的宽高比不同，就会导致画面变形
• 1 表示按照显示区域的长宽比裁减视频，然后等比拉伸或缩小视频，占满显示区域。
• 2 表示按照原始画面的宽高比缩放视频，在显示区域居中显示。如果原始画面宽高比与指定的宽高比不同，就会导致画面有空缺，空缺区域为填充的背景色值。
• 3 表示按照指定的宽高直接缩放。如果原始画面宽高比与指定的宽高比不同，就会导致画面变形
  值不合法时，自动调整为默认值。
  目前 0 和 3 均为按照指定的宽高直接缩放，但我们推荐你使用 3 以便与客户端实现相同逻辑。
  不同渲染模式下，效果如下：

AlternateImage

String

rtmp://xxx.xxx

补位图片的 url。长度不超过 1024 个字符串。

• 在 Region.StreamIndex 对应的视频流没有发布，或被暂停采集时，AlternateImage 对应的图片会填充 Region 对应的画布空间。当视频流被采集并发布时，AlternateImage 不造成任何影响。
• 可以传入的图片的格式包括：JPG, JPEG, PNG。
• 当图片和画布尺寸不一致时，图片根据 RenderMode 的设置，在画布中进行渲染。

ApplySpatialAudio

Boolean

/

该路流对应的用户是否开启空间音频效果。

• true：开启空间音频效果。
• false：关闭空间音频效果。
  默认值为 true

MediaType

Integer

0

该路流参与混流的媒体类型。

• 0：音视频
• 1：纯音频
• 2：纯视频
  默认值为 0。值不合法时，自动调整为默认值。
  
  假如该路流为音视频流，MediaType设为1，则只混入音频内容。

AlternateImageFillMode

Integer

0

画面的渲染模式。

• 0：按照用户原始视频帧比例进行缩放
• 1：保持图片原有比例
  默认值为 0。值不合法时，自动调整为默认值。