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

类型定义

typedef void(* OnRequestVideoInfoHandler) (int code, const PLVVideoRequestInfo infos[], int infosNum, const PLVVideoRequestPageInfo *pageInfo, void *data)
 请求视频信息的回调通知.
 
typedef void(* OnPlayerAudioDeviceHandler) (int audioDeviceCount, 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 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 PLVPlayerSetAudioDeviceHandler (PLVPlayerPtr player, OnPlayerAudioDeviceHandler handler, void *data)
 设置扬声器热插拔的回调通知.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetAudioDeviceCount (PLVPlayerPtr player)
 获取扬声器设备总数.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetAudioDeviceInfo (PLVPlayerPtr player, int index, char deviceId[PLV_MAX_DEVICE_ID_LENGTH], char deviceName[PLV_MAX_DEVICE_ID_LENGTH])
 获取扬声器设备信息.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerReloadAudioDevice (PLVPlayerPtr player)
 重置扬声器设备. 使用场景, 可以在收到设备变动回调, 再调用此接口即可.
 

详细描述

类型定义说明

◆ OnPlayerAudioDeviceHandler

typedef void(* OnPlayerAudioDeviceHandler) (int audioDeviceCount, void *data)

播放扬声器设备的回调通知.

弃用
参数
[out]audioDeviceCount扬声器总的个数.
[out]data用户自定义上下文数据.

在文件 plv-player-deprecated-CN.h87 行定义.

◆ OnRequestVideoInfoHandler

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

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

deprecated 建议在服务器上请求视频信息

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

在文件 plv-player-deprecated-CN.h40 行定义.

函数说明

◆ PLVCancelRequestVideoInfo()

PLAYERSDK_API int PLAYERSDK_CALL PLVCancelRequestVideoInfo ( )

中断请求视频信息.

弃用
建议在服务器上请求视频信息
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
必须在初始化后使用.

◆ PLVMigrateLocalVideoKeyFile()

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

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

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

◆ PLVPlayerGetAudioDeviceCount()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetAudioDeviceCount ( PLVPlayerPtr player)

获取扬声器设备总数.

弃用
参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • >=0: 总数.

◆ PLVPlayerGetAudioDeviceInfo()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetAudioDeviceInfo ( PLVPlayerPtr player,
int index,
char deviceId[PLV_MAX_DEVICE_ID_LENGTH],
char deviceName[PLV_MAX_DEVICE_ID_LENGTH] )

获取扬声器设备信息.

弃用
参数
player播放对象.
参见
PLVPlayerCreate.
参数
index扬声器设备索引.
[out]deviceId扬声器设备标识.
[out]deviceName扬声器设备名称.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerReloadAudioDevice()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerReloadAudioDevice ( PLVPlayerPtr player)

重置扬声器设备. 使用场景, 可以在收到设备变动回调, 再调用此接口即可.

弃用
暂无需调用
参数
player播放对象.
参见
PLVPlayerCreate.
注解
如果没有原始音频设备, 则需要在新插入后重新加载音频.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerSetAudioDeviceHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetAudioDeviceHandler ( PLVPlayerPtr player,
OnPlayerAudioDeviceHandler handler,
void * data )

设置扬声器热插拔的回调通知.

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

◆ 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 协议, 一定要设置证书文件, 不然会请求失败.

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

◆ PLVSetSdkHttpRequest()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkHttpRequest ( SDK_HTTP_REQUEST type)

设置 SDK 的网络请求协议.

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