plv player sdk doc
结构体 | 枚举 | 变量
plv-player-def-CN.h 文件参考

浏览源代码.

结构体

struct  OSDConfigInfo
 
struct  LogoTextInfo
 

枚举

enum  VIDEO_RATE_TYPE { VIDEO_RATE_AUTO = 0 , VIDEO_RATE_SD , VIDEO_RATE_HD , VIDEO_RATE_BD }
 
enum  LOG_FILTER_TYPE {
  LOG_FILTER_OFF = 0 , LOG_FILTER_DEBUG , LOG_FILTER_INFO , LOG_FILTER_WARN ,
  LOG_FILTER_ERROR , LOG_FILTER_FATAL
}
 
enum  HDMI_DEVICE_TYPE { HDMI_DEVICE_NONE = 0 , HDMI_DEVICE_USE , HDMI_DEVICE_UNUSE }
 
enum  VIDEO_OUTPUT_DEVICE { VIDEO_OUTPUT_NONE = 0 , VIDEO_OUTPUT_GPU , VIDEO_OUTPUT_DIRECT3D , VIDEO_OUTPUT_GDI }
 
enum  SDK_HTTP_REQUEST { FIRST_HTTP_REQUEST = 0 , FIRST_HTTPS_REQUEST , ONLY_HTTP_REQUEST , ONLY_HTTPS_REQUEST }
 
enum  SDK_ERROR_TYPE {
  E_NO_ERR = 0 , E_NO_INIT , E_NO_FILE , E_NO_RATE ,
  E_NO_SPACE , E_NO_SUPPORT , E_VID_ERR , E_KEY_ERR ,
  E_ZIP_ERR , E_M3U8_ERR , E_HTTP_ERR , E_PATH_ERR ,
  E_PARAM_ERR , E_DELETE_ERR , E_INVOKE_ERR , E_NETWORK_ERR ,
  E_DOWNLOAD_ERR , E_DOWNLOADING , E_ABORT_DOWNLOAD , E_DELETE_VIDEO ,
  E_MEDIA_UNINIT , E_MEDIA_UNLOAD , E_MEDIA_LOADING , E_TSFILESIZE ,
  E_OUTFLOW , E_OSDFONT_ERR , E_FILE_INCOMPLETE , E_OBJECT_NULL ,
  E_NO_AUDIO_DEVICE , E_ERROR_MAX
}
 
enum  PLAYER_MEDIA_STATE {
  MEDIA_STATE_LOADING = 0 , MEDIA_STATE_LOADED , MEDIA_STATE_PLAY , MEDIA_STATE_PAUSE ,
  MEDIA_STATE_BEGIN_CACHE , MEDIA_STATE_END_CACHE , MEDIA_STATE_BEGIN_SEEKING , MEDIA_STATE_END_SEEKING ,
  MEDIA_STATE_FAIL , MEDIA_STATE_END
}
 
enum  PLAYER_MEDIA_PROPERTY {
  MEDIA_PROPERTY_DURATION = 0 , MEDIA_PROPERTY_POSTION , MEDIA_PROPERTY_HWDEC , MEDIA_PROPERTY_VIDEO_CODEC ,
  MEDIA_PROPERTY_VIDEO_BITRATE , MEDIA_PROPERTY_VIDEO_FPS , MEDIA_PROPERTY_VIDEO_WIDTH , MEDIA_PROPERTY_VIDEO_HEIGHT ,
  MEDIA_PROPERTY_AUDIO_CODEC , MEDIA_PROPERTY_AUDIO_BITRATE , MEDIA_PROPERTY_CACHE_SPEED , MEDIA_PROPERTY_CACHE_PROGRESS ,
  MEDIA_PROPERTY_CACHE_TIME
}
 
enum  PLAYER_MEDIA_FORMAT { MEDIA_FORMAT_INT64 = 0 , MEDIA_FORMAT_DOUBLE , MEDIA_FORMAT_STRING }
 
enum  OSD_DISPLAY_TYPE { OSD_DISPALY_ROLL = 0 , OSD_DISPALY_BLINK }
 

变量

const int PLV_MAX_DEVICE_ID_LENGTH = 512
 

枚举类型说明

◆ HDMI_DEVICE_TYPE

HDMI 硬件设备的变动枚举类型.

枚举值
HDMI_DEVICE_NONE 

