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

类型定义

typedef void * PLVPlayerPtr
 播放对象, 每一个播放对象同时只能播放一个视频, 可以创建多个播放对象.
 
typedef bool(* OnPlayerVideoFrameHandler) (const char *vid, PLVVideoFrame *frame, void *data)
 播放视频帧的回调通知.
 
typedef void(* OnPlayerStateHandler) (const char *vid, int state, void *data)
 播放状态的回调通知.
 
typedef void(* OnPlayerPropertyHandler) (const char *vid, int property, int format, const char *value, void *data)
 播放属性值的回调通知.
 
typedef void(* OnPlayerRateChangeHandler) (const char *vid, int inputRate, int realRate, void *data)
 播放清晰度的回调通知. 此回调的场景在:
 
typedef void(* OnPlayerProgressHandler) (const char *vid, int millisecond, void *data)
 播放进度的回调通知.
 
typedef void(* OnPlayerAudioPlayErrorHandler) (const char *vid, void *data)
 音频播放错误回调.
 
typedef void(* OnPlayerAudioDeviceHandler) (int audioDeviceCount, void *data)
 播放扬声器设备的回调通知.
 

函数

PLAYERSDK_API PLVPlayerPtr PLAYERSDK_CALL PLVPlayerCreate (void *window)
 创建播放对象并返回对象指针. 在使用播放接口对象前, 必须先调用此接口创建对象.
 
PLAYERSDK_API void PLAYERSDK_CALL PLVPlayerDestroy (PLVPlayerPtr player)
 销毁播放对象. 不再使用创建的对象后, 必须调用此接口回收.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetVideoFrameHandler (PLVPlayerPtr player, OnPlayerVideoFrameHandler lockHandler, OnPlayerVideoFrameHandler unlockHandler, void *data)
 设置播放视频帧的回调通知.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetStateHandler (PLVPlayerPtr player, OnPlayerStateHandler handler, void *data)
 设置播放状态的回调通知.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetPropertyHandler (PLVPlayerPtr player, OnPlayerPropertyHandler handler, void *data)
 设置播放属性值的回调通知.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetRateChangeHandler (PLVPlayerPtr player, OnPlayerRateChangeHandler handler, void *data)
 设置清晰度变化的回调通知. 只有输入清度为 VIDEO_RATE_AUTO 才会触发此回调.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetProgressHandler (PLVPlayerPtr player, OnPlayerProgressHandler handler, void *data)
 设置播放进度的回调通知.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetAudioPlayErrorHandler (PLVPlayerPtr player, OnPlayerAudioPlayErrorHandler handler, void *data)
 设置音频播放错误回调.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetAudioDeviceHandler (PLVPlayerPtr player, OnPlayerAudioDeviceHandler handler, void *data)
 设置扬声器热插拔的回调通知.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerResetHandler (PLVPlayerPtr player)
 重置所有回调通知, 会请空所有的回调函数地址.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetOSDConfig (PLVPlayerPtr player, bool enable, const PLVOsdConfigInfo *config)
 设置跑马灯信息
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetOSDConfig (PLVPlayerPtr player, PLVOsdConfigInfo &config)
 获取跑马灯信息.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetLogoText (PLVPlayerPtr player, bool enable, const PLVLogoTextInfo *config)
 设置 LOGO 信息
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetLogoText (PLVPlayerPtr player, PLVLogoTextInfo &config)
 获取 LOGO 信息.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetCacheConfig (PLVPlayerPtr player, bool enable, int maxCacheBytes, int maxCacheSeconds)
 设置播放缓存信息.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetCacheConfig (PLVPlayerPtr player, int *maxCacheBytes, int *maxCacheSeconds)
 获取缓存信息.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetInfo (PLVPlayerPtr player, const char *vid, const char *path, int rate)
 设置视频信息. 在调用播放前, 必须先设置视频的相关信息, 否则会报错.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerPlay (PLVPlayerPtr player, const char *token, int seekMillisecond, bool autoDownRate, bool traceVideo, bool sync)
 播放视频.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerPlayLocal (PLVPlayerPtr player, int seekMillisecond, bool autoDownRate)
 离线播放. 调用前必须设置视频的存放地址.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerLoadLocal (PLVPlayerPtr player, int seekMillisecond, bool autoDownRate)
 离线加载视频, 不自动播放. 调用前必须设置视频的存放地址.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerPause (PLVPlayerPtr player, bool pause)
 设置是否暂停状态.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerStop (PLVPlayerPtr player)
 停止播放.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetMute (PLVPlayerPtr player, bool mute)
 设置是否静音状态.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetSeek (PLVPlayerPtr player, int millisecond)
 跳转到指定的播放位置.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSeekToEnd (PLVPlayerPtr player)
 停止在最后一帧.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetVolume (PLVPlayerPtr player, int volume)
 设置播放声音.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetVolumeMax (PLVPlayerPtr player, int volume)
 设置声音增益.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerScreenshot (PLVPlayerPtr player, const char *filename)
 视频截屏.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetSpeed (PLVPlayerPtr player, double speed)
 倍速播放, 通过作为参数给定的系数来减慢或加快播放速度.
 
PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsMute (PLVPlayerPtr player)
 判断是否静音状态.
 
PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsValid (PLVPlayerPtr player)
 判断是否加载还是空闲状态.
 
PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsPause (PLVPlayerPtr player)
 判断是否暂停状态.
 
PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsPlaying (PLVPlayerPtr player)
 判断是否播放中.
 
PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsLoaded (PLVPlayerPtr player)
 判断视频是否加载.
 
PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsLoading (PLVPlayerPtr player)
 判断视频是否加载中.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetCurrentRateCount (PLVPlayerPtr player)
 获取视频的清晰度总数.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetCurrentRate (PLVPlayerPtr player)
 当前视频的清晰度.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetVolume (PLVPlayerPtr player)
 获取当前音量值.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetDuration (PLVPlayerPtr player)
 获取视频的时长.
 
PLAYERSDK_API double PLAYERSDK_CALL PLVPlayerGetSpeed (PLVPlayerPtr player)
 获取视频播放倍数.
 
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 PLVPlayerGetCurrentAudioDevice (PLVPlayerPtr player, char deviceId[PLV_MAX_DEVICE_ID_LENGTH])
 获取当前扬声器设备标识.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetCurrentAudioDevice (PLVPlayerPtr player, const char deviceId[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-core-CN.h 第 407 行定义.

◆ OnPlayerAudioPlayErrorHandler

typedef void(* OnPlayerAudioPlayErrorHandler) (const char *vid, void *data)

音频播放错误回调.

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

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

◆ OnPlayerProgressHandler

typedef void(* OnPlayerProgressHandler) (const char *vid, int millisecond, void *data)

播放进度的回调通知.

参数
[out]vid视频标识.
[out]millisecond时间进度.
[out]data用户自定义上下文数据.
注解
替换属性回调里的属性类型 MEDIA_PROPERTY_POSTION.

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

◆ OnPlayerPropertyHandler

typedef void(* OnPlayerPropertyHandler) (const char *vid, int property, int format, const char *value, void *data)

播放属性值的回调通知.

参数
[out]vid视频标识.
[out]property属性类型.
参见
PLAYER_MEDIA_PROPERTY.
参数
[out]format属性数据类型.
参见
PLAYER_MEDIA_FORMAT.
参数
[out]value属性值.
[out]data用户自定义上下文数据.

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

◆ OnPlayerRateChangeHandler

typedef void(* OnPlayerRateChangeHandler) (const char *vid, int inputRate, int realRate, void *data)

播放清晰度的回调通知. 此回调的场景在:

  • 当播放时指定较高的清晰度不存在时, 如果指定清晰度为自动时, 会自动降低清晰, 保证正常播放.
    参数
    [out]vid视频标识.
    [out]inputRate用户输入的清晰度.
    [out]realRate真正播放的清晰度.
    [out]data用户自定义上下文数据.

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

◆ OnPlayerStateHandler

typedef void(* OnPlayerStateHandler) (const char *vid, int state, void *data)

播放状态的回调通知.

参数
[out]vid视频标识.
[out]state播放状态.
参见
PLAYER_MEDIA_STATE.
参数
[out]data用户自定义上下文数据.

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

◆ OnPlayerVideoFrameHandler

typedef bool(* OnPlayerVideoFrameHandler) (const char *vid, PLVVideoFrame *frame, void *data)

播放视频帧的回调通知.

参数
[out]vid视频标识.
[out]frame视频帧.
[out]data用户自定义上下文数据.

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

◆ PLVPlayerPtr

typedef void* PLVPlayerPtr

播放对象, 每一个播放对象同时只能播放一个视频, 可以创建多个播放对象.

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

函数说明

◆ PLVPlayerCreate()

PLAYERSDK_API PLVPlayerPtr PLAYERSDK_CALL PLVPlayerCreate ( void * window)

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

参数
window绑定播放窗口的句柄.
返回
  • Pointer: 播放对象指针.
注解
如果窗口句柄为空时, 接口将返回空指针.

◆ PLVPlayerDestroy()

PLAYERSDK_API void PLAYERSDK_CALL PLVPlayerDestroy ( PLVPlayerPtr player)

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

参数
player播放对象.
参见
PLVPlayerCreate.

◆ 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: 失败, 错误码.

◆ PLVPlayerGetCacheConfig()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetCacheConfig ( PLVPlayerPtr player,
int * maxCacheBytes,
int * maxCacheSeconds )

获取缓存信息.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
[out]maxCacheBytes缓存字节数.
[out]maxCacheSeconds缓存时间数.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerGetCurrentAudioDevice()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetCurrentAudioDevice ( PLVPlayerPtr player,
char deviceId[PLV_MAX_DEVICE_ID_LENGTH] )

获取当前扬声器设备标识.

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

◆ PLVPlayerGetCurrentRate()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetCurrentRate ( PLVPlayerPtr player)

当前视频的清晰度.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • 0: VIDEO_RATE_AUTO.
  • >0: 清晰度.

◆ PLVPlayerGetCurrentRateCount()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetCurrentRateCount ( PLVPlayerPtr player)

获取视频的清晰度总数.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • 0: 视频未加载或者无清晰度.
  • >0: 清晰度总数.

◆ PLVPlayerGetDuration()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetDuration ( PLVPlayerPtr player)

获取视频的时长.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • 0: 未加载.
  • >0: 时长.

◆ PLVPlayerGetLogoText()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetLogoText ( PLVPlayerPtr player,
PLVLogoTextInfo & config )

获取 LOGO 信息.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
[out]configLOGO 信息.
参见
PLVLogoTextInfo.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerGetOSDConfig()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetOSDConfig ( PLVPlayerPtr player,
PLVOsdConfigInfo & config )

获取跑马灯信息.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
[out]config跑马灯信息.
参见
PLVOsdConfigInfo.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerGetSpeed()

PLAYERSDK_API double PLAYERSDK_CALL PLVPlayerGetSpeed ( PLVPlayerPtr player)

获取视频播放倍数.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • double: 倍数.

◆ PLVPlayerGetVolume()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetVolume ( PLVPlayerPtr player)

获取当前音量值.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • 0: 失败.
  • >0: 音量值.

◆ PLVPlayerIsLoaded()

PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsLoaded ( PLVPlayerPtr player)

判断视频是否加载.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • true: 已经加载.
  • false: 未加载或者空闲中.

◆ PLVPlayerIsLoading()

PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsLoading ( PLVPlayerPtr player)

判断视频是否加载中.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • true: 加载中.
  • false: 已经加载或者空闲中.

◆ PLVPlayerIsMute()

PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsMute ( PLVPlayerPtr player)

判断是否静音状态.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • true: 静音.
  • false: 非静音.

◆ PLVPlayerIsPause()

PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsPause ( PLVPlayerPtr player)

判断是否暂停状态.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • true: 暂停中.
  • false: 非暂停或者空闲中.

◆ PLVPlayerIsPlaying()

PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsPlaying ( PLVPlayerPtr player)

判断是否播放中.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • true: 播放中.
  • false: 暂停或者空闲中.

◆ PLVPlayerIsValid()

PLAYERSDK_API bool PLAYERSDK_CALL PLVPlayerIsValid ( PLVPlayerPtr player)

判断是否加载还是空闲状态.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • true: 视频已经加载.
  • false: 无加载状态.

◆ PLVPlayerLoadLocal()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerLoadLocal ( PLVPlayerPtr player,
int seekMillisecond,
bool autoDownRate )

离线加载视频, 不自动播放. 调用前必须设置视频的存放地址.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
seekMillisecond指定开始播放的位置.
autoDownRate如果不存在清晰度是否自动降低清晰度. 使用场景是, 如果用户指定要播放的清晰度为超清时, 此清晰度不存在时:
  • 如果 autoDownRate=false, 则返回失败.
  • 如果 autoDownRate=true, 则会自动逐级降级清晰度.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerPause()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerPause ( PLVPlayerPtr player,
bool pause )

设置是否暂停状态.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
pause是否暂停.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerPlay()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerPlay ( PLVPlayerPtr player,
const char * token,
int seekMillisecond,
bool autoDownRate,
bool traceVideo,
bool sync )

播放视频.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
token加密视频必须使用它.
seekMillisecond指定开始播放的位置.
autoDownRate如果不存在清晰度是否自动降低清晰度. 使用场景是, 如果用户指定要播放的清晰度为超清时, 此清晰度不存在时:
  • 如果 autoDownRate=false, 则返回失败.
  • 如果 autoDownRate=true, 则会自动逐级降级清晰度.
traceVideo仅在溯源视频下需要设置为true.
sync是否同步播放.
  • 在线播放时, 会请求网线数据, 如果在网络不好的情况下, 播放前可能存在轻微的卡主线程, 此时可以使用异步方式, 则不会卡主线程.
  • 正常的网络情况下, 同步播放不会产生卡顿.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerPlayLocal()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerPlayLocal ( PLVPlayerPtr player,
int seekMillisecond,
bool autoDownRate )

离线播放. 调用前必须设置视频的存放地址.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
seekMillisecond指定开始播放的位置.
autoDownRate如果不存在清晰度是否自动降低清晰度. 使用场景是, 如果用户指定要播放的清晰度为超清时, 此清晰度不存在时:
  • 如果 autoDownRate=false, 则返回失败.
  • 如果 autoDownRate=true, 则会自动逐级降级清晰度.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerReloadAudioDevice()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerReloadAudioDevice ( PLVPlayerPtr player)

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

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

◆ PLVPlayerResetHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerResetHandler ( PLVPlayerPtr player)

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

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerScreenshot()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerScreenshot ( PLVPlayerPtr player,
const char * filename )

视频截屏.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
filenamepng/jpg 截屏文件, 包含路径, 使用 UTF8.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注意
路径必须使用 UTF8

◆ PLVPlayerSeekToEnd()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSeekToEnd ( 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: 失败, 错误码.

◆ PLVPlayerSetAudioPlayErrorHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetAudioPlayErrorHandler ( PLVPlayerPtr player,
OnPlayerAudioPlayErrorHandler handler,
void * data )

设置音频播放错误回调.

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

◆ PLVPlayerSetCacheConfig()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetCacheConfig ( PLVPlayerPtr player,
bool enable,
int maxCacheBytes,
int maxCacheSeconds )

设置播放缓存信息.

注解
如果计算机内存足够大, 建议不要调用此接口, 只使用默认值即可.
参数
player播放对象.
参见
PLVPlayerCreate.
参数
enable使用或不使用缓存, 决定是否使用网络缓存设置(默认: 自动).
maxCacheBytes默认值为 30MB(30*1024*1024),一般默认即可.设置-1无效
deprecatedMaxCacheSeconds: 过时的参数，设置为-1即可
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注解
如果 maxCacheBytes 和 maxCacheSeconds < 0, 则忽略此值, 使用默认值.

◆ PLVPlayerSetCurrentAudioDevice()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetCurrentAudioDevice ( PLVPlayerPtr player,
const char deviceId[PLV_MAX_DEVICE_ID_LENGTH] )

设置当前扬声器设备标识.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
deviceId扬声器设备标识.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerSetInfo()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetInfo ( PLVPlayerPtr player,
const char * vid,
const char * path,
int rate )

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

参数
player播放对象.
参见
PLVPlayerCreate.
参数
vid视频标识.
path视频存放的路径, 如果是离线播放, 则必须使用它, 使用 UTF8.
rate视频清晰度.
参见
VIDEO_RATE_TYPE.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
注意
路径必须使用 UTF8.

◆ PLVPlayerSetLogoText()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetLogoText ( PLVPlayerPtr player,
bool enable,
const PLVLogoTextInfo * config )

设置 LOGO 信息

参数
player播放对象.
参见
PLVPlayerCreate.
参数
enable是否使用 LOGO.
configLOGO 信息.
参见
PLVLogoTextInfo.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerSetMute()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetMute ( PLVPlayerPtr player,
bool mute )

设置是否静音状态.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
mute是否静音.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerSetOSDConfig()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetOSDConfig ( PLVPlayerPtr player,
bool enable,
const PLVOsdConfigInfo * config )

设置跑马灯信息

参数
player播放对象.
参见
PLVPlayerCreate.
参数
enable是否使用跑马灯.
config跑马灯信息.
参见
PLVOsdConfigInfo.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerSetProgressHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetProgressHandler ( PLVPlayerPtr player,
OnPlayerProgressHandler handler,
void * data )

设置播放进度的回调通知.

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

◆ PLVPlayerSetPropertyHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetPropertyHandler ( PLVPlayerPtr player,
OnPlayerPropertyHandler handler,
void * data )

设置播放属性值的回调通知.

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

◆ PLVPlayerSetRateChangeHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetRateChangeHandler ( PLVPlayerPtr player,
OnPlayerRateChangeHandler handler,
void * data )

设置清晰度变化的回调通知. 只有输入清度为 VIDEO_RATE_AUTO 才会触发此回调.

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

◆ PLVPlayerSetSeek()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetSeek ( PLVPlayerPtr player,
int millisecond )

跳转到指定的播放位置.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
millisecond指定播放的位置.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerSetSpeed()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetSpeed ( PLVPlayerPtr player,
double speed )

倍速播放, 通过作为参数给定的系数来减慢或加快播放速度.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
speed<0.01 - 100> 倍速范转, 1.0 正常播放.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerSetStateHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetStateHandler ( PLVPlayerPtr player,
OnPlayerStateHandler handler,
void * data )

设置播放状态的回调通知.

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

◆ PLVPlayerSetVideoFrameHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetVideoFrameHandler ( PLVPlayerPtr player,
OnPlayerVideoFrameHandler lockHandler,
OnPlayerVideoFrameHandler unlockHandler,
void * data )

设置播放视频帧的回调通知.

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

◆ PLVPlayerSetVolume()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetVolume ( PLVPlayerPtr player,
int volume )

设置播放声音.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
volume<0-100> 声音范围, 0 为静音.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerSetVolumeMax()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetVolumeMax ( PLVPlayerPtr player,
int volume )

设置声音增益.

参数
player播放对象.
参见
PLVPlayerCreate.
参数
volume<100-1000> 增益范转, 超过 1000 返回失败.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.

◆ PLVPlayerStop()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerStop ( PLVPlayerPtr player)

停止播放.

参数
player播放对象.
参见
PLVPlayerCreate.
返回
  • 0: 成功.
  • > 0: 失败, 错误码.
制作者 doxygen 1.10.0