You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取媒资库视频信息

最近更新时间：2024.04.28 14:37:34

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

我的收藏

通过本接口，您可以获取媒资库下视频库或直播暂存中视频的信息。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

  • 请求方式：GET
  • 请求地址：https://livesaas.volcengineapi.com/?Action=ListActivityMediaAPI&Version=2020-06-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

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

SearchType

Integer

是

2

视频的存储位置。支持以下取值：

  • 1：视频库
  • 2：直播暂存
VidString否v02a49g10000ckitq63c77u8uhf09ebg视频 Vid。
NameString否回放1视频名称。

SourceType

Integer

否

2

视频的来源。支持以下取值：

  • 1：上传，即本地上传的视频。
  • 2：直播录制，即直播结束后自动生成的视频。
  • 3：云剪辑，即通过云剪辑功能剪辑后的视频。

OrderKey

String

否

create_time

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

  • create_time：按照视频文件创建时间降序排列
  • 其他值：按照视频文件修改时间降序排列
FolderIdLong否0分类 ID。默认取值为 0，表示查询所有视频。您可以通过 GetVideoLibraryFolderTree 接口获取 ID。

IncludeSubFolder

Boolean

否

false

是否包含子分类。支持以下取值，默认取值为 false。

  • true：包含，即搜索当前分类及其子分类下的所有视频。
  • false：不包含，即仅搜索当前分类下的视频。

返回参数

参数类型示例值描述
PageNumInteger1分页查询页数。
PageSizeInteger10分页查询数量。
TotalCountInteger1查询结果总数。
DataArray of Data-视频信息列表。

Data

参数类型示例值描述
IdString430998视频 ID。
MediaNameString回放1视频名称。
CoverImageStringhttp://IyBXvr3FqhPAfkSSARz9Q6h4EN0Eu视频封面图 URL。默认封面图的 URL 有协议头，通过控制台上传的封面图 URL 没有协议头。
VidStringv02a49g10000ckitq63c77u8uhf09ebg视频 Vid。
MediaVideoDurationInteger191视频时长，单位为秒。

MediaLibraryVideoType

Integer

2

视频的存储位置。支持以下取值：

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

ReviewStatus

Integer

2

视频的审核状态。支持以下取值：

  • 1：未审核
  • 2：已审核
CreateTimeInteger1696980251视频的创建时间。若视频是直播暂存转存至视频库，则表示转存至视频库的时间。
UpdateTimeInteger1696990559最近一次更新视频的时间。Unix 时间戳，单位为秒。
CreatorStringadmin@bytedance.com视频的创建者。

SourceType

Integer

2

视频的来源。支持以下取值：

  • 1：上传，即本地上传的视频。
  • 2：直播录制，即直播结束后自动生成的视频。
  • 3：云剪辑，即通过云剪辑功能剪辑后的视频。
ActivityVideoArray of ActivityVideo-视频关联的直播间，即正在使用该视频的直播间。
FailureTimeInteger1796980251视频的失效时间。取值为 0，表示永久保存，无失效时间。
MediaSizeInteger24725029视频的大小。单位为 Byte。
VideoWidthLong1080视频横向像素。VideoWidth 和 VideoHeight 组成了视频的分辨率。
VideoHeightLong1920视频纵向像素。VideoWidth 和 VideoHeight 组成了视频的分辨率。
FolderNameString分类名称分类名称。
FolderIdLong0分类 ID。

ActivityVideo

参数类型示例值描述
IdLong1779348423622756直播间 ID。
NameString直播间 B直播间名称。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListActivityMediaAPI&Version=2020-06-01&PageNum=1&PageSize=10&SearchType=2&Vid=v02a49g10000ckitq63c77u8uhf09ebg&Name=回放1&SourceType=2&OrderKey=create_time

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202310111626371401194CBBE248929D32",
    "Action": "ListActivityMediaAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1697012797
  },
  "Result": {
      "PageNum": 1,
      "PageSize": 10,
      "TotalCount": 1,
      "Data": [
      {
        "Id": "430998",
        "MediaName": "回放1",
        "CoverImage": "http://IyBXvr3FqhPAfkSSARz9Q6h4EN0Eu",
        "Vid": "v02a49g10000ckitq63c77u8uhf09ebg",
        "MediaVideoDuration": 191,
        "MediaLibraryVideoType": 2,
        "ReviewStatus": 2,
        "CreateTime": "1696980251",
        "UpdateTime": "1696990559",
        "Creator": "admin@bytedance.com",
        "SourceType": 2,
        "ActivityVideo": [
          {
            "Id": 1779338178912263,
            "Name": "直播间 A"
          },
          {
            "Id": 1779348423622756,
            "Name": "直播间 B"
          }
        ],
        "FailureTime": "1796980251",
        "MediaSize": 24725029,
        "VideoHeight": 1920,
        "VideoWidth": 1080,
        "FolderName": "分类名称",
        "FolderId": 0
      }
    ]
  }
}

错误码

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