全局接口

函数
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	PLVSetSdkLogFile (const char *fileName)
	设置 SDK 的日志文件位置, 文件名带路径. 更多...
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetSdkLogLevel (LOG_FILTER_TYPE level)
	设置 SDK 的日志过滤等级. 更多...
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	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 的信息追踪, 建议设置, 在 vrm12 中, 如果不设置 viewerId, 会播放失败. 更多...
PLAYERSDK_API int PLAYERSDK_CALL	PLVInitSdkLibrary (const char *userId, const char *secretKey, const char *readToken)
	初始化 SDK , 在使用 SDK 前一定要调用此接口. 更多...
PLAYERSDK_API void PLAYERSDK_CALL	PLVReleaseSdkLibrary (void)
	析构 SDK, 停止使用后要调用此接口. 更多...

详细描述

函数说明

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.

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,
		const char *	readToken
	)

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

参数

userId	user id, 请向 SDK 供应商获取.
secretKey	user secret key, 请向 SDK 供应商获取.
readToken	user read token, 请向 SDK 供应商获取.

返回

• 0: 成功.
• > 0: 失败, 错误码.

PLVReleaseSdkLibrary()

PLAYERSDK_API void PLAYERSDK_CALL PLVReleaseSdkLibrary

(

void

)

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

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.

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");

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 的信息追踪, 建议设置, 在 vrm12 中, 如果不设置 viewerId, 会播放失败.

参数

viewerId	用户自定义标识.
viewerName	用户自定义名称.
viewerAvatar	用户自定义头像.
viewerExtraInfo1	扩展数据.
viewerExtraInfo2	扩展数据.
viewerExtraInfo3	扩展数据.

返回

• 0: 成功.
• > 0: 失败, 错误码.