plv player sdk doc
类型定义 | 函数
全局接口

类型定义

typedef void(* OnLogMessageHandler) (LOG_FILTER_TYPE level, const char *message, void *data)
 日志信息回调. 更多...
 
typedef void(* OnRequestVideoInfoHandler) (int code, const PLVVideoRequestInfo infos[], int infosNum, const PLVVideoRequestPageInfo *pageInfo, void *data)
 请求视频信息的回调通知. 更多...
 

函数

PLAYERSDK_API const char *PLAYERSDK_CALL PLVGetSdkVersion (void)
 获取 SDK 版本号. 更多...
 
PLAYERSDK_API const char *PLAYERSDK_CALL PLVGetSdkErrorDescription (int err)
 根据错误码获取错误描述. 更多...
 
PLAYERSDK_API bool PLAYERSDK_CALL PLVCheckFileComplete (const char *vid, const char *videoFilePath, int rate)
 检查视频文件的完整性. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkLogLevel (LOG_FILTER_TYPE level)
 设置 SDK 的日志过滤等级. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkLogFile (const char *fileName)
 设置 SDK 的日志文件位置, 文件名带路径. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkLogMessageCallback (bool enable, OnLogMessageHandler handler, void *data)
 设置日志信息回调. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkHttpRequest (SDK_HTTP_REQUEST type)
 设置 SDK 的网络请求协议. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkCacertFile (const char *fileName)
 设置 https 协议的证书文件, 如果用 https 协议, 一定要设置证书文件, 不然会请求失败. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkHwdecEnable (bool enable)
 设置是否使用硬件加速. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkKeepLastFrame (bool enable)
 设置是否播放结束保持在最后一帧画面上. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkRetryAttempts (int attempts, int milliseconds, int millisecondsMax)
 设置下载的重试次数, 每次重试的间隔时间会递增. 默认是无限重试(-1). 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkVideoOutputDevice (VIDEO_OUTPUT_DEVICE type, const char *context=NULL)
 设置视频输出驱动类型. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkViewerInfo (const char *viewerId, const char *viewerName, const char *viewerAvatar, const char *viewerExtraInfo1=NULL, const char *viewerExtraInfo2=NULL, const char *viewerExtraInfo3=NULL)
 设置 qos 的信息追踪, 建议设置. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVInitSdkLibrary (const char *userId, const char *secretKey)
 初始化 SDK , 在使用 SDK 前一定要调用此接口. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVRequestVideoInfo (bool sync, const PLVVideoRequestParam *param, OnRequestVideoInfoHandler handler, void *data)
 请求视频信息. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVCancelRequestVideoInfo ()
 中断请求视频信息. 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVMigrateLocalVideoKeyFile (const char *keyFilePath, const char *secretKey)
 迁移旧的加密密钥, 换成使用 token 来加密密钥 更多...
 
PLAYERSDK_API int PLAYERSDK_CALL PLVDeleteLocalVideoFile (const char *vid, const char *path, int rate)
 删除本地离线视频文件 更多...
 
PLAYERSDK_API void PLAYERSDK_CALL PLVReleaseSdkLibrary (void)
 析构 SDK, 停止使用后要调用此接口. 更多...
 

详细描述

类型定义说明

◆ OnLogMessageHandler

typedef void(* OnLogMessageHandler) (LOG_FILTER_TYPE level, const char *message, void *data)

日志信息回调.

参数
[out]level日志等级类型.
参见
LOG_FILTER_TYPE.
参数
[out]message日志内容.
[out]data用户自定义上下文数据.

在文件 plv-player-core-CN.h 第 64 行定义.

◆ OnRequestVideoInfoHandler

typedef void(* OnRequestVideoInfoHandler) (int code, const PLVVideoRequestInfo infos[], int infosNum, const PLVVideoRequestPageInfo *pageInfo, void *data)

请求视频信息的回调通知.

参数
[out]code请求结果错误码
[out]infos视频信息.
[out]infosNum视频信息数量.
[out]pageInfo视频页数信息.
[out]data自定义上下文.

在文件 plv-player-core-CN.h 第 183 行定义.

函数说明

◆ PLVCancelRequestVideoInfo()

PLAYERSDK_API int PLAYERSDK_CALL PLVCancelRequestVideoInfo ( )

中断请求视频信息.

返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
必须在初始化后使用.

◆ PLVCheckFileComplete()

PLAYERSDK_API bool PLAYERSDK_CALL PLVCheckFileComplete ( const char *  vid,
const char *  videoFilePath,
int  rate 
)

检查视频文件的完整性.

参数
vid视频标识.
videoFilePath视频文件的路径, 使用 UTF8.
rate视频清晰度.
参见
VIDEO_RATE_TYPE.
返回
  • true: 视频完整.
  • false: 视频非完整.
注解
如果视频文件是 mp4 类型, 则只判断此文件是否存在, 不判断大小是否完整.
注意
路径必须使用 UTF8.

◆ PLVDeleteLocalVideoFile()

PLAYERSDK_API int PLAYERSDK_CALL PLVDeleteLocalVideoFile ( const char *  vid,
const char *  path,
int  rate 
)

删除本地离线视频文件

参数
vid视频id.
path视频的存放路径, 使用 UTF8.
rate清晰度.
参见
VIDEO_RATE_TYPE.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注意
路径必须使用 UTF8.
如果清晰度为 @VIDEO_RATE_AUTO 时, 则会删除此视频的所有清晰度文件.
注解
必须在初始化后使用.

◆ PLVGetSdkErrorDescription()

PLAYERSDK_API const char *PLAYERSDK_CALL PLVGetSdkErrorDescription ( int  err)

根据错误码获取错误描述.

参数
err错误码
参见
SDK_ERROR_TYPE.
返回
  • string: 错误描述.

