plv player sdk doc
载入中...
搜索中...
未找到
类型定义 | 函数
下载器接口

类型定义

typedef void * PLVDownloadPtr
 下载对象, 每一个下载任务对应一个下载对象, 可以创建多个下载对象.
 
typedef void(* OnDownloadErrorHandler) (const char *vid, int code, void *data)
 过程中的错误信息回调通知.
 
typedef void(* OnDownloadProgressHandler) (const char *vid, long long receivedBytes, long long totalBytes, void *data)
 下载进度的回调通知.
 
typedef void(* OnDownloadResultHandler) (const char *vid, int rate, int code, void *data)
 下载结果的回调通知.
 

函数

PLAYERSDK_API PLVDownloadPtr PLAYERSDK_CALL PLVDownloadCreate ()
 创建下载对象并返回对象指针. 在使用下载接口对象前, 必须先调用此接口创建对象.
 
PLAYERSDK_API void PLAYERSDK_CALL PLVDownloadDestroy (PLVDownloadPtr download)
 销毁下载对象. 不再使用创建的对象后, 必须调用此接口回收.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadSetErrorHandler (PLVDownloadPtr download, OnDownloadErrorHandler handler, void *data)
 设置下载错误的回调通知.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadSetProgressHandler (PLVDownloadPtr download, OnDownloadProgressHandler handler, void *data)
 设置下载进度的回调通知.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadSetResultHandler (PLVDownloadPtr download, OnDownloadResultHandler handler, void *data)
 设置下载结果的回调通知.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadResetHandler (PLVDownloadPtr download)
 重置所有回调通知, 会请空所有的回调函数地址.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadSetInfo (PLVDownloadPtr download, const char *vid, const char *path, int rate)
 设置视频信息. 在调用下载前, 必须先设置视频的相关信息, 否则会报错.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadStart (PLVDownloadPtr download, bool autoDownRate)
 开始下载.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadPause (PLVDownloadPtr download, bool pause)
 暂停下载, 此时线程进入休眠, 不会退出, 区别于停止下载. 再开始下载时会更快些.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadStop (PLVDownloadPtr download)
 停止下载, 此时线程会回收退出, 区别于暂停下载. 再开始下载时会慢些.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadDelete (PLVDownloadPtr download)
 删除视频文件. 如果视频正在下载中时, 会中断下载, 并删除所有临时文件, 并退出线程.
 
PLAYERSDK_API bool PLAYERSDK_CALL PLVDownloadIsDownloading (PLVDownloadPtr download)
 获取是否下载中状态.
 

详细描述

类型定义说明

◆ OnDownloadErrorHandler

typedef void(* OnDownloadErrorHandler) (const char *vid, int code, void *data)

过程中的错误信息回调通知.

参数
[out]vid视频标识.
[out]code错误码.
[out]data用户自定义上下文数据.

在文件 plv-player-download-CN.h 第 14 行定义.

◆ OnDownloadProgressHandler

typedef void(* OnDownloadProgressHandler) (const char *vid, long long receivedBytes, long long totalBytes, void *data)

下载进度的回调通知.

参数
[out]vid视频标识.
[out]receivedBytes下载文件接收到的数据大小.
[out]totalBytes下载文件总的大小.
[out]data用户自定义上下文数据.

在文件 plv-player-download-CN.h 第 22 行定义.

◆ OnDownloadResultHandler

typedef void(* OnDownloadResultHandler) (const char *vid, int rate, int code, void *data)

下载结果的回调通知.

参数
[out]vid视频标识.
[out]rate视频的清晰度.
[out]code错误码.
[out]data用户自定义上下文数据.

在文件 plv-player-download-CN.h 第 30 行定义.

◆ PLVDownloadPtr

typedef void* PLVDownloadPtr

下载对象, 每一个下载任务对应一个下载对象, 可以创建多个下载对象.

在文件 plv-player-download-CN.h 第 7 行定义.

函数说明

