plv-player-def.h File Reference

Go to the source code of this file.

Data Structures
struct	PLVAccountInfo
struct	PLVOsdConfigInfo
struct	PLVLogoTextInfo
struct	PLVVideoRequestParam
struct	PLVVideoRequestInfo
struct	PLVVideoRequestInfo::Rate
struct	PLVVideoRequestPageInfo
struct	PLVVideoFrame

Enumerations
enum	VIDEO_RATE_TYPE {   VIDEO_RATE_AUTO = 0 , VIDEO_RATE_LD , VIDEO_RATE_SD , VIDEO_RATE_HD ,   VIDEO_RATE_SOURCE }
enum	LOG_FILTER_TYPE {   LOG_FILTER_OFF = 0 , LOG_FILTER_DEBUG , LOG_FILTER_INFO , LOG_FILTER_WARN ,   LOG_FILTER_ERROR , LOG_FILTER_FATAL }
enum	SOFTWARE_RECORDING_NOTIFY_TYPE { SOFTWARE_RECORDING_NONE = 0 , SOFTWARE_RECORDING_START , SOFTWARE_RECORDING_STOP }
enum	DEVICE_CHANGED_TYPE { DEVICE_CHANGED_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_ABORT_OPERATION , E_DOWNLOAD_ERR , E_DOWNLOADING , 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_VIEWERID_EMPTY , E_MAC_NOT_ALLFILESACCESS , E_STILL_REQUEST ,   E_MIGRATE_ERR , E_CAFILE_ERR , E_HTTP_MAX , E_CORE_MAX = 1000 }
enum	PLAYER_MEDIA_STATE {   MEDIA_STATE_NONE = -1 , 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_NONE = -1 , 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 }
enum	VIDEO_REQUEST_TYPE { VIDEO_REQUEST_NONE = 0 , VIDEO_REQUEST_VID , VIDEO_REQUEST_PAGE }

Variables
const int	PLV_MAX_DEVICE_ID_LENGTH = 512

Enumeration Type Documentation

DEVICE_CHANGED_TYPE

enum DEVICE_CHANGED_TYPE

Device Changed type

Enumerator
DEVICE_CHANGED_NONE	no device changed.
HDMI_DEVICE_USE	the device can use.
HDMI_DEVICE_UNUSE	the device can not use.

Definition at line 90 of file plv-player-def.h.

LOG_FILTER_TYPE

enum LOG_FILTER_TYPE

Output log filter level.

Enumerator
LOG_FILTER_OFF	Do not output any log information.
LOG_FILTER_DEBUG	Output all log information. Set your log filter as debug if you want to get the most complete log file.
LOG_FILTER_INFO	Output FATAL, ERROR, WARNING, and INFO level log information. We recommend setting your log filter as this level.
LOG_FILTER_WARN	Outputs FATAL, ERROR, and WARNING level log information.
LOG_FILTER_ERROR	Outputs FATAL and ERROR level log information.
LOG_FILTER_FATAL	Outputs FATAL level log information.

Definition at line 58 of file plv-player-def.h.

OSD_DISPLAY_TYPE

enum OSD_DISPLAY_TYPE

OSD display type.

Enumerator
OSD_DISPALY_ROLL	Scroll right to left.
OSD_DISPALY_BLINK	Random position flicker.

Definition at line 224 of file plv-player-def.h.

PLAYER_MEDIA_FORMAT

enum PLAYER_MEDIA_FORMAT

the player media data format.

Enumerator
MEDIA_FORMAT_INT64	int type.
MEDIA_FORMAT_DOUBLE	double type.
MEDIA_FORMAT_STRING	string type.

Definition at line 217 of file plv-player-def.h.

PLAYER_MEDIA_PROPERTY

enum PLAYER_MEDIA_PROPERTY

the player media property.

