更新 WTN 流 UpdatePublicStreamParam--实时音视频-火山引擎

文档中心

立即注册

实时音视频

WTN 流

更新 WTN 流 UpdatePublicStreamParam

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，当需要对已发布的 WTN 流任务进行参数调整时，你可通过调用此接口实现。

指定应用标志、业务标识、WTN 流 ID 及媒体流目标列表，并配置转码模式、布局设置和编码参数，你将能够灵活更新 WTN 流的发布属性。调用后，接口将返回操作结果。

使用说明

接口行为

Control.MaxIdleTime和 VideoConfig.VideoCodec 无法通过该接口进行更新。

如果你在调用 UpdatePublicStreamParam 时，没有传入对应的参数值，那么，这部分参数将被更新为参数的默认值。

注意事项

请求频率：QPS 不得超过 150。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=UpdatePublicStreamParam&Version=2023-11-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdatePublicStreamParam`	接口名称。当前 API 的名称为 `UpdatePublicStreamParam`。
Version	String	是	`2023-11-01`	接口版本。当前 API 的版本为 `2023-11-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
BusinessId	String	否	`B****23`	业务标识
PublicStreamId	String	是	`PublicStream1`	WTN 流 ID。
TranscodeMode	Integer	否	`0`	WTN 流处理模式。支持取值及含义如下： `0`：转码。 `1`：转封装。当 `TranscodeMode`=`1` 时， `TargetStreams` 只能指定一路流，且该路流的 `UserId`不能为空，需为对应房间用户的 `UserId`。 `ExcludeStreams` 必须为空。 `Encode.VideoConfig` 设置不生效。 `Layout` 设置不生效。
TargetStreams	Object[]	是	`-`	为 WTN 流指定单路或多路媒体流及对应参数，Stream 数组。最高支持 17 路。
UserId	String	否	`user1`	媒体流的发布方的用户 ID。 `UserId` 为空时，表示订阅房间内所有流。 `UserId` 需全局唯一。不同房间内的 `UserId` 不能重复。
StreamType	Integer	否	`0`	流类型。支持取值及含义如下： `0`：音视频流 `1`：屏幕流默认值为 `0`。
Index	Integer	否	`1`	当选择自定义布局模式时，此字段必填。标记同一路 WTN 流中不同的媒体流。在同一个 `TargetStreams` 中，`Stream.Index` 是唯一的。
RoomId	String	是	`Room1`	发布 WTN 流的用户所在的房间 ID
MediaType	Integer	否	`0`	流的媒体类型。支持取值及含义如下： `0`：音视频 `1`：纯音频 `2`：纯视频默认值为 `0`。
ExcludeStreams	Object[]	否	`-`	你可以通过本参数排除掉不需要包含在 WTN 流中的音视频流，即黑名单。参数默认为空。黑名单中的流不得超过 17 路。此参数中的 `stream` 不应和 `TargetStreams` 中重复。
UserId	String	否	`user1`	媒体流的发布方的用户 ID。 `UserId` 为空时，表示订阅房间内所有流。 `UserId` 需全局唯一。不同房间内的 `UserId` 不能重复。
StreamType	Integer	否	`0`	流类型。支持取值及含义如下： `0`：音视频流 `1`：屏幕流默认值为 `0`。
Index	Integer	否	`1`	当选择自定义布局模式时，此字段必填。标记同一路 WTN 流中不同的媒体流。在同一个 `TargetStreams` 中，`Stream.Index` 是唯一的。
RoomId	String	是	`Room1`	发布 WTN 流的用户所在的房间 ID
MediaType	Integer	否	`0`	流的媒体类型。支持取值及含义如下： `0`：音视频 `1`：纯音频 `2`：纯视频默认值为 `0`。
Layout	Object	否	`-`	房间内多路流合为一路时的布局参数
LayoutMode	Integer	是	`0`	布局模式。支持取值及含义如下： `0`：自适应布局 `1`：：垂直布局 `2` ：自定义布局 `3` ：并排布局默认值为`0`
VerticalLayout	Object	否	`-`	垂直布局参数
CustomLayout	Object	否	`-`	自定义布局参数
Encode	Object	否	`-`	媒体编码参数
VideoConfig	Object	否	`-`	视频编码配置
Control	Object	否	`-`	控制选项。
MaxIdleTime	Integer	否	`180`	任务的空闲超时时间，超过此时间后，任务自动终止。取值范围为 `[10, 86400]`，单位为秒，默认值为 `180`。只在调用 `StartPushPublicStream` 时有效。
DataMsg	String	否	`-`	插入 WTN 流的自定义信息，可用于随流信息同步，长度不超过 4 kB。数据会添加到当前视频帧开始的连续 30 个视频帧中。只在调用 `UpdatePublicStreamParam` 时有效。
UserCaptureStatsMode	Boolean	否	`false`	是否开启房间用户采集状态回调。开启后会通过 `onPublicStreamDataMessageReceived` 回调。 `true`：开启房间用户采集状态回调。 `false`：不开启房间用户采集状态回调。默认值为`false`。
VolumeIndicationMode	Boolean	否	`false`	是否开启音量指示模式。 `true`：开启音量提示。 `false`：不开启音量提示。默认值为`false`。
StreamPublishStatsMode	Boolean	否	`false`	是否开启房间用户发布状态回调。开启后会通过 `onPublicStreamDataMessageReceived` 回调。 `true`：开启房间用户发布状态回调。 `false`：不开启房间用户发布状态回调。默认值为`false`。
UserCaptureStatsInterval	Integer	否	`2000`	房间用户采集状态回调间隔，仅在纯音频时生效。取值范围为 `[1000,2147483647]`，单位为毫秒，默认值为 `2000`。
VolumeIndicationInterval	Integer	否	`2000`	音量指示的回调间隔。最小值为 `100`，单位为毫秒，默认值为 `2000`。 VideoConfig.FrameRate 大于 10 fps 时，回调间隔才能达到 100ms。
StreamPublishStatsInterval	Integer	否	`2000`	房间用户发布状态回调间隔，仅在纯音频时生效。取值范围为 `[1000,2147483647]`，单位为毫秒，默认值为 `2000`。

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。

请求示例

POST https://rtc.volcengineapi.com?Action=UpdatePublicStreamParam&Version=2023-11-01
{
    "AppId": "661e****543cf",
    "BusinessId": "B****23",
    "TranscodeMode": 0,
    "TargetStreams": [
        {
            "Index": 0,
            "UserId": "user1_3",
            "RoomId": "Room1",
            "StreamType": 1,
            "MediaType": 0
        },
        {
            "Index": 1,
            "UserId": "user1_3",
            "RoomId": "Room1",
            "StreamType": 1,
            "MediaType": 0
        }
    ],
    "Encode": {
        "VideoConfig": {
            "Width": 640,
            "Height": 480,
            "FrameRate": 15,
            "Bitrate": 256
        }
    },
    "Layout": {
        "LayoutMode": 2,
        "CustomLayout": {
            "Regions": [
                {
                    "StreamIndex": 0,
                    "LocationX": 0,
                    "LocationY": 0,
                    "WidthProportion": 0.5,
                    "HeightProportion": 1,
                    "ZOrder": 0,
                    "Alpha": 1,
                    "RenderMode": 0
                },
                {
                    "StreamIndex": 1,
                    "LocationX": 0.5,
                    "LocationY": 0,
                    "WidthProportion": 0.5,
                    "HeightProportion": 1,
                    "ZOrder": 1,
                    "Alpha": 1,
                    "RenderMode": 1,
                    "AlternateImage": "https://xx.com/img/1.jpg",
                    "SourceCrop": {
                        "LocationX": 500,
                        "LocationY": 0,
                        "WidthProportion": 0.5,
                        "HeightProportion": 0.5
                    }
                }
            ],
            "FrameInterpolationMode": 0,
            "BackgroundColor": "#000000",
            "BackgroundImage": "https://xx.com/img/1.jpg"
        }
    },
    "Control": {
        "DataMsg": "CamInfo"
    }
}

返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "UpdatePublicStreamParam",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2025.11.20 12:46:05

这个页面对您有帮助吗？

有用

无用