2.4. 直播 REST API?

2.4.1. 版本信息?

v1.0.0, 2017/06/28

2.4.2. 創建直播?

請求說明: http://xx.yy.zz:8050/avd/api/live/createUserLive HTTP/1.1

接口描述: 創建房間的一個用戶直播,僅為方便對某一用戶的直播

接口實例: http://127.0.0.1:8050/avd/api/live/createUserLive?accessToken=NjBhMTM1YjZlMzIyNGM3NjkwNmFiZTVjMDRkNWVkNjViYzQ4ODRlOQ==

GET參數?
參數 類型 必須 說明
accessToken String 認證成功后根據規則生成的串
POST參數?
參數 類型 必須 說明
name String 記錄名稱
tag String 記錄標記
roomId String 所屬房間號
userId String 用戶ID,唯一
audioType String 音頻類型 [1]
videoType String 視頻類型 [2]
publishurl String (可選)若存在,服務器優先推送此地址
rtmpurl String rtmp 地址
hlsurl String hls 地址

返回說明:

http 響應:json
{
        result: "0"
        data: {
            "id" : "b40ef09b-3811-4726-b508-e41a0f96c68f",
            "roomId" : "room-3811-4726-b508",
            "name" : "Foo",
            "createTime" : "2015-07-23 20:05:52",
            "status ":0
            "rtmpurl" : "http://rtmp.3tee.cn/b40ef09b-3811-4726-b508-e41a0f",
            "hlsurl" : "http://hls.3tee.cn/b40ef09b-3811-4726-b508-e41a0f96c68f"
        }
}

主要返回碼: 0,

返回值說明:

id:記錄號,直播創建的時候產生,唯一標識一個直播的記錄 roomId:房間號 name:直播名稱 createTime: 創建時間 status: 直播記錄狀態 [4] rtmpurl:rtmp地址 hlsurl:hls地址

2.4.3. 停止直播?

請求說明: http://xx.yy.zz:8050/avd/api/live/stop HTTP/1.1

接口描述: 暫停一個直播頻道

接口實例: http://127.0.0.1:8050/avd/api/record/stop?id=asdfasdfasdf&accessToken=YmE4ZDg4YTY5NGMzZWMwZWMzNjQ1MWRiZGQwMDlmOTZiNWQxMDVkNg==

GET參數?
參數 類型 必須 說明
accessToken String 認證成功后根據規則生成的串
id String 記錄ID

返回說明:

http 響應:json
{
    "ret": 0,
    data: {
            "id" : "b40ef09b-3811-4726-b508-e41a0f96c68f",
            "status" : 2
        }
}

主要返回碼: 0,

返回值說明:

id:記錄號,直播創建的時候產生,唯一標識一個直播的記錄

status: 直播記錄狀態 [4]

2.4.4. 獲取一個直播頻道信息?

請求說明: http://xx.yy.zz:8050/avd/api/live/getLive HTTP/1.1

接口描述: 獲取一個直播頻道信息

接口實例: http://127.0.0.1:8050/avd/api/live/getLive?accessToken=NjBhMTM1YjZlMzIyNGM3NjkwNmFiZTVjMDRkNWVkNjViYzQ4ODRlOQ==&id=cfe0ea64-005d-4353-b2f5-91d7fad7c815

GET參數?
參數 類型 必須 說明
accessToken String 認證成功后根據規則生成的串
id String 記錄ID

返回說明:

http 響應:json
{
    "ret": 0,
    data: {
            "id" : "b40ef09b-3811-4726-b508-e41a0f96c68f",
            "roomId" : "room-3811-4726-b508",
            "name" : "Foo",
            "createTime" : "2015-07-23 20:05:52"
            "duration" : 5049,
            "audioType" : 1,
            "videoType" : 1,
            "size" : 247748791,
            "status" : 2,
            "rtmpurl" : "http://rtmp.3tee.cn/b40ef09b-3811-4726-b508-e41a0",
            "hlsurl" : "http://hls.3tee.cn/b40ef09b-3811-4726-b508-e4"
        }
}

主要返回碼: 0,

返回值說明:

id:記錄號,直播創建的時候產生,唯一標識一個直播的記錄

roomId:房間ID

name:直播名稱

createTime:記錄創建時間,cst時間

duration:記錄時長,秒

audioType:音頻類型 [1]

videoType:視頻類型 [2]