Enumerator
MEDIA_PROPERTY_NONE	none.
MEDIA_PROPERTY_DURATION	the media duration. millisecond. MEDIA_FORMAT_INT64.
MEDIA_PROPERTY_POSTION	the media play pos. Attention no use, please use callback.
MEDIA_PROPERTY_HWDEC	the media Hardware coding name. MEDIA_FORMAT_STRING.
MEDIA_PROPERTY_VIDEO_CODEC	the video codec name. MEDIA_FORMAT_STRING.
MEDIA_PROPERTY_VIDEO_BITRATE	the video bitrate. MEDIA_FORMAT_INT64.
MEDIA_PROPERTY_VIDEO_FPS	the video fps. MEDIA_FORMAT_DOUBLE.
MEDIA_PROPERTY_VIDEO_WIDTH	the video resolution width. MEDIA_FORMAT_INT64.
MEDIA_PROPERTY_VIDEO_HEIGHT	the video resolution height. MEDIA_FORMAT_INT64.
MEDIA_PROPERTY_AUDIO_CODEC	the audio codec name. MEDIA_FORMAT_STRING.
MEDIA_PROPERTY_AUDIO_BITRATE	the audio bitrate. MEDIA_FORMAT_INT64.
MEDIA_PROPERTY_CACHE_SPEED	cache speed bytes, value / 1024 for KB/S, value / (1024*1024) for MB/S. MEDIA_FORMAT_INT64.
MEDIA_PROPERTY_CACHE_PROGRESS	cache progress, percent 100%. MEDIA_FORMAT_STRING.
MEDIA_PROPERTY_CACHE_TIME	cache time. millisecond. MEDIA_FORMAT_INT64.

Definition at line 200 of file plv-player-def.h.

PLAYER_MEDIA_STATE

enum PLAYER_MEDIA_STATE

the player media state.

Enumerator
MEDIA_STATE_NONE	none
MEDIA_STATE_LOADING	the player media file is loading.
MEDIA_STATE_LOADED	the player media file is loaded.
MEDIA_STATE_PLAY	playing the media.
MEDIA_STATE_PAUSE	pause the media.
MEDIA_STATE_BEGIN_CACHE	the media is begin cache.
MEDIA_STATE_END_CACHE	the media is end cache.
MEDIA_STATE_BEGIN_SEEKING	the media is begin seeking.
MEDIA_STATE_END_SEEKING	the media is end seeking.
MEDIA_STATE_FAIL	the media play fail, see log.
MEDIA_STATE_END	the media is play end.

Definition at line 186 of file plv-player-def.h.

SDK_ERROR_TYPE

enum SDK_ERROR_TYPE

the error code.

Enumerator
E_NO_ERR	success.
E_NO_INIT	sdk no init.
E_NO_FILE	no this file.
E_NO_RATE	the video no this rate.
E_NO_SPACE	insufficient free space on hard drive.
E_NO_SUPPORT	sdk no support.
E_VID_ERR	the vid format error.
E_KEY_ERR	download key file error or key format error.
E_ZIP_ERR	download zip file error or decompression error.
E_M3U8_ERR	download m3u8 file error or m3u8 format error.
E_HTTP_ERR	http request error.
E_PATH_ERR	the path is illegal.
E_PARAM_ERR	the param is illegal.
E_DELETE_ERR	delete file error.
E_INVOKE_ERR	invoke api error.
E_NETWORK_ERR	network error.
E_ABORT_OPERATION	user abort download.
E_DOWNLOAD_ERR	download error, will be open file error, or path error.
E_DOWNLOADING	the object is downloading.
E_DELETE_VIDEO	cancel download and delete.
E_MEDIA_UNINIT	the mdeia not init(no set vid).
E_MEDIA_UNLOAD	the media is unload.
E_MEDIA_LOADING	the media is loading.
E_TSFILESIZE	ts file size is zero.
E_OUTFLOW	the media return outflow.
E_OSDFONT_ERR	not font file.
E_FILE_INCOMPLETE	file incomplete.
E_OBJECT_NULL	the object is nullptr.
E_NO_AUDIO_DEVICE	not audio device.
E_VIEWERID_EMPTY	viewerid is empty. in vrm12/vrm13,must set it, empty will play fail.
E_MAC_NOT_ALLFILESACCESS	on mac, DetectSoftwareRecording must have AllFilesAccess
E_STILL_REQUEST	still request the video info.
E_MIGRATE_ERR	migrate error,maybe the key file not correct.
E_CAFILE_ERR	CA certificate file error.
E_HTTP_MAX	over this value will be http error code(code - E_HTTP_MAX).
E_CORE_MAX	over this value will be core code error(code - E_CORE_MAX).

