cn.binarywang.wx.miniapp.api

接口 WxMaVodService

所有已知实现类:

WxMaVodServiceImpl

public interface WxMaVodService

小程序短剧管理服务接口。 提供短剧视频上传、管理、审核、播放等相关功能。 文档：https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/vod.html

方法概要

限定符和类型	方法和说明
WxMaVodApplyUploadResponse	applyUpload(WxMaVodApplyUploadRequest request) 申请上传。
Integer	auditDrama(WxMaVodAuditDramaRequest request) 审核剧集。
WxMaVodCommitUploadResponse	commitUpload(WxMaVodCommitUploadRequest request) 确认上传。
boolean	deleteMedia(WxMaVodDeleteMediaRequest request) 删除媒体文件。
WxMaVodGetCdnLogResponse	getCdnLogs(WxMaVodGetCdnLogRequest request) 获取CDN日志。
WxMaVodGetCdnUsageResponse	getCdnUsageData(WxMaVodGetCdnUsageRequest request) 获取CDN用量数据。
WxMaVodDramaInfo	getDrama(WxMaVodGetDramaRequest request) 获取剧集详情。
WxMaVodMediaInfo	getMedia(WxMaVodGetMediaRequest request) 获取媒体详情。
WxMaVodMediaPlaybackInfo	getMediaLink(WxMaVodGetMediaLinkRequest request) 获取媒体播放链接。
WxMaVodGetTaskResponse	getTask(WxMaVodGetTaskRequest request) 获取任务状态。
List<WxMaVodDramaInfo>	listDrama(WxMaVodListDramaRequest request) 获取剧集列表。
List<WxMaVodMediaInfo>	listMedia(WxMaVodListMediaRequest request) 获取媒体列表。
WxMaVodPullUploadResponse	pullUpload(WxMaVodPullUploadRequest request) 拉取上传。
WxMaVodUploadPartResult	uploadPart(File file, String uploadId, Integer partNumber, Integer resourceType) 上传分片。
WxMaVodSingleFileUploadResult	uploadSingleFile(File file, String mediaName, String mediaType) 单文件上传（简化版）。
WxMaVodSingleFileUploadResult	uploadSingleFile(File file, String mediaName, String mediaType, String coverType, File coverData, String sourceContext) 单文件上传（完整版）。

方法详细资料

listMedia

List<WxMaVodMediaInfo> listMedia(WxMaVodListMediaRequest request)
                          throws WxErrorException

获取媒体列表。 分页获取已上传的媒体文件列表。

参数:

request - 获取媒体列表请求对象

返回:

媒体信息列表

抛出:

WxErrorException - 获取失败时抛出

listDrama

List<WxMaVodDramaInfo> listDrama(WxMaVodListDramaRequest request)
                          throws WxErrorException

获取剧集列表。 分页获取已创建的剧集列表。

参数:

request - 获取剧集列表请求对象

返回:

剧集信息列表

抛出:

WxErrorException - 获取失败时抛出

getMediaLink

WxMaVodMediaPlaybackInfo getMediaLink(WxMaVodGetMediaLinkRequest request)
                               throws WxErrorException

获取媒体播放链接。 获取指定媒体文件的播放地址和相关信息。

参数:

request - 获取媒体播放链接请求对象

返回:

媒体播放信息对象

抛出:

WxErrorException - 获取失败时抛出

getMedia

WxMaVodMediaInfo getMedia(WxMaVodGetMediaRequest request)
                   throws WxErrorException

获取媒体详情。 获取指定媒体文件的详细信息。

参数:

request - 获取媒体详情请求对象

返回:

媒体信息对象

抛出:

WxErrorException - 获取失败时抛出

deleteMedia

boolean deleteMedia(WxMaVodDeleteMediaRequest request)
             throws WxErrorException

删除媒体文件。 删除指定的媒体文件，删除后无法恢复。

参数:

request - 删除媒体请求对象

返回:

删除是否成功

抛出:

WxErrorException - 删除失败时抛出

getDrama

WxMaVodDramaInfo getDrama(WxMaVodGetDramaRequest request)
                   throws WxErrorException

