PMPlib music API
[PMPlib APIs]

PMPlib Music API provides the interface to manage music files in a portable media device. More...

Data Structures

struct  tag_pmp_music_record_t
 Structure for a music record. More...
struct  pmp_playlist_t
 Structure for a playlist. More...
struct  tag_pmp_music_t
 Interface for organizing music files. More...

Typedefs

typedef tag_pmp_music_record_t pmp_music_record_t
 Synonym of struct tag_pmp_music_record_t.

Functions

PMPAPI void pmplib_record_init (pmp_music_record_t *record)
 Initialize pmp_music_record_t structure.
PMPAPI void pmplib_record_finish (pmp_music_record_t *record)
 Uninitialize pmp_music_record_t structure.
PMPAPI result_t pmplib_record_clone (pmp_music_record_t *dst, const pmp_music_record_t *src)
 Clone a pmp_music_record_t record.
PMPAPI void pmplib_records_finish (pmp_music_record_t *records, int num_records)
 Uninitialize an array of pmp_music_record_t records.
PMPAPI result_t pmplib_records_clone (pmp_music_record_t *dst, const pmp_music_record_t *src, int num_records)
 Clone a pmp_music_record_t array.
PMPAPI void pmplib_playlist_init (pmp_playlist_t *playlist)
 Initialize pmp_playlist_t structure.
PMPAPI void pmplib_playlist_finish (pmp_playlist_t *playlist)
 Uninitialize pmp_playlist_t structure.
PMPAPI void pmplib_playlist_clone (pmp_playlist_t *dst, const pmp_playlist_t *src)
 Clone a playlist.
PMPAPI void pmplib_playlists_finish (pmp_playlist_t *playlists, int num_playlists)
 Uninitialize an array of pmp_playlist_t playlists.
PMPAPI void pmplib_playlists_clone (pmp_playlist_t *dst, const pmp_playlist_t *src, int num_playlists)
 Clone a pmp_playlist_t array.

Detailed Description

PMPlib Music API provides the interface to manage music files in a portable media device.

Typedef Documentation

typedef struct tag_pmp_music_record_t pmp_music_record_t

Synonym of struct tag_pmp_music_record_t.

Definition at line 474 of file pmp.h.

Function Documentation

PMPAPI void pmplib_playlist_clone ( pmp_playlist_t *  dst,
const pmp_playlist_t *  src 
)

Clone a playlist.

This function copies the values in the src playlist to dst.

Parameters:
dst The pointer to the destination.
src The pointer to the source.

PMPAPI void pmplib_playlist_finish ( pmp_playlist_t *  playlist  ) 

Uninitialize pmp_playlist_t structure.

This function frees the memory blocks used by the playlist.

Parameters:
playlist The pointer to pmp_playlist_t instance.

PMPAPI void pmplib_playlist_init ( pmp_playlist_t *  playlist  ) 

Initialize pmp_playlist_t structure.

Parameters:
playlist The pointer to pmp_playlist_t instance.

PMPAPI void pmplib_playlists_clone ( pmp_playlist_t *  dst,
const pmp_playlist_t *  src,
int  num_playlists 
)

Clone a pmp_playlist_t array.

This function copies all playlists in the src array to dst.

Parameters:
dst The destination array.
src The source array.
num_playlists The number of elements in the source array.

PMPAPI void pmplib_playlists_finish ( pmp_playlist_t *  playlists,
int  num_playlists 
)

Uninitialize an array of pmp_playlist_t playlists.

This function frees the memory blocks used by each playlist in the array and the array itself.

Parameters:
playlists The pointer to pmp_playlist_t array.
num_playlists The number of elements in the array.

PMPAPI result_t pmplib_record_clone ( pmp_music_record_t *  dst,
const pmp_music_record_t *  src 
)

Clone a pmp_music_record_t record.

This function copies the values in the src record to dst.

Parameters:
dst The pointer to the destination.
src The pointer to the source.
Return values:
result_t The status code after this operation.

PMPAPI void pmplib_record_finish ( pmp_music_record_t *  record  ) 

Uninitialize pmp_music_record_t structure.

This function frees the memory blocks used by the record.

Parameters:
record The pointer to pmp_music_record_t instance.

PMPAPI void pmplib_record_init ( pmp_music_record_t *  record  ) 

Initialize pmp_music_record_t structure.

Parameters:
record The pointer to pmp_music_record_t instance.

PMPAPI result_t pmplib_records_clone ( pmp_music_record_t *  dst,
const pmp_music_record_t *  src,
int  num_records 
)

Clone a pmp_music_record_t array.

This function copies all records in the src array to dst.

Parameters:
dst The destination array.
src The source array.
num_records The number of elements in the source array.
Return values:
result_t The status code after this operation.

PMPAPI void pmplib_records_finish ( pmp_music_record_t *  records,
int  num_records 
)

Uninitialize an array of pmp_music_record_t records.

This function frees the memory blocks used by each record in the array and the array.

Parameters:
records The pointer to pmp_music_record_t array.
num_records The number of elements in the array.