无 HDMI 设备.

HDMI_DEVICE_USE 

HDMI 插入使用中.

HDMI_DEVICE_UNUSE 

HDMI 拔出停止使用.

在文件 plv-player-def-CN.h77 行定义.

◆ LOG_FILTER_TYPE

输出日志过滤枚举类型.

枚举值
LOG_FILTER_OFF 

不输出任何日志类型.

LOG_FILTER_DEBUG 

输出所有日志信息. 如果要获取最完整的日志文件, 请将日志过滤设置为此类型, 但日志文件会增大. 调试信息.

LOG_FILTER_INFO 

输出所有 FATAL, ERROR, WARNING, INFO 的日志信息. 建议将日志过滤器设置为此级别. 一般信息.

注解
默认值
LOG_FILTER_WARN 

输出所有 FATAL, ERROR, WARNING 的日志信息. 警告信息.

LOG_FILTER_ERROR 

输出所有 FATAL, ERROR 的日志信息. 错误信息.

LOG_FILTER_FATAL 

输出所有 FATAL 的日志信息. 致命信息.

在文件 plv-player-def-CN.h47 行定义.

◆ OSD_DISPLAY_TYPE

跑马灯动画效果枚举类型.

枚举值
OSD_DISPALY_ROLL 

从右到左滚动.

注解
默认值
OSD_DISPALY_BLINK 

随机位置闪烁.

在文件 plv-player-def-CN.h202 行定义.

◆ PLAYER_MEDIA_FORMAT

数据类型枚举类型.

枚举值
MEDIA_FORMAT_INT64 

整型.

MEDIA_FORMAT_DOUBLE 

浮动型.

MEDIA_FORMAT_STRING 

字符串.

在文件 plv-player-def-CN.h195 行定义.

◆ PLAYER_MEDIA_PROPERTY

播放音视频属性枚举类型.

枚举值
MEDIA_PROPERTY_DURATION 

播放时长. 单位:毫秒. MEDIA_FORMAT_INT64.

MEDIA_PROPERTY_POSTION 

播放进度.

注意
不使用, 请使用播放进度回调.
MEDIA_PROPERTY_HWDEC 

硬件编码. MEDIA_FORMAT_STRING.

MEDIA_PROPERTY_VIDEO_CODEC 

视频编码. MEDIA_FORMAT_STRING.

MEDIA_PROPERTY_VIDEO_BITRATE 

视频码率. MEDIA_FORMAT_INT64.

MEDIA_PROPERTY_VIDEO_FPS 

视频帧率. MEDIA_FORMAT_DOUBLE.

MEDIA_PROPERTY_VIDEO_WIDTH 

视频宽度. MEDIA_FORMAT_INT64.

MEDIA_PROPERTY_VIDEO_HEIGHT 

视频高度. MEDIA_FORMAT_INT64.

MEDIA_PROPERTY_AUDIO_CODEC 

音频编码. MEDIA_FORMAT_STRING.

MEDIA_PROPERTY_AUDIO_BITRATE 

音频码率. MEDIA_FORMAT_INT64.

MEDIA_PROPERTY_CACHE_SPEED 

缓存速度, 单位:字节数. MEDIA_FORMAT_INT64.

MEDIA_PROPERTY_CACHE_PROGRESS 

缓存进度, 100%. MEDIA_FORMAT_STRING.

MEDIA_PROPERTY_CACHE_TIME 

缓存时间. 单位:毫秒. MEDIA_FORMAT_INT64.

在文件 plv-player-def-CN.h179 行定义.

◆ PLAYER_MEDIA_STATE

播放器音视频状态枚举类型.

枚举值
MEDIA_STATE_LOADING 

加载中.

MEDIA_STATE_LOADED 

加载完成.

MEDIA_STATE_PLAY 

播放中.

MEDIA_STATE_PAUSE 

暂停中.

MEDIA_STATE_BEGIN_CACHE 

开始缓存.

MEDIA_STATE_END_CACHE 

停止缓存.

MEDIA_STATE_BEGIN_SEEKING 

开始跳转.

MEDIA_STATE_END_SEEKING 

停止跳转.

MEDIA_STATE_FAIL 

播放失败.

MEDIA_STATE_END 

播放结束.

在文件 plv-player-def-CN.h166 行定义.

