You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取媒体库视频文件信息列表

最近更新时间：2022.11.28 16:04:20

首次发布时间：2022.07.29 10:08:32

我的收藏

获取媒体库下视频库或者直播暂存中视频文件的信息。

请求说明

  • 接口名称：ListActivityMediaAPI
  • 请求方式：GET
  • 接口地址：http://livesaas.volcengineapi.com/?Action=ListActivityMediaAPI&Version=2020-06-01
  • 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数类型是否必选描述
ActionString是接口名称
VersionString是接口版本。直播当前 API 的版本为 2020-06-01
PageNumInt否分页查询页码，默认值为 1
PageSizeInt否分页查询数量，默认值为 10

SearchType

Int

是

视频文件的存储位置。

  • 1：视频库；
  • 2：直播暂存。
VidString否视频文件的 Vid
NameString否视频文件的名称

SourceType

Int

否

视频文件的来源

  • 1：上传；
  • 2：直播录制；
  • 3：云剪辑。

OrderKey

String

否

视频文件排序方式。支持以下两种取值，默认按照视频文件修改时间降序排列。

  • create_time：按照视频文件创建时间降序排列；
  • 其他：按照视频文件修改时间降序排列。

返回参数

参数类型描述
PageNumInt分页查询页数
PageSizeInt分页查询数量
TotalCountInt获取的视频文件总数
DataArray of Media获取的视频文件信息

Media

参数类型描述
IdString视频记录 ID
MediaNameString视频文件名称
CoverImageString视频文件封面图 URL。默认封面图的 URL 有协议头，通过控制台上传的封面图的 URL 没有协议头
VidString视频文件的 Vid
MediaVideoDurationInt视频文件的时长，单位为秒

MediaLibraryVideoType

Int

媒体库视频类型。

  • 1：视频库；
  • 2：直播暂存。

ReviewStatus

Int

审核状态

  • 1：未审核；
  • 2：已审核。
CreateTimeInt视频文件的创建时间
UpdateTimeInt视频文件的更新时间
CreatorString视频文件的创建者

SourceType

Int

视频文件的来源。

  • 1：上传；
  • 2：直播录制；
  • 3：云剪辑。
ActivityVideoArray of Info视频文件关联的直播间
FailureTimeInt视频文件的失效时间。取值为 0，表示无失效时间
MediaSizeInt视频文件的大小，单位为Byte

Info

参数类型描述
IdInt64直播间 ID
NameString直播间名称

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=ListActivityMediaAPI&Version=2020-06-01&PageNu m=1&PageSize=10&SearchType=1&Vid=v0c251gb***&Name=20220523-162805.mp4

正常返回示例

{
		"ResponseMetadata":	{
				"RequestId":	"2022062723412201021207***",
				"Action":	"ListActivityMediaAPI",
				"Version":	"2020-06-01",
				"Service":	"livesaas",
				"Region":	"cn-north-1",
				"SystemTime":	1656344482
		},
		"Result":	{
				"PageNum":	1,
				"PageSize":	10,
				"TotalCount":	1			
				"Data":	[
						{
								"Id":	"40299",
								"MediaName":	"20220523-162805.mp4",
								"CoverImage":	"http://p-boe-sign.***,
								"Vid":	"v0c251g7007acb2***",
								"MediaVideoDuration":	107,
								"MediaLibraryVideoType":	1,
								"ReviewStatus":	1,
								"CreateTime":	1657079263,
								"UpdateTime":	1657082186,
								"Creator":	"admin@****.com",
								"SourceType":	1,
								"ActivityVideo":	[{
										"Id":	1737572890898393,
										"Name":	"***直播间"
								}],
								"FailureTime":	0,
								"MediaSize":	56919287
						}
				]
		}
}

异常返回示例

{
    "ResponseMetadata":{
        "RequestId":"20180604110420010***",
        "Action":"ListActivityMediaAPI",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常" 
        }
    }
}

错误码

访问公共错误码获取详细信息。