rb_playlist_manager_new ()

RBPlaylistManager *
rb_playlist_manager_new (RBShell *shell,
                         const char *playlists_file);

Creates the RBPlaylistManager instance

rb_playlist_manager_shutdown ()

void
rb_playlist_manager_shutdown (RBPlaylistManager *mgr);

Shuts down the playlist manager, making sure any outstanding playlist save operation finishes.

rb_playlist_manager_parse_file ()

gboolean
rb_playlist_manager_parse_file (RBPlaylistManager *mgr,
                                const char *uri,
                                GError **error);

Parses a playlist file, adding entries to the database and to a new static playlist. If the playlist file includes a title, the static playlist created will have the same title.

rb_playlist_manager_load_playlists ()

void
rb_playlist_manager_load_playlists (RBPlaylistManager *mgr);

Loads the user's playlists, or if the playlist file does not exists, reads the default playlist file. Should be called only once on startup.

rb_playlist_manager_save_playlists ()

gboolean
rb_playlist_manager_save_playlists (RBPlaylistManager *mgr,
                                    gboolean force);

Saves the user's playlists. If the force flag is TRUE, the playlists will always be saved. Otherwise, the playlists will only be saved if a playlist has been created, modified, or deleted since the last time the playlists were saved, and no save operation is currently taking place.

rb_playlist_manager_new_playlist ()

RBSource *
rb_playlist_manager_new_playlist (RBPlaylistManager *mgr,
                                  const char *suggested_name,
                                  gboolean automatic);

Creates a new playlist and adds it to the source list.

rb_playlist_manager_new_playlist_from_selection_data ()

RBSource *
rb_playlist_manager_new_playlist_from_selection_data
                               (RBPlaylistManager *mgr,
                                GtkSelectionData *data);

Creates a new playlist based on selection data from gtk. Used to implement playlist creation through drag and drop to the source list.

rb_playlist_manager_get_playlists ()

GList *
rb_playlist_manager_get_playlists (RBPlaylistManager *mgr);

Returns a GList containing all local playlist source objects.

rb_playlist_manager_get_playlist_names ()

gboolean
rb_playlist_manager_get_playlist_names
                               (RBPlaylistManager *mgr,
                                gchar ***playlists,
                                GError **error);

Allocates and returns an array containing the names of all local playlists. This is part of the playlist manager dbus interface.

rb_playlist_manager_create_static_playlist ()

gboolean
rb_playlist_manager_create_static_playlist
                               (RBPlaylistManager *mgr,
                                const gchar *name,
                                GError **error);

Creates a new static playlist source with the given name. Will fail if a playlist with that name already exists. This is part of the playlist manager dbus interface.

rb_playlist_manager_delete_playlist ()

gboolean
rb_playlist_manager_delete_playlist (RBPlaylistManager *mgr,
                                     const gchar *name,
                                     GError **error);

Deletes the specified playlist. Will fail if no playlist with that name exists. This is part of the playlist manager dbus interface.

rb_playlist_manager_add_to_playlist ()

gboolean
rb_playlist_manager_add_to_playlist (RBPlaylistManager *mgr,
                                     const gchar *name,
                                     const gchar *uri,
                                     GError **error);

Adds an entry to the specified playlist. Fails if no playlist with that name exists. This is part of the playlist manager dbus interface.

rb_playlist_manager_remove_from_playlist ()

gboolean
rb_playlist_manager_remove_from_playlist
                               (RBPlaylistManager *mgr,
                                const gchar *name,
                                const gchar *uri,
                                GError **error);

Removes an entry from the specified playlist. Fails if no playlist with that name exists. This is part of the playlist manager dbus interface.

rb_playlist_manager_export_playlist ()

gboolean
rb_playlist_manager_export_playlist (RBPlaylistManager *mgr,
                                     const gchar *name,
                                     const gchar *uri,
                                     gboolean m3u_format,
                                     GError **error);

Saves the specified playlist to a file in either M3U or PLS format. This is part of the playlist manager dbus interface.

struct RBPlaylistManager

struct RBPlaylistManager;

struct RBPlaylistManagerClass

struct RBPlaylistManagerClass {
	GObjectClass parent_class;

	/* signals */
	void (*playlist_added) (RBPlaylistManager *manager, RBSource *source);
	void (*playlist_created) (RBPlaylistManager *manager, RBSource *source);
	void (*load_start) (RBPlaylistManager *manager);
	void (*load_finish) (RBPlaylistManager *manager);
};

enum RBPlaylistManagerError

The “playlists-file” property

  “playlists-file”           gchar *

playlists file.

Flags: Read / Write

Default value: NULL

The “shell” property

  “shell”                    RBShell *

RBShell object.

Flags: Read / Write

The “source” property

  “source”                   RBSource *

RBSource object.

Flags: Read / Write

The “load-finish” signal

void
user_function (RBPlaylistManager *manager,
               gpointer           user_data)

Emitted when the playlist manager finishes loading the user's playlist file.

Flags: Run Last

The “load-start” signal

void
user_function (RBPlaylistManager *manager,
               gpointer           user_data)

Emitted when the playlist manager starts loading the user's playlist file.

Flags: Run Last

The “playlist-added” signal

void
user_function (RBPlaylistManager *manager,
               GObject           *source,
               gpointer           user_data)

Emitted when a playlist is added, including when being loaded from the user's playlist file.

Flags: Run Last

The “playlist-created” signal

void
user_function (RBPlaylistManager *manager,
               GObject           *source,
               gpointer           user_data)

Emitted when a new playlist is created.

Flags: Run Last