ASF docs  3.1.3
Some important library documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
play_list.h File Reference
#include "fs_com.h"
#include "conf_explorer.h"
+ Include dependency graph for play_list.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

Options for "pl_add()"
#define PL_ADD_FILE   0x00
#define PL_ADD_DIR   0x01
#define PL_ADD_SUBDIR   0x02

List of supported file extensions

#define PL_FILE_EXT   "m3u,pls,smp"
enum  readline_opt_t { PL_MAIN_READLINE_OPT_CHECKLINE, PL_MAIN_READLINE_OPT_READSTRING, PL_MAIN_READLINE_OPT_GOTOPATH }
 This function reads and checks the next line. More...
bool pl_main_isopen (void)
 This function checks if a play list file is already opened.
bool pl_main_ismodify (void)
 This function checks if the play list file is modified.
bool pl_main_new (const FS_STRING sz_name, bool b_undo)
 This function creates a new empty play list file.
bool pl_main_open (bool b_undo)
 This function opens the current selected file in the current navigator.
bool pl_main_save (void)
 This function saves the play list file.
bool pl_main_close (void)
 This function closes the play list and selects this one in current navigator.
bool pl_main_modify (void)
 This function creates a copy of the play list in case of a restore action.
uint16_t pl_nav_getnbfile (void)
 Return the number of files in play list.
uint16_t pl_nav_getpos (void)
 Return the position in the play list.
bool pl_nav_eol (void)
 This function checks the end of the play list.
bool pl_nav_setpos (uint16_t u16_position)
 This function goes to a position in the play list.
bool pl_nav_readentry (uint16_t u16_position, FS_STRING *sz_pat, uint16_t *u16_size_line)
 This function read the playliost's entry at a specific position.
bool pl_main_readline (readline_opt_t opt, uint8_t id_nav, FS_STRING *sz_path, uint16_t *u16_size_line)
bool pl_sel_isvalid (void)
 This function tests the valid path in list.
bool pl_add (const FS_STRING sz_filterext, uint8_t u8_mode)
 This function adds files in play list.
bool pl_rem_sel_all (void)
 This function removes all files in the list.
bool pl_rem_sel (void)
 This function removes the selected file in the list.
bool pl_rem_dead (void)
 This function remove the dead file in the list.

Macro Definition Documentation

#define PL_ADD_DIR   0x01

Definition at line 57 of file play_list.h.

#define PL_ADD_FILE   0x00

Definition at line 56 of file play_list.h.

#define PL_ADD_SUBDIR   0x02

Definition at line 58 of file play_list.h.

#define PL_FILE_EXT   "m3u,pls,smp"

Definition at line 62 of file play_list.h.


Enumeration Type Documentation

Parameters:
b_gotopathPL_MAIN_READLINE_OPT_CHECKLINE to check the next line in the file.
PL_MAIN_READLINE_OPT_READSTRING to read the string in the text file.
PL_MAIN_READLINE_OPT_GOTOPATH to read, chack and goto the path.
id_navID navigator to update with the selected file (ignore if b_gotopatch == false)
sz_pathAddress of the string returned. It is used only if PL_MAIN_READLINE_OPT_READSTRING or PL_MAIN_READLINE_OPT_GOTOPATH options are specified.
u16_size_lineThe length of the path.
Returns:
true if a line with a correct path false line ignored or end of file
Enumerator:
PL_MAIN_READLINE_OPT_CHECKLINE 
PL_MAIN_READLINE_OPT_READSTRING 
PL_MAIN_READLINE_OPT_GOTOPATH 

Definition at line 167 of file play_list.h.


Function Documentation

bool pl_add ( const FS_STRING  sz_filterext,
uint8_t  u8_mode 
)
Parameters:
sz_filterextadd file only corresponding to the extension filter
u8_modePL_ADD_FILE, PL_ADD_DIR, PL_ADD_SUBDIR
Returns:
false in case of error, see global value "fs_g_status" for more detail
true otherwise
//! It is possible to select a file or all files in a directory
//! 
bool pl_main_close ( void  )
Returns:
false in case of error, see global value "fs_g_status" for more detail
true otherwise
bool pl_main_ismodify ( void  )
Returns:
true the play list file is modified
bool pl_main_isopen ( void  )
Returns:
true a play list file is opened
bool pl_main_modify ( void  )
Returns:
false in case of error, see global value "fs_g_status" for more detail
true otherwise
bool pl_main_new ( const FS_STRING  sz_name,
bool  b_undo 
)
Parameters:
sz_namecontains the file name (ASCII or UNICODE )
b_undotrue to authorize the undo feature
Returns:
false in case of error, see global value "fs_g_status" for more detail
true otherwise
bool pl_main_open ( bool  b_undo)
Parameters:
b_undotrue to authorize the undo feature
Returns:
false in case of error, see global value "fs_g_status" for more detail
true otherwise
bool pl_main_readline ( readline_opt_t  opt,
uint8_t  id_nav,
FS_STRING sz_path,
uint16_t *  u16_size_line 
)
bool pl_main_save ( void  )
Returns:
false in case of error, see global value "fs_g_status" for more detail
true otherwise
bool pl_nav_eol ( void  )
Returns:
true if the position is the last file of the play list
uint16_t pl_nav_getnbfile ( void  )
Returns:
number of files in play list
uint16_t pl_nav_getpos ( void  )
Returns:
position in the play list
bool pl_nav_readentry ( uint16_t  u16_position,
FS_STRING sz_pat,
uint16_t *  u16_size_line 
)
Parameters:
u16_positionPosition in play list.
sz_pathThe address of the string where is stored the information.
u16_size_lineThe length of the path.
bool pl_nav_setpos ( uint16_t  u16_position)
Parameters:
u16_positionposition in play list to go
bool pl_rem_dead ( void  )
Returns:
false in case of error, see global value "fs_g_status" for more detail
true otherwise
bool pl_rem_sel ( void  )
Returns:
false in case of error, see global value "fs_g_status" for more detail
true otherwise
bool pl_rem_sel_all ( void  )
Returns:
false in case of error, see global value "fs_g_status" for more detail
true otherwise
bool pl_sel_isvalid ( void  )
Returns:
false = path is not valid in list - DEAD