◆ PLVDownloadCreate()

PLAYERSDK_API PLVDownloadPtr PLAYERSDK_CALL PLVDownloadCreate ( )

创建下载对象并返回对象指针. 在使用下载接口对象前, 必须先调用此接口创建对象.

返回
  • Pointer: 下载对象指针.

◆ PLVDownloadDelete()

PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadDelete ( PLVDownloadPtr download)

删除视频文件. 如果视频正在下载中时, 会中断下载, 并删除所有临时文件, 并退出线程.

参数
download下载对象.
参见
PLVDownloadCreate.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVDownloadDestroy()

PLAYERSDK_API void PLAYERSDK_CALL PLVDownloadDestroy ( PLVDownloadPtr download)

销毁下载对象. 不再使用创建的对象后, 必须调用此接口回收.

参数
download下载对象.
参见
PLVDownloadCreate.

◆ PLVDownloadIsDownloading()

PLAYERSDK_API bool PLAYERSDK_CALL PLVDownloadIsDownloading ( PLVDownloadPtr download)

获取是否下载中状态.

参数
download下载对象.
参见
PLVDownloadCreate.
返回
  • true: 下载中.
  • false: 空闲中.

◆ PLVDownloadPause()

PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadPause ( PLVDownloadPtr download,
bool pause )

暂停下载, 此时线程进入休眠, 不会退出, 区别于停止下载. 再开始下载时会更快些.

参数
download下载对象.
参见
PLVDownloadCreate.
参数
pause下载状态.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVDownloadResetHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadResetHandler ( PLVDownloadPtr download)

重置所有回调通知, 会请空所有的回调函数地址.

参数
download下载对象.
参见
PLVDownloadCreate.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVDownloadSetErrorHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadSetErrorHandler ( PLVDownloadPtr download,
OnDownloadErrorHandler handler,
void * data )

设置下载错误的回调通知.

参数
download下载对象.
参见
PLVDownloadCreate.
参数
handler回调函数地址.
data用户自定义上下文数据.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVDownloadSetInfo()

PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadSetInfo ( PLVDownloadPtr download,
const char * vid,
const char * path,
int rate )

设置视频信息. 在调用下载前, 必须先设置视频的相关信息, 否则会报错.

参数
download下载对象.
参见
PLVDownloadCreate.
参数
vid视频标识.
path视频存放的路径, 使用 UTF8.
rate视频清晰度.
参见
VIDEO_RATE_TYPE.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注意
路径必须使用 UTF8

◆ PLVDownloadSetProgressHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadSetProgressHandler ( PLVDownloadPtr download,
OnDownloadProgressHandler handler,
void * data )

设置下载进度的回调通知.

参数
download下载对象.
参见
PLVDownloadCreate.
参数
handler回调函数地址.
data用户自定义上下文数据.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVDownloadSetResultHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadSetResultHandler ( PLVDownloadPtr download,
OnDownloadResultHandler handler,
void * data )

设置下载结果的回调通知.

参数
download下载对象.
参见
PLVDownloadCreate.
参数
handler回调函数地址.
data用户自定义上下文数据.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVDownloadStart()

PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadStart ( PLVDownloadPtr download,
bool autoDownRate )

开始下载.

参数
download下载对象.
参见
PLVDownloadCreate.
参数
autoDownRate是否自动降低清晰度. 使用场景是, 如果用户指定要下载的清晰度为超清时, 此清晰度不存在时:
  • 如果 autoDownRate=false, 则返回失败.
  • 如果 autoDownRate=true, 则会自动逐级降级清晰度.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
如果磁盘空间不足100M时会报错.

◆ PLVDownloadStop()

PLAYERSDK_API int PLAYERSDK_CALL PLVDownloadStop ( PLVDownloadPtr download)

停止下载, 此时线程会回收退出, 区别于暂停下载. 再开始下载时会慢些.

参数
download下载对象.
参见
PLVDownloadCreate.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
制作者 doxygen 1.10.0