◆ PLVGetSdkVersion()

PLAYERSDK_API const char *PLAYERSDK_CALL PLVGetSdkVersion ( void  )

获取 SDK 版本号.

返回
  • string: SDK 版本号.

◆ PLVInitSdkLibrary()

PLAYERSDK_API int PLAYERSDK_CALL PLVInitSdkLibrary ( const char *  userId,
const char *  secretKey 
)

初始化 SDK , 在使用 SDK 前一定要调用此接口.

参数
userIduser id, 请向 SDK 供应商获取.
secretKeyuser secret key, 请向 SDK 供应商获取.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVMigrateLocalVideoKeyFile()

PLAYERSDK_API int PLAYERSDK_CALL PLVMigrateLocalVideoKeyFile ( const char *  keyFilePath,
const char *  secretKey 
)

迁移旧的加密密钥, 换成使用 token 来加密密钥

参数
keyFilePath旧的 key 文件, 包含路径, 使用 UTF8.
secretKey旧的密钥.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注意
路径必须使用 UTF8.
注解
必须在初始化后使用.

◆ PLVReleaseSdkLibrary()

PLAYERSDK_API void PLAYERSDK_CALL PLVReleaseSdkLibrary ( void  )

析构 SDK, 停止使用后要调用此接口.

◆ PLVRequestVideoInfo()

PLAYERSDK_API int PLAYERSDK_CALL PLVRequestVideoInfo ( bool  sync,
const PLVVideoRequestParam *  param,
OnRequestVideoInfoHandler  handler,
void *  data 
)

请求视频信息.

参数
sync是否使用同步, 建议使用异步.
param请求参数.
handler回调句柄.
data自定义上下文.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
必须在初始化后使用.

◆ PLVSetSdkCacertFile()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkCacertFile ( const char *  fileName)

设置 https 协议的证书文件, 如果用 https 协议, 一定要设置证书文件, 不然会请求失败.

参数
fileName证书文件, 包含路径. 使用 UTF8.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
如果没有调用, 会默认在 app 所在的路径查找.
注意
路径必须使用 UTF8.

◆ PLVSetSdkHttpRequest()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkHttpRequest ( SDK_HTTP_REQUEST  type)

设置 SDK 的网络请求协议.

参数
type网络请求协议类型.
参见
ONLY_HTTPS_REQUEST.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
默认值为 ONLY_HTTPS_REQUEST.

◆ PLVSetSdkHwdecEnable()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkHwdecEnable ( bool  enable)

设置是否使用硬件加速.

参数
enable开关.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
默认关闭
注意
vrm13下开启硬件加速可能造成花屏

◆ PLVSetSdkKeepLastFrame()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkKeepLastFrame ( bool  enable)

设置是否播放结束保持在最后一帧画面上.

参数
enable开关.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
默认关闭.

◆ PLVSetSdkLogFile()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkLogFile ( const char *  fileName)

设置 SDK 的日志文件位置, 文件名带路径.

参数
fileName日志文件, 包含路径, 使用 UTF8.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
如果没有调用此接口, 默认会在 %appdata%%/plv-player-sdk/logs/ 生成日志.
注意
路径必须使用 UTF8.

◆ PLVSetSdkLogLevel()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkLogLevel ( LOG_FILTER_TYPE  level)

设置 SDK 的日志过滤等级.

参数
level日志等级类型.
参见
LOG_FILTER_TYPE.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
默认值为 LOG_FILTER_INFO.

◆ PLVSetSdkLogMessageCallback()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkLogMessageCallback ( bool  enable,
OnLogMessageHandler  handler,
void *  data 
)

设置日志信息回调.

参数
enable开关.
handler回调函数地址.
data用户自定义上下文数据.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVSetSdkRetryAttempts()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkRetryAttempts ( int  attempts,
int  milliseconds,
int  millisecondsMax 
)

设置下载的重试次数, 每次重试的间隔时间会递增. 默认是无限重试(-1).

参数
attempts下载的重试次数. 默认是无限重试.
milliseconds重试间隔时间. 默认 500 ms.
millisecondsMax最大的重试间隔时间. 默认 25000 ms.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVSetSdkVideoOutputDevice()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkVideoOutputDevice ( VIDEO_OUTPUT_DEVICE  type,
const char *  context = NULL 
)

设置视频输出驱动类型.

参数
type驱动类型.
参见
VIDEO_OUTPUT_DEVICE.
参数
context可以设置为 "auto, d3d11, win, angle, dxinterop".
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
  • 如果 type = VIDEO_OUTPUT_GPU, 那么 context 可以不为空.
Sample
int ret = PLVSetSdkVideoOutputDevice(VIDEO_OUTPUT_GPU, "d3d11");
PLVSetSdkVideoOutputDevice
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkVideoOutputDevice(VIDEO_OUTPUT_DEVICE type, const char *context=NULL)
设置视频输出驱动类型.
VIDEO_OUTPUT_GPU
@ VIDEO_OUTPUT_GPU
Definition: plv-player-def-CN.h:119

◆ PLVSetSdkViewerInfo()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkViewerInfo ( const char *  viewerId,
const char *  viewerName,
const char *  viewerAvatar,
const char *  viewerExtraInfo1 = NULL,
const char *  viewerExtraInfo2 = NULL,
const char *  viewerExtraInfo3 = NULL 
)

设置 qos 的信息追踪, 建议设置.

参数
viewerId用户自定义标识.
viewerName用户自定义名称.
viewerAvatar用户自定义头像.
viewerExtraInfo1扩展数据.
viewerExtraInfo2扩展数据.
viewerExtraInfo3扩展数据.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注意
在 vrm12/vrm13 中, 如果不设置 viewerId, 会播放失败.
制作者 doxygen 1.9.4