2.3. 錄制 REST API?

2.3.1. 版本信息?

v1.0.0, 2017/06/29

2.3.2. 創建錄制?

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

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

接口實例: http://127.0.0.1:8050/avd/api/record/createUserRecord?accessToken=YWYyNmVjZTZkOTdiMDFmNjkzYWIyN2ZmMWNkNTZkNzY3ZGVjNWVjNg==

GET參數?
參數 類型 必須 說明
accessToken String 認證成功后根據規則生成的串
POST參數?
參數 類型 必須 說明
name String 記錄名稱
tag String 記錄標記
roomId String 所屬房間號
userId String 用戶ID,唯一
audioType String 音頻類型 [1]
videoType String 視頻類型 [2]
fileType String 文件類型 [3]

返回說明:

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

主要返回碼: 0,

返回值說明:

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

status: 錄制記錄狀態 [4]

2.3.3. 停止錄制?

請求說明: http://xx.yy.zz:8050/avd/api/record/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",
            "roomId" : "room-3811-4726-b508",
            "name" : "Foo",
            "createTime" : "2015-07-23 20:05:52"
            "duration" : 5049,
            "audioType" : 1,
            "videoType" : 1,
            "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.3.4. 獲取錄制記錄信息?

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

接口描述: 獲取一個錄制記錄信息

接口實例: http://127.0.0.1:8050/avd/api/record/getRecord?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",
            "roomId" : "room-3811-4726-b508",
            "name" : "Foo",
            "createTime" : "2015-07-23 20:05:52"
            "duration" : 5049,
            "audioType" : 1,
            "videoType" : 1,
            "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.3.5. 刪除記錄?

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

接口描述: 刪除一個記錄

接口實例: http://127.0.0.1:8050/avd/api/record/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.3.6. 查詢錄制記錄?

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

接口描述: 查詢錄制記錄

接口實例: http://127.0.0.1:8050/avd/api/record/findRecords?accessToken=YmE4ZDg4YTY5NGMzZWMwZWMzNjQ1MWRiZGQwMDlmOTZiNWQxMDVkNg==&begin=1&count=4&filter={“fromTime”:”2017-06-03”,”endTime”:”2017-06-29”,”roomId”:”r5”,”userId”:”testRecord”}

GET參數?
參數 類型 必須 說明
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.3.7. 變量定義?

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

音頻類型定義/audioType

0 :無音頻

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

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

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

視頻類型定義/videoType

0 :無視頻

1 :視頻主流

2 :視頻輔流1

3 :視頻輔流2

[3]

文件類型定義/fileType

0 :Mp4文件類型,只能錄制H264碼流

1 :WebM文件類型,只能錄制VP8/VP9視頻碼流

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

錄制記錄狀態定義/status

0 :創建錄制

1 :正在錄制(如果相應視頻和音頻流上傳服務器,就會保持到錄制中;如沒數據也無錄制)

2 :錄制完成可查看

3 :錄制被刪除

4 :錄制異常(如不完整等)

2.3.8. 錯誤碼表?

ret 詳細描述
0 成功
301 授權不通過
306 創建失敗,多是后臺服務未啟動
307 停止失敗,多是后臺服務未啟動
308 錄制Id無效,已刪除或沒創建成功
310 返回超時,多是后臺服務未啟動
401 參數不對