建立 RTMP 串流在房間中的推流位址。
介面說明
呼叫此介面產生 RTMP 推流位址。
向 RTMP 位址推流,房間中的其他使用者可以看到此路串流。
停止推流,房間中的其他使用者看到推 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程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:CreateRoomRealTimeStreamAddress |
none |
*Rtc
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AppId |
string |
是 |
即時音訊視訊應用程式 ID,僅支援傳入單個 ID。由大小寫字母、數字、底線、短劃線(-)組成,最大 64 字元。透過存取 影片直播>直播+>即時音訊視訊>應用程式管理 可以檢視擁有的應用程式 ID,沒有時可以透過【建立應用程式】進行新建。 |
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. | 請求資源不存在,請檢查後重新嘗試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。