◆ SDK_ERROR_TYPE

错误码枚举类型.

枚举值
E_NO_ERR 

成功.

E_NO_INIT 

SDK 未初始化.

E_NO_FILE 

没有此文件.

E_NO_RATE 

没有此视频清晰度.

E_NO_SPACE 

硬盘剩余空间不足.

E_NO_SUPPORT 

SDK 不支持此接口.

E_VID_ERR 

视频 id 不合法.

E_KEY_ERR 

下载 key 文件失败或者 key 文件不合法.

E_ZIP_ERR 

下载 zip 包失败或者 zip 包解压失败.

E_M3U8_ERR 

下载 m3u8 文件失败或者 m3u8 文件不合法.

E_HTTP_ERR 

网络请求失败, 请检查网络.

E_PATH_ERR 

文件路径不合法.

E_PARAM_ERR 

参数传递不合法.

E_DELETE_ERR 

删除文件失败.

E_INVOKE_ERR 

调用接口失败.

E_NETWORK_ERR 

网络错误.

E_DOWNLOAD_ERR 

下载失败, 可能出现打开文件或者路径失败.

E_DOWNLOADING 

此文件正在下载中.

E_ABORT_DOWNLOAD 

用户主动中断下载.

E_DELETE_VIDEO 

用户主动取消下载并删除文件.

E_MEDIA_UNINIT 

未调用视频的初始化接口(setvideo).

E_MEDIA_UNLOAD 

视频未加载.

E_MEDIA_LOADING 

视频正在加载中.

E_TSFILESIZE 

ts 文件为空.

E_OUTFLOW 

流量超额.

E_OSDFONT_ERR 

跑马灯没有字体文件.

E_FILE_INCOMPLETE 

视频文件不完整.

E_OBJECT_NULL 

对象为空.

E_NO_AUDIO_DEVICE 

无扬声器设备.

E_ERROR_MAX 

超过此值将出现核心代码错误.

在文件 plv-player-def-CN.h131 行定义.

◆ SDK_HTTP_REQUEST

网络请求协议枚举类型.

枚举值
FIRST_HTTP_REQUEST 

将首先使用 http 协议请求数据, 如果失败, 重试时自动切换为 https 协议

FIRST_HTTPS_REQUEST 

将首先使用 https 协议请求数据, 如果失败, 重试时自动切换为 http 协议.

ONLY_HTTP_REQUEST 

一直使用 http 协议.

ONLY_HTTPS_REQUEST 

一直使用 https 协议.

注解
默认值

在文件 plv-player-def-CN.h117 行定义.

◆ VIDEO_OUTPUT_DEVICE

视频输出驱动枚举类型.

注解
如果没有出现无画面等问题, 通常不建议使用.
枚举值
VIDEO_OUTPUT_NONE 

系统默认类型.

注解
默认值
VIDEO_OUTPUT_GPU 

基于着色器的GPU渲染器. 通用、可定制的GPU加速视频输出驱动程序. 它支持扩展缩放方法、抖动、颜色管理、自定义着色器、HDR等.

VIDEO_OUTPUT_DIRECT3D 

Direct3D 9渲染器 使用Direct3D接口的视频输出驱动程序. 此驱动程序用于与未提供适当OpenGL驱动程序的系统兼容, 并且ANGLE的性能不好的情况下.

注解
只能应用于windows系统
VIDEO_OUTPUT_GDI 

GDI 渲染输出 使用 GDI 接口的视频输出驱动程序. 此驱动程序用于与未提供适当OpenGL驱动程序的系统兼容, 并且ANGLE的性能不好的情况下.

注解
只能应用于windows系统

在文件 plv-player-def-CN.h89 行定义.

◆ VIDEO_RATE_TYPE

视频清晰度枚举类型.

枚举值
VIDEO_RATE_AUTO 

只在在线播放中使用, 不能用在下载接口.

自动切换清晰度类型.

VIDEO_RATE_SD 

标清.

VIDEO_RATE_HD 

高清.

VIDEO_RATE_BD 

超清.

在文件 plv-player-def-CN.h37 行定义.

变量说明

◆ PLV_MAX_DEVICE_ID_LENGTH

const int PLV_MAX_DEVICE_ID_LENGTH = 512

设备相关的最大字符串大小.

在文件 plv-player-def-CN.h34 行定义.