媒体库

获取媒体库视频总量【控制台】

基本信息

Path: /videos/api/get_videos_size

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber非必须
dataobject非必须
├─ sizenumber非必须视频总量,单位 B

修改视频名称【控制台】

基本信息

Path: /videos/api/modify_video_name

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
video_idnumber必须视频ID
namestring必须名称

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber必须

删除视频【控制台】

基本信息

Path: /videos/api/delete_video

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
video_idnumber必须视频ID

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber必须

获取视频列表【控制台】

基本信息

Path: /videos/api/get_videos_list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
page 页码,默认为1
size 页面大小,默认为15

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber非必须
total_numnumber非必须视频总数
total_pagenumber非必须视频总页数
page_numnumber非必须当前页码
page_sizenumber非必须页面大小
resultobject []非必须视频列表

item 类型: object

├─ idnumber必须视频ID
├─ namestring必须视频名称
├─ urlstring必须视频文件地址
├─ sizenumber必须视频大小
├─ thumburlstring必须预览图
├─ durationnumber必须视频时长
├─ statusnumber必须视频转码状态
├─ create_atstring必须创建时间
├─ sourcefromstring必须视频来源
├─ hubuser_idnumber必须上传用户ID
├─ act_idnumber必须直播频道ID
├─ playsetobject []必须拉流/下载地址列表

item 类型: object

├─ videoidnumber必须视频ID
├─ resolutionstring必须分辨率
├─ urlstring必须拉流/下载地址

添加视频打点【控制台】

基本信息

Path: /videos/api/add_video_kfd

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
video_idnumber必须视频ID
offsetnumber必须打点下标,单位 秒
contentstring必须打点内容

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber必须

更改视频打点【控制台】

基本信息

Path: /videos/api/modify_video_kfd

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
video_idnumber必须视频ID
idnumber必须打点ID
offsetnumber必须打点下标,单位 秒
contentstring必须打点内容

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber必须

删除视频打点【控制台】

基本信息

Path: /videos/api/delete_video_kfd

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
video_idnumber必须视频ID
idnumber必须打点ID

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber必须

添加文档打点【控制台】

基本信息

Path: /videos/api/add_video_doc_kfd

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
video_idnumber必须视频ID
offsetnumber必须打点下标,单位 秒
titlestring必须打点备注
contentstring必须打点内容(图片url)

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber必须
idnumber必须打点ID

更改文档打点【控制台】

基本信息

Path: /videos/api/update_video_doc_kfd

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
video_idnumber必须视频ID
idnumber必须打点ID
offsetnumber必须打点下标,单位 秒
titlestring必须打点备注
contentstring必须打点内容(图片url)

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber非必须

删除文档打点【控制台】

基本信息

Path: /videos/api/delete_video_doc_kfd

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
video_idnumber非必须视频ID
id_listnumber []非必须打点ID列表

item 类型: number

├─ 非必须打点ID

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber非必须
error_id_listnumber []非必须删除失败的打点ID列表

item 类型: number

├─ 非必须打点ID

获取直播录制配置【控制台】

基本信息

Path: /videos/api/get_transcribe

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
actid 频道Hash ID

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber非必须
transcribeboolean非必须是否录制该频道直播

更改直播录制配置【控制台】

基本信息

Path: /videos/api/update_transcribe

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
actidstring非必须频道Hash ID
transcribeboolean非必须是否录制该频道直播

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber必须

视频上传步骤一(获取上传地址)【控制台】

基本信息

Path: /activity/api/temp_upload_addrss

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber非必须
msgstring非必须
addressstring非必须视频上传地址

视频上传步骤二(上传文件)【控制台】

基本信息

Path: /{address}

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type multipart/form-data

路径参数

参数名称 示例 备注
address 步骤一获取的视频上传地址

Body

参数名称 参数类型 是否必须 示例 备注
file file 视频文件
file_name text 视频文件名,默认用 file 的文件名

返回数据

名称类型是否必须默认值备注其他信息
idstring非必须文件存储ID
urlstring非必须文件存储URL

视频上传步骤三(同步视频ID到媒体库)【控制台】

基本信息

Path: /videos/api/upload_videos

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
storage_idstring必须步骤二获取的文件存储ID

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber非必须

获取视频信息【观看页】

基本信息

Path: /videos/api/get_video_info

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
id 视频ID

返回数据

名称类型是否必须默认值备注其他信息
errcodenumber非必须
resultobject非必须
├─ idnumber非必须视频ID
├─ namestring非必须视频名称
├─ urlstring非必须视频文件地址
├─ sizenumber非必须视频文件大小
├─ thumburlstring非必须预览图
├─ durationnumber非必须视频时长
├─ create_atstring非必须视频创建时间
├─ sourcefromstring非必须视频来源
├─ hubuser_idnumber非必须用户ID
├─ act_idnumber非必须视频ID
├─ playsetobject []非必须视频下载/拉流地址列表

item 类型: object

├─ videoidnumber必须视频ID
├─ resolutionstring必须分辨率
├─ urlstring必须下载/拉流地址
├─ key_frame_descobject []非必须视频打点列表

item 类型: object

├─ idnumber非必须打点ID
├─ offsetnumber非必须打点下标,单位 秒
├─ contentstring非必须打点内容
├─ play_back_messagesobject []必须文档打点列表

item 类型: object

├─ idnumber必须文档打点ID
├─ offsetnumber必须打点下标,单位 秒
├─ titlestring必须打点备注
├─ contentstring必须打点内容
├─ import_doc_kfdnumber非必须是否导入直播时的文档
目睹企播 all right reserved,powered by Gitbook修订时间 2020-10-14 08:29:29

results matching ""

    No results matching ""