StartStreamingOut_音视频通信_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

本接口用于开始在线频道旁路推流任务。

QPS 限制

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
rtc:StartStreamingOut
Create
App
acs:rtc:*:{#accountId}:app/{#AppId}

请求参数

字段名称字段详情
AppIdstring

应用 ID,通过控制台创建和查询,仅支持传单个 ID。

示例值:eo85****
ChannelIdstring

已存在的频道 ID,仅支持传单个 ID。

示例值:testid参考取值来源:
    DescribeRtcChannelList
TemplateIdstring

模版 ID。

示例值:567正则:^[\w.-]+$参考取值来源:
    AddRecordTemplate
    UpdateRecordTemplate
    DescribeRecordTemplates
    CreateAppRecordTemplate
    ModifyAppStreamingOutTemplate
字符长度 <= 128字符长度 >= 1
Urlstring

直播推流地址,仅支持传单个地址。该地址不可多个任务同时使用。

示例值:rtmp://example.com/live/stream字符长度 <= 1024字符长度 >= 1
TaskIdstring

本次旁路推流的任务 ID,仅支持传单个 ID。由大小写字母、数字、下划线、短划线(-)组成,最大 55 字节,不填,则由系统自动生成。

示例值:123正则:^[0-9a-zA-Z_-]+$字符长度 <= 55字符长度 >= 1
CropModeinteger<int32>

裁剪方式。取值:展开详情

示例值:2枚举值:123
ReservePaneForNoCameraUserboolean

未推摄像头流用户窗格占位。展开详情

StartWithoutChannelboolean

是否允许频道不存在时开启任务。展开详情

StartWithoutChannelWaitTimeinteger<int32>

当 StartWithoutChannel 参数为 true 的时候,设置该值才有意义,表示房间未开启时,任务等待时长,单位为秒,区间限制为[30,120]。

示例值:30
Panesarray<object>

单元格设置。

示例值:eo85****子级条数 <= 16
Backgroundsarray<object>

背景图片。

子级条数 <= 3
Imagesarray<object>

全局图片水印。

示例值:30子级条数 <= 3
Textsarray<object>

全局文字水印。

子级条数 <= 3
ClockWidgetsarray<object>

全局时钟水印。

子级条数 <= 3
RegionColorobject

全局框格底色

LayoutSpecifiedUsersobject

布局生成用户指定列表,包括黑/白名单两种。展开详情

请求说明

注意 相关补充

局部图片水印数量、全局图片水印数量和全局背景图数量的总和不能超过 16。

高级水印层次说明
RTC 媒体服务器 生成的画面会分成以下几个步骤:

绘制视频 -> 绘制图片 -> 绘制文字

视频、图片、文字是完全分开的,从整个画面来看 文字优先级 > 图片 > 视频

  1. 绘制视频: 根据客户定义的布局对视频画面进行布局

    a. 宫格中的图片和全局图片的 layer 统一排列。

    b. layer 0 位于最底层,layer 越大越位于上方,layer 的取值范围为[0,100] 。

  2. 绘制图片 图片包括用户自定义的 png/jpg 图片。

    a. 根据用户配置宽高、位置、透明度等信息进行绘制。

    b. layer 0 位于最底层,layer 越大越位于上方,layer 的取值范围为[0,100] 。

  3. 绘制文字 文字分为 3 个类型 : 区域文字 全局文字和时间戳文字 。

    a. 同一类型文字根据 layer 顺序绘制,layer 0 位于最底层,layer 越大越位于上方,layer 的取值范围为[0,100] 。

    b. 不同类型文字优先级为 : 时间戳文字 > 全局文字 > 区域文字 。处于重叠位置时,优先级较低的将被覆盖。

重叠部分的显示:

  1. 重叠部分,如果没有特别配置,高优先级将覆盖低优先级 。
  2. 低优先级内容如果不想被高优先级内容覆盖,可以设置高优先级内容的透明度属性为 0。

返回参数

字段名称字段详情
TaskIdstring

本次旁路推流的任务 ID。

示例值:123
RequestIdstring

请求 ID。

示例值:16A96B9A-F203-4EC5-8E43-CB92E68F4CF8

返回示例

变更历史

变更时间变更内容概要操作
2025-02-21
变更请求参数Panes
新增请求参数ReservePaneForNoCameraUser
新增请求参数StartWithoutChannel
新增请求参数StartWithoutChannelWaitTime
2025-02-12
变更请求参数Panes
2024-12-16
新增请求参数LayoutSpecifiedUsers
2024-11-06
新增请求参数Backgrounds
新增请求参数RegionColor
2024-03-20
变更请求参数Panes
变更请求参数AppId
变更请求参数ChannelId
变更请求参数TemplateId
变更请求参数Url
变更请求参数TaskId

相关示例