获取剧集详情。 获取指定剧集的详细信息。

参数:

request - 获取剧集详情请求对象

返回:

剧集信息对象

抛出:

WxErrorException - 获取失败时抛出

auditDrama

Integer auditDrama(WxMaVodAuditDramaRequest request)
            throws WxErrorException

审核剧集。 提交剧集进行内容审核。

参数:

request - 审核剧集请求对象

返回:

审核任务ID

抛出:

WxErrorException - 审核提交失败时抛出

getCdnUsageData

WxMaVodGetCdnUsageResponse getCdnUsageData(WxMaVodGetCdnUsageRequest request)
                                    throws WxErrorException

获取CDN用量数据。 查询指定时间段内的CDN流量使用情况。

参数:

request - 获取CDN用量请求对象

返回:

CDN用量数据响应对象

抛出:

WxErrorException - 获取失败时抛出

getCdnLogs

WxMaVodGetCdnLogResponse getCdnLogs(WxMaVodGetCdnLogRequest request)
                             throws WxErrorException

获取CDN日志。 获取指定时间段内的CDN访问日志。

参数:

request - 获取CDN日志请求对象

返回:

CDN日志响应对象

抛出:

WxErrorException - 获取失败时抛出

pullUpload

WxMaVodPullUploadResponse pullUpload(WxMaVodPullUploadRequest request)
                              throws WxErrorException

拉取上传。 通过URL拉取视频文件到平台进行上传。

参数:

request - 拉取上传请求对象

返回:

拉取上传响应对象

抛出:

WxErrorException - 拉取失败时抛出

getTask

WxMaVodGetTaskResponse getTask(WxMaVodGetTaskRequest request)
                        throws WxErrorException

获取任务状态。 查询异步任务的执行状态和结果。

参数:

request - 获取任务状态请求对象

返回:

任务状态响应对象

抛出:

WxErrorException - 获取失败时抛出

uploadSingleFile

WxMaVodSingleFileUploadResult uploadSingleFile(File file,
                                               String mediaName,
                                               String mediaType)
                                        throws WxErrorException

单文件上传（简化版）。 直接上传单个视频文件到平台。

参数:

file - 要上传的文件

mediaName - 媒体文件名称

mediaType - 媒体文件类型

返回:

单文件上传结果

抛出:

WxErrorException - 上传失败时抛出

uploadSingleFile

WxMaVodSingleFileUploadResult uploadSingleFile(File file,
                                               String mediaName,
                                               String mediaType,
                                               String coverType,
                                               File coverData,
                                               String sourceContext)
                                        throws WxErrorException

单文件上传（完整版）。 上传视频文件和封面图片到平台。

参数:

file - 要上传的视频文件

mediaName - 媒体文件名称

mediaType - 媒体文件类型

coverType - 封面图片类型

coverData - 封面图片文件

sourceContext - 来源上下文信息

返回:

单文件上传结果

抛出:

WxErrorException - 上传失败时抛出

applyUpload

WxMaVodApplyUploadResponse applyUpload(WxMaVodApplyUploadRequest request)
                                throws WxErrorException

申请上传。 申请分片上传的上传凭证和上传地址。

参数:

request - 申请上传请求对象

返回:

申请上传响应对象

抛出:

WxErrorException - 申请失败时抛出

commitUpload

WxMaVodCommitUploadResponse commitUpload(WxMaVodCommitUploadRequest request)
                                  throws WxErrorException

确认上传。 确认分片上传完成，合并所有分片文件。

参数:

request - 确认上传请求对象

返回:

确认上传响应对象

抛出:

WxErrorException - 确认失败时抛出

uploadPart

WxMaVodUploadPartResult uploadPart(File file,
                                   String uploadId,
                                   Integer partNumber,
                                   Integer resourceType)
                            throws WxErrorException

上传分片。 上传文件的一个分片。

参数:

file - 分片文件

uploadId - 上传ID

partNumber - 分片编号

resourceType - 资源类型

返回:

分片上传结果

抛出:

WxErrorException - 上传失败时抛出