播单管理

更新时间:
复制 MD 格式

本文介绍VodAppServer中播单(Playlist)的概念、技术实现和管理方式。

重要

调用视频点播实体类和播单类接口需提交工单加白后方可使用。

  • 播单(Playlist):有序视频集合管理单元(如短剧),例如10个有序媒资(VideoId)组成一个短剧播单(Playlist),适用于顺序播放、分集展示等业务场景。

  • 动态实体(Entity):视频点播提供的官方存储能力,支持以key-value形式灵活存储和管理媒资的自定义业务信息(如封面、标签等),满足业务扩展需求。

播单数据结构

播单为视频点播预置的实体类。

名称

类型

必填

描述

PlaylistName

string

是

播单名称。

PlaylistDescribe

string

否

播单描述。

PlaylistStatus

enum

否

播单状态,取值:

  • Normal。

  • Disabled。

PlaylistTags

String

否

播单标签,以逗号分隔。

PlaylistCoverUrl

String

否

播单封面地址。

PlaylistOrderBy

String

是

播单排序规则,取值:

● asc(默认)。
● desc。

按播单视频SortKey参数值升序/降序展示。

Total

Integer

是

播单包含媒资数量。

PlaylistExtension

String

否

拓展信息,为JSON字符串,可用于配置预览视频等。

CreateTime

String

是

播单创建时间。

ModifyTime

String

是

播单修改时间。

PlaylistId

String

是

播单ID。

播单视频结构

播单视频是播单与媒资的关联实体。

名称

类型

必填

描述

PlaylistId

EntityMediaId

是

播单视频所属播单ID。

VideoId

NormalMedia,单值

是

播单视频的媒资ID。

SortKey

Double

是

排序值,用于按序展示。

Title

String

否

默认媒资标题,也可在播单中自定义。

Description

String

否

默认媒资描述,也可在播单中自定义。

CoverUrl

String

否

默认媒资封面,也可在播单中自定义。

创建播单示例

接口地址:POST /appServer/createPlaylist。

请求参数:

{
  "playlistName": "精选短剧合集",
  "playlistDescribe": "2024年最受欢迎的短剧",
  "playlistTags": "爱情,都市,热播",
  "playlistCoverUrl": "IMAGE_ID",
  "playlistVideos": "[{\"VideoId\":\"video1\",\"Title\":\"第1集\"}]"
}

参数说明:

名称

类型

必填

描述

playlistName

String

是

播单名称。

playlistDescribe

String

否

播单描述。

playlistTags

String

否

播单标签,以逗号分隔。

playlistCoverUrl

String

否

播单封面地址。

playlistVideos

String

否

播单媒资列表,为JSON字符串。

扩展能力

播单封面图

播单的playlistCoverUrl字段支持使用封面图媒资ImageId,AppServer可自动转换为可访问URL,也可通过播单详情接口getPlaylistInfo获取完整URL。

视频播放凭证

播单视频会基于视频点播的PlayKey本地生成JWT播放凭证(playAuth),跳过GetVideoPlayAuth调用,客户端通过videoId + playAuth直接播放。

预览效果

配置播单playlistExtension扩展参数(含previewVideoId的JSON数据)可实现预览效果。

配置示例:

{
  "previewVideoId": "f0d8a2b3ce8d71f0bf8e45******0402"
}