sp_playlist_callbacks Struct Reference
[Playlist subsystem]

#include <api.h>


Data Fields

void(* tracks_added )(sp_playlist *pl, const sp_track **tracks, int num_tracks, int position, void *userdata)
void(* tracks_removed )(sp_playlist *pl, const int *tracks, int num_tracks, void *userdata)
void(* tracks_moved )(sp_playlist *pl, const int *tracks, int num_tracks, int new_position, void *userdata)
void(* playlist_renamed )(sp_playlist *pl, void *userdata)
void(* playlist_state_changed )(sp_playlist *pl, void *userdata)
void(* playlist_update_in_progress )(sp_playlist *pl, bool done, void *userdata)


Detailed Description

Playlist callbacks

Used to get notifications when playlists are updated. If some callbacks should not be of interest, set them to NULL.

Examples:

jukebox.c.


Field Documentation

void( * sp_playlist_callbacks::tracks_added)(sp_playlist *pl, const sp_track **tracks, int num_tracks, int position, void *userdata)

Called when one or more tracks have been added to a playlist

Parameters:
[in] pl Playlist object
[in] tracks Array of pointers to track objects
[in] num_tracks Number of entries in tracks
[in] position Position in the playlist for the first track.
[in] userdata Userdata passed to sp_playlist_add_callbacks()

void( * sp_playlist_callbacks::tracks_removed)(sp_playlist *pl, const int *tracks, int num_tracks, void *userdata)

Called when one or more tracks have been removed from a playlist

Parameters:
[in] pl Playlist object
[in] tracks Array of positions representing the tracks that were removed
[in] num_tracks Number of entries in tracks
[in] userdata Userdata passed to sp_playlist_add_callbacks()

void( * sp_playlist_callbacks::tracks_moved)(sp_playlist *pl, const int *tracks, int num_tracks, int new_position, void *userdata)

Called when one or more tracks have been moved within a playlist

Parameters:
[in] pl Playlist object
[in] tracks Array of positions representing the tracks that were moved
[in] num_tracks Number of entries in tracks
[in] position New position in the playlist for the first track.
[in] userdata Userdata passed to sp_playlist_add_callbacks()

Called when a playlist has been renamed. sp_playlist_name() can be used to find out the new name

Parameters:
[in] pl Playlist object
[in] userdata Userdata passed to sp_playlist_add_callbacks()

Called when state changed for a playlist.

The state in this case are the flags like collaborative or pending.

Parameters:
[in] pl Playlist object
[in] userdata Userdata passed to sp_playlist_add_callbacks()

void( * sp_playlist_callbacks::playlist_update_in_progress)(sp_playlist *pl, bool done, void *userdata)

Called when a playlist is updating or is done updating

This is called before and after a series of changes are applied to the playlist. It allows e.g. the user interface to defer updating until the entire operation is complete.

Parameters:
[in] pl Playlist object
[in] done True iff the update is completed
[in] userdata Userdata passed to sp_playlist_add_callbacks()


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

Generated on Tue Apr 7 15:21:55 2009.
Copyright © 2006–2009 Spotify Ltd