CreateRoomRealTimeStreamAddress - 创建RTMP流在房间中的推流地址

创建RTMP流在房间中的推流地址。

接口说明

  1. 调用此接口生成 RTMP 推流地址。

  2. 向 RTMP 地址推流,房间中的其他用户可以看到此路流。

  3. 停止推流,房间中的其他用户看到推 RTMP 流的用户离开房间。

说明
  • 在 RTMP 地址有效期内可以重复步骤 2、3。

  • 建议配合调用 DescribeChannelParticipants 查询频道用户列表,定时间隔的检查推 RTMP 流的用户是否还在房间中。如果不在,可能推流中断,建议停止推流再转到步骤 2 重推。

注意事项

在使用实时音视频时,需要通过阿里云 ARTC SDK 进行入会并推送 RTC 的流。但在部分特殊场景下,阿里云允许您使用 RTMP 协议推流(如 OBS 推流),并由阿里云将 RTMP 转换成 RTC 流进行推送和实现用户入会。您可以通过本接口实现该能力,本接口将为您生成 RTMP 推流地址,当您完成推流后阿里云将自动将流转换成 RTC 流。 若您的业务是纯直播场景时,请勿使用该接口,您可以参见生成推流地址和播放地址快速实现 RTMP 推流和直播播放。

QPS 限制

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:CreateRoomRealTimeStreamAddress

none

*Rtc

acs:live::{#accountId}:rtc/{#AppId}

请求参数

名称

类型

必填

描述

示例值

AppId

string

实时音视频应用 ID,仅支持传单个 ID。由大小写字母、数字、下划线、短划线(-)组成,最大 64 字符。

yourAppId

ChannelId

string

要加入的房间 ID,仅支持传单个 ID。由大小写字母、数字、下划线、短划线(-)组成,最大 64 字符。

yourChannelId

UserId

string

向 RTMP 地址推流的用户 ID,不能和房间中的其他用户 ID 重复。由大小写字母、数字、下划线、短划线(-)组成,最大 64 字符。

rtmp-uuid

DisplayName

string

RTMP 流在房间中显示的名称,最大 40 字符。

rtmp-dname

ExpireTime

integer

RTMP 地址有效时长,单位:秒,默认值 36000,即 10 小时。

43200

返回参数

名称

类型

描述

示例值

object

返回参数。

RequestId

string

请求 ID。

F8DB7E25-6A35-161A-AA41-B7A658AF****

RtmpAddress

string

RTMP 推流地址。

rtmp://rtcpush****.rtmp.alivecdn.com/rtcdev****/H4sIAAAA****_6pWSlayUipJLS5R0lEqRTBTEMwiJSul1CRTMxNjsyQTM****-PUZCMz8yTDZLNkAwMDA6M0I0ulWgA****__wEAAP__a_e7YkkAAAA?auth_key=1700492701-6e33-0-c6d7e3a93dc2dbe3af42f6259ccd****

示例

正常返回示例

JSON格式

{
  "RequestId": "F8DB7E25-6A35-161A-AA41-B7A658AF****",
  "RtmpAddress": "rtmp://rtcpush****.rtmp.alivecdn.com/rtcdev****/H4sIAAAA****_6pWSlayUipJLS5R0lEqRTBTEMwiJSul1CRTMxNjsyQTM****-PUZCMz8yTDZLNkAwMDA6M0I0ulWgA****__wEAAP__a_e7YkkAAAA?auth_key=1700492701-6e33-0-c6d7e3a93dc2dbe3af42f6259ccd****"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InputInvalid %s. 输入参数不合法
500 ServerError %s. 未知错误,请稍后重试或提交工单咨询。
403 NoAuth %s. 没有权限
404 ResourceNotExist %s. 请求资源不存在,请检查后重新尝试

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情