Definition at line 144 of file plv-player-def.h.

SDK_HTTP_REQUEST

enum SDK_HTTP_REQUEST

first http request.

Enumerator
FIRST_HTTP_REQUEST	will use first use http to request data, if fails, use it again with https.
FIRST_HTTPS_REQUEST	will use first use https to request data, if fails, use it again with http.
ONLY_HTTP_REQUEST	only use http protocol.
ONLY_HTTPS_REQUEST	only use https protocol. Note default value.

Definition at line 130 of file plv-player-def.h.

SOFTWARE_RECORDING_NOTIFY_TYPE

enum SOFTWARE_RECORDING_NOTIFY_TYPE

Software recording notify type

Enumerator
SOFTWARE_RECORDING_NONE	No software screen recording or plugin injection.
SOFTWARE_RECORDING_START	Launching third-party software with recording function.
SOFTWARE_RECORDING_STOP	Exiting third-party software with recording function.

Definition at line 80 of file plv-player-def.h.

VIDEO_OUTPUT_DEVICE

enum VIDEO_OUTPUT_DEVICE

Video output drivers are interfaces to different video output facilities.

Note

If there is no video problem, it is generally not recommended to use.

Enumerator
VIDEO_OUTPUT_NONE	default system.
VIDEO_OUTPUT_GPU	Shader - based GPU Renderer General purpose, customizable, GPU-accelerated video output driver. It supports extended scaling methods, dithering, color management, custom shaders, HDR, and more.
VIDEO_OUTPUT_DIRECT3D	Direct3D 9 Renderer Video output driver that uses the Direct3D interface. This driver is for compatibility with systems that don't provide proper OpenGL drivers, and where ANGLE does not perform well. Note only use in windows
VIDEO_OUTPUT_GDI	Windows GDI video output Video output driver that uses the GDI interface. This driver is for compatibility with systems that don't provide proper OpenGL drivers, and where ANGLE does not perform well. Note only use in windows

Definition at line 102 of file plv-player-def.h.

VIDEO_RATE_TYPE

enum VIDEO_RATE_TYPE

the video rate.

Enumerator
VIDEO_RATE_AUTO	only in play can use,do not use in download. auto to set rate. Will use the default sharpness of the video, if the default sharpness does not exist, automatic progressive sharpness switching will occur
VIDEO_RATE_LD	Video standard definition.
VIDEO_RATE_SD	Video high definition.
VIDEO_RATE_HD	Video ultra clear.
VIDEO_RATE_SOURCE	Video Original definition. if this rate, First, determine whether it is a source file. If it is a source file, play the source file directly, otherwise it is equivalent to @VIDEO_RATE_AUTO. Note only be used for playback.

Definition at line 38 of file plv-player-def.h.

VIDEO_REQUEST_TYPE

enum VIDEO_REQUEST_TYPE

video request type.

Enumerator
VIDEO_REQUEST_NONE	search none.
VIDEO_REQUEST_VID	vids search, eg: 1b448be3231361255350f047cd7ed6bb_1,1b448be323b8d9b9489dcd7e8e09f087_1.
VIDEO_REQUEST_PAGE	page search.

Definition at line 326 of file plv-player-def.h.

Variable Documentation

PLV_MAX_DEVICE_ID_LENGTH

const int PLV_MAX_DEVICE_ID_LENGTH = 512

the device string length.

Definition at line 35 of file plv-player-def.h.