plv player sdk doc
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
PLVOsdConfigInfo Struct Reference

#include <plv-player-def.h>

Public Member Functions

 PLVOsdConfigInfo ()
 

Data Fields

const char * text
 osd text display, must set. use utf8.
 
int textSize
 font size, [1, 255], default 55.
 
const char * textColor
 font color ARGB, default #FF000000.
 
int borderSize
 border Size, [0, 255], A value of 0 disables borders, default 1.
 
const char * borderColor
 border color ARGB, default #FFFFFFFF.

 
OSD_DISPLAY_TYPE animationEffect
 animation effect of running lantern, default OSD_DISPALY_ROLL.
 
int displayDuration
 The duration of a single running lantern, in seconds. default 5 seconds.
 
int displayInterval
 The time interval between two running lights, in seconds. default 1 seconds.
 
int fadeDuration
 The duration of the gradient animation of the lantern text from display to disappearance, in seconds. default 3 seconds.
 

Detailed Description

OSD info setting.

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

Constructor & Destructor Documentation

◆ PLVOsdConfigInfo()

PLVOsdConfigInfo ( )
inline

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

Field Documentation

◆ animationEffect

OSD_DISPLAY_TYPE animationEffect

animation effect of running lantern, default OSD_DISPALY_ROLL.

See also
OSD_DISPLAY_TYPE.

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

◆ borderColor

const char* borderColor

border color ARGB, default #FFFFFFFF.

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

◆ borderSize

int borderSize

border Size, [0, 255], A value of 0 disables borders, default 1.

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

◆ displayDuration

int displayDuration

The duration of a single running lantern, in seconds. default 5 seconds.

Note
OSD_DISPALY_ROLL:roll indicates the duration of a single roll (from the beginning of roll in to full roll out).
OSD_DISPALY_BLINK:blink indicates the time required from the beginning of display to the complete disappearance.

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

◆ displayInterval

int displayInterval

The time interval between two running lights, in seconds. default 1 seconds.

Note
OSD_DISPALY_ROLL:roll indicates the time interval between two scrolls (from full roll out to next roll in).
OSD_DISPALY_BLINK:blink indicates the interval between two flashes (the interval from complete disappearance to next appearance).

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

◆ fadeDuration

int fadeDuration

The duration of the gradient animation of the lantern text from display to disappearance, in seconds. default 3 seconds.

Note
When the value is 0, the gradient effect is not displayed.
When fadeduration < displayduration, the gradient effect is cycled.
It works for roll and blink.
If fade takes effect, the border does not work. border is mutually exclusive.

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

◆ text

const char* text

osd text display, must set. use utf8.

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

◆ textColor

const char* textColor

font color ARGB, default #FF000000.

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

◆ textSize

int textSize

font size, [1, 255], default 55.

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


The documentation for this struct was generated from the following file: