实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频服务端 API 参考输入在线媒体流更新在线媒体流输入 UpdateRelayStream
复制全文
下载 pdf更新在线媒体流输入 UpdateRelayStream
文档反馈
问问助手调用 UpdateRelayStream 接口，更新一个正在运行的在线媒体流输入任务的配置，如更换媒体流地址、调整视频参数或暂停 / 恢复播放（仅限点播流）。
注意事项
：QPS 不得超过 150。
请求频率：QPS 不得超过 150。
请求说明
- 请求方式：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 必选 示例值：66*****3cf
RTC 或 WTN 应用 ID。与 StartRelayStream 发起推送时设置的保持一致。
- RTC 应用 ID：在 RTC 控制台获取。
- WTN 应用 ID：在 WTN 控制台获取。
WtnStreamId String 可选 示例值：wtn_live_stream_01
需要更新的 WTN 流的 ID。
注意
仅更新 WTN 推流任务时必填。
TaskId String 可选 示例值：Task1
需要更新的任务 ID，需与 StartRelayStream 时设置的 TaskId 一致。
注意
仅更新 RTC 房间推流任务时必填。
RoomId String 可选 示例值：Room1
任务所在的房间 ID。
注意
仅更新 RTC 房间推流任务时必填。
Control Object 必选 示例值：-
新的媒体流控制参数。
StreamUrl String 必选 示例值：rtmp://xxx
在线流媒体地址。
- 支持的媒体格式为：hls、rtmp、mp4、flv、dash、ts 或 mp3。
- 如源流为海外，建议联系技术支持，以保障最佳体验。
MediaType Integer 可选 示例值：0
媒体类型。
- 0（默认值）：音视频。
- 1：音频。采用此选项时，必须是 AAC 或 Opus 编码。
- 2：视频。
StreamMode Integer 可选 示例值：0
流处理模式。
- 0（默认值）：转码。采用此选项时，原视频编码方式必须是 H.264 或 ByteVC1。
- 1：转封装。采用此选项时，原视频编码方式必须是 H.264。转封装时，源流的视频关键帧间隔若过大，会影响 RTC 体验，建议 1s，但最大不超过 5s。
StartTimeStamp Integer 可选 示例值：0
任务定时启动的 Unix 时间戳（秒），用于定时播放。
默认为 0，表示立即启动。
Loop Boolean 可选 示例值：false
是否循环播放，仅对源流为点播流时生效。默认为 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（默认值）：播放媒体流源文件。
在暂停状态下，不会触发 MaxIdleTime 任务空闲超时时间停止任务，因此暂停时也会正常计费。如果不再需要输入在线媒体流，可直接调用StopRelayStream 接口结束播放任务。
注意
该功能仅当媒体流为点播流且 StreamMode=0时生效。
Volume Integer 可选 示例值：100
在线媒体流播放音量，范围是 [0, 400]，单位为 %。
- 0：静音
- 100（默认值）：原始音量。
- 400：原始音量的 4 倍。
返回参数
其中返回值 Result 仅在请求成功时返回 ok，失败时为空。
请求示例
POST https://rtc.volcengineapi.com?Action=UpdateRelayStream&Version=2023-11-01
{
"AppId": "66****3cf",
"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": "20230604110420",
"Action": "UpdateRelayStream",
"Version": " 2023-11-01",
"Service": "rtc",
"Region": "cn-north-1"
}
}
错误码
最近更新时间：2026.08.19 17:27:18
这个页面对您有帮助吗？
有用
有用
无用
无用