size:記錄文件大小

status: 直播記錄狀態 [4]

rtmpurl:rtmp 地址

hlsurl: hls 地址

2.4.5. 刪除直播記錄?

請求說明: http://xx.yy.zz:8050/avd/api/live/delete HTTP/1.1

接口描述: 刪除一個直播頻道

接口實例: http://127.0.0.1:8050/avd/api/live/delete?id=7a45d20e-3eda-4c13-be42-1899d376d268&accessToken=YmE4ZDg4YTY5NGMzZWMwZWMzNjQ1MWRiZGQwMDlmOTZiNWQxMDVkNg==

GET參數?
參數 類型 必須 說明
accessToken String 認證成功后根據規則生成的串
id String 記錄ID

返回說明:

http 響應:json
{
    "ret": 0,
    data: {
            "id" : "b40ef09b-3811-4726-b508-e41a0f96c68f",
            "status" : 2
        }
}

主要返回碼: 0,

返回值說明:

id:記錄號,直播創建的時候產生,唯一標識一個直播的記錄

status: 直播記錄狀態 [4]

2.4.6. 查詢直播記錄?

請求說明: http://xx.yy.zz:8050/avd/api/live/findLives HTTP/1.1

接口描述: 獲取當前的直播頻道列表

接口實例: http://127.0.0.1:8050/avd/api/live/findLives?accessToken=YmE4ZDg4YTY5NGMzZWMwZWMzNjQ1MWRiZGQwMDlmOTZiNWQxMDVkNg==&begin=1&count=4&filter={“fromTime”:”2017-06-03”,”endTime”:”2017-06-29”,”roomId”:”r5”,”userId”:”testLive”} .. csv-table:: GET參數

header:“參數”, “類型”, “必須”, “說明”
widths:30, 30, 20, 60

“accessToken”, “String”, “是”,”認證成功后根據規則生成的串” “begin”, “int”, “否”,”從第幾條記錄開始” “count”, “int”, “否”,”取幾條記錄” “filter”, “JSON”, “否”,”JSON對象,過濾參數信息”

Filter參數?
參數 類型 必須 說明
fromTime date 篩選直播起始時間(這個時間之后),格式是yyyy-mm-dd
endTime date 篩選直播停止時間(這個時間之前),格式是yyyy-mm-dd
roomId String 篩選直播的房間id
userId String 篩選直播的用戶id

返回說明:

http 響應:json
{
    "ret": 0,
    data: {
                    "total" : 21,
                        "begin" : 5,
                        "count" : 6,
                        "items" : [
                                {
                                   "id" : "b40ef09b-3811-4726-b508-e41a0f96c68f",
                                   "roomId" : "room-3811-4726-b508",
                                   "name" : "Foo",
                                   "audioType " : 1,
                                   "videoType " : 1,
                                   "createTime" : "2015-07-23 20:05:52",
                                   "duration" : 5049,
                                   "size" : 247748791,
                                   "status" : 2,
                                   "url" : "http://record.3tee.cn/b40ef09b-3811-4726-b508-e41a0f96c68f.mp4"
                                }
                           ... ...
                        ]

        }
}

主要返回碼: 0,

返回值說明:

id:記錄號,直播創建的時候產生,唯一標識一個直播的記錄

roomId:房間ID

name:記錄名稱

createTime:記錄創建時間,cst時間

duration:記錄時長,秒

audioType:音頻類型 [1]

videoType:視頻類型 [2]

size:記錄文件大小

status: 直播記錄狀態 [4]

url:記錄url

2.4.7. 變量定義?

[1](1, 2, 3)

音頻類型定義/audioType

0 :無音頻

1 :同視頻用戶的單用戶音頻

2 :整個房間中的所有音頻混音

[2](1, 2, 3)

視頻類型定義/videoType

0 :無視頻

1 :視頻主流

2 :視頻輔流1

3 :視頻輔流2

[4](1, 2, 3, 4, 5)

直播記錄狀態定義/status

0 :創建直播

1 :正在直播

2 :停止直播

3 :直播已刪除

2.4.8. 錯誤碼表?

ret 詳細描述
0 成功
301 授權不通過
305 直播異?;蛞呀Y束
310 返回超時,多是后臺服務未啟動
312 創建失敗,多是后臺服務未啟動
313 停止失敗,多是后臺服務未啟動
314 直播Id無效
401 參數不對