lv_ffmpeg.h
API reference for lv_ffmpeg.h
See Also: Private HeaderThis header has a companion private implementation with internal data structures.lv_ffmpeg_private.h
Summary
Functions
public/widgets/lv_ffmpeg.h:75function
lv_ffmpeg_player_set_src
Set the path of the file to be played.
lv_result_t lv_ffmpeg_player_set_src(lv_obj_t *obj, const char *path)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a ffmpeg_player object |
path | const char * | video file path |
Returns: lv_result_t — LV_RESULT_OK: no error; LV_RESULT_INVALID: can't get the info.
public/widgets/lv_ffmpeg.h:82function
lv_ffmpeg_player_set_cmd
Set command control video player
void lv_ffmpeg_player_set_cmd(lv_obj_t *obj, lv_ffmpeg_player_cmd_t cmd)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a ffmpeg_player object |
cmd | lv_ffmpeg_player_cmd_t | control commands |
public/widgets/lv_ffmpeg.h:89function
lv_ffmpeg_player_set_auto_restart
Set the video to automatically replay
void lv_ffmpeg_player_set_auto_restart(lv_obj_t *obj, bool en)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a ffmpeg_player object |
en | bool | true: enable the auto restart |
public/widgets/lv_ffmpeg.h:96function
lv_ffmpeg_player_set_decoder
Set the video decoder
void lv_ffmpeg_player_set_decoder(lv_obj_t *obj, const char *decoder_name)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a ffmpeg_player object |
decoder_name | const char * | decoder name. May be NULL. When NULL the decoder is auto-selected. |
public/widgets/lv_ffmpeg.h:59function
lv_ffmpeg_get_frame_num
Get the number of frames contained in the file
int lv_ffmpeg_get_frame_num(const char *path)| Name | Type | Description |
|---|---|---|
path | const char * | image or video file name |
Returns: int — Number of frames, less than 0 means failed
public/widgets/lv_ffmpeg.h:47function
lv_ffmpeg_init
Register FFMPEG image decoder
void lv_ffmpeg_init(void)public/widgets/lv_ffmpeg.h:52function
lv_ffmpeg_deinit
De-initialize FFMPEG image decoder
void lv_ffmpeg_deinit(void)public/widgets/lv_ffmpeg.h:67function
lv_ffmpeg_player_create
Create ffmpeg_player object
lv_obj_t * lv_ffmpeg_player_create(lv_obj_t *parent)| Name | Type | Description |
|---|---|---|
parent | lv_obj_t * | pointer to a parent widget May be NULL.. When NULL, the widget is created as a screen on the default display. |
Returns: lv_obj_t * — pointer to the created ffmpeg_player
Enums
lv_ffmpeg_player_cmd_t
| Name |
|---|
LV_FFMPEG_PLAYER_CMD_START |
LV_FFMPEG_PLAYER_CMD_STOP |
LV_FFMPEG_PLAYER_CMD_PAUSE |
LV_FFMPEG_PLAYER_CMD_RESUME |
LV_FFMPEG_PLAYER_CMD_LAST |
Used by 1 function
lv_ffmpeg_player_set_cmd— paramcmd
Variables
public/widgets/lv_ffmpeg.h:30variable
lv_ffmpeg_player_class
const lv_obj_class_t lv_ffmpeg_player_classDependencies
Last updated on