You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/实时音视频/服务端 API 参考/输入在线媒体流/更新在线媒体流输入 UpdateRelayStream
更新在线媒体流输入 UpdateRelayStream
最近更新时间：2025.09.12 11:24:49首次发布时间：2024.01.03 20:25:17
复制全文
我的收藏
有用
有用
无用
无用

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

更新一个已在 RTC 房间或 WTN 网络中运行的在线媒体流任务的参数配置，例如在线媒体流地址、视频配置等。

调用后，接口将返回操作结果，确保媒体流的更新操作成功完成。

注意事项

请求说明

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

调试

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

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
AppId
String
是
661e****543cf

RTC 或 WTN 应用 ID。根据推送的目标不同，获取方式不一样：

WtnStreamId
String
否
wtn_live_stream_01

更新 WTN 推流任务时必填。

需要更新的 WTN 流的 ID。
RoomId
String
否
Room1

更新 RTC 房间任务时必填。

任务所在的房间 ID。
TaskId
String
否
Task1

更新 RTC 房间任务时必填。

需要更新的任务 ID，需与 StartRelayStream 时设置的 TaskId 一致。
Control
Object
是
-
新的媒体流控制参数。
StreamUrl
String
是
rtmp://xxx

在线流媒体地址。

  • 支持的媒体格式为：hls、rtmp、mp4、flv、dash、或 ts。
  • 如源流为海外，建议联系技术支持，以保障最佳体验。
MediaType
Integer
否
0

媒体类型。

  • 0：音视频。
  • 1：音频。采用此选项时，必须是 AAC 或 Opus 编码。
  • 2：视频。
默认值为 0。
StreamMode
Integer
否
0

流处理模式。

  • 0：转码。采用此选项时，原视频编码方式必须是 H.264 或 ByteVC1。
  • 1：转封装。采用此选项时，原视频编码方式必须是 H.264。转封装时，源流的视频关键帧间隔若过大，会影响 RTC 体验，建议 1s，但最大不超过 5s。
默认值为 0。
StartTimeStamp
Integer
否
0

任务定时启动的 Unix 时间戳（秒），用于定时播放。

默认为 0，表示立即启动。
Loop
Boolean
否
False
是否循环播放，仅对源流为点播流时生效。
VideoWidth
Integer
否
640
视频宽度。转码时必填。
单位为像素，范围为 [16, 1920]，必须是偶数，值为奇数时自动调整为偶数。
VideoHeight
Integer
否
480
视频高度，转码时必填。
单位为像素，范围为 [16, 1920]，必须是偶数，值为奇数时自动调整为偶数。
FrameRate
Integer
否
15
发送帧率，值的范围为 [1，30]，默认值为 15，转码时生效。
Bitrate
Integer
否
6000
最大发送码率，单位为 Kbps，不填则不限制，转码时生效。
IsPause
Boolean
否
false

是否暂停播放媒体流源文件：

  • true：暂停播放媒体流源文件。
  • false：播放媒体流源文件。

默认值为 false。

在暂停状态下，不会触发 MaxIdleTime 任务空闲超时时间停止任务，因此暂停时也会正常计费。如果不再需要输入在线媒体流，可直接调用 StopRelayStream 接口结束播放任务。

注意

该功能仅当媒体流为点播流且 StreamMode=0 时生效。

SeekPosition
Integer
否
0

指定点播文件的播放位置（秒），必须小于音视频时长。

默认值为 0，表示从点播文件起始位置播放。

注意

该功能目前在灰度中，如需使用请联系技术支持。

返回参数

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

请求示例

POST https://rtc.volcengineapi.com?Action=UpdateRelayStream&Version=2023-11-01
{
    "AppId": "661e****543cf",
    "RoomId": "Room1",
    "TaskId": "Task1",
    "Control": {
        "StreamUrl": "rtmp://xxx",
        "MediaType": 0,
        "StreamMode": 0,
        "StartTimeStamp": 0,
        "Loop": false,
        "VideoWidth": 640,
        "VideoHeight": 480,
        "FrameRate": 15,
        "Bitrate": 6000
    }
}

返回示例

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

错误码

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