struct RBShell

struct RBShell;

struct RBShellClass

struct RBShellClass {
        GObjectClass parent_class;

	/* signals */
	gboolean (*visibility_changing) (RBShell *shell, gboolean initial, gboolean visible);
	void	 (*visibility_changed) (RBShell *shell, gboolean visible);
	void	 (*create_song_info) (RBShell *shell, RBSongInfo *song_info, gboolean multi);
	void	 (*removable_media_scan_finished) (RBShell *shell);
	void     (*database_load_complete) (RBShell *shell);
};

rb_shell_new ()

RBShell *           rb_shell_new                        (gboolean no_registration,
                                                         gboolean no_update,
                                                         gboolean dry_run,
                                                         gboolean autostarted,
                                                         gboolean disable_plugins,
                                                         char *rhythmdb,
                                                         char *playlists);

Creates the Rhythmbox shell. This is effectively a singleton, so it doesn't make sense to call this from anywhere other than main.c.

rb_shell_present ()

gboolean            rb_shell_present                    (RBShell *shell,
                                                         guint32 timestamp,
                                                         GError **error);

Attempts to display the main window to the user. See gtk_window_present for details.

rb_shell_guess_source_for_uri ()

RBSource *          rb_shell_guess_source_for_uri       (RBShell *shell,
                                                         const char *uri);

Attempts to locate the source that should handle the specified URI. This iterates through all sources, calling rb_source_want_uri, returning the source that returns the highest value.

rb_shell_add_uri ()

gboolean            rb_shell_add_uri                    (RBShell *shell,
                                                         const char *uri,
                                                         const char *title,
                                                         const char *genre,
                                                         GError **error);

Adds the specified URI to the Rhythmbox database. Whether the title and genre specified are actually used is up to the source that handles the URI

rb_shell_load_uri ()

gboolean            rb_shell_load_uri                   (RBShell *shell,
                                                         const char *uri,
                                                         gboolean play,
                                                         GError **error);

Loads a URI representing a single song, a directory, a playlist, or an internet radio station, and optionally starts playing it.

For playlists containing only stream URLs, we either add the playlist itself (if it's remote) or each URL from it (if it's local). The main reason for this is so clicking on stream playlist links in web browsers works properly - the playlist file will be downloaded to /tmp/, and we can't add that to the database, so we need to add the stream URLs instead.

rb_shell_get_player ()

GObject *           rb_shell_get_player                 (RBShell *shell);

Returns the RBShellPlayer object

rb_shell_get_player_path ()

const char *        rb_shell_get_player_path            (RBShell *shell);

Returns the DBus object path for the RBShellPlayer

rb_shell_get_playlist_manager ()

GObject *           rb_shell_get_playlist_manager       (RBShell *shell);

Returns the RBPlaylistManager object

rb_shell_get_playlist_manager_path ()

const char *        rb_shell_get_playlist_manager_path  (RBShell *shell);

Returns the DBus path for the RBPlaylistManager object

rb_shell_get_ui_manager ()

GObject *           rb_shell_get_ui_manager             (RBShell *shell);

Returns the main GtkUIManager object

rb_shell_toggle_visibility ()

void                rb_shell_toggle_visibility          (RBShell *shell);

Toggles the visibility of the main Rhythmbox window.

rb_shell_get_song_properties ()

gboolean            rb_shell_get_song_properties        (RBShell *shell,
                                                         const char *uri,
                                                         GHashTable **properties,
                                                         GError **error);

Gathers and returns all metadata (including extra metadata such as album art URIs and lyrics) for the specified URI.

rb_shell_set_song_property ()

gboolean            rb_shell_set_song_property          (RBShell *shell,
                                                         const char *uri,
                                                         const char *propname,
                                                         const GValue *value,
                                                         GError **error);

Attempts to set a property of a database entry identified by its URI. If the URI identifies a file and the property is one associated with a file metadata tag, the new value will be written to the file.

rb_shell_add_to_queue ()

gboolean            rb_shell_add_to_queue               (RBShell *shell,
                                                         const gchar *uri,
                                                         GError **error);

Adds the specified URI to the play queue. This only works if URI is already in the database.

rb_shell_remove_from_queue ()

gboolean            rb_shell_remove_from_queue          (RBShell *shell,
                                                         const gchar *uri,
                                                         GError **error);

Removes the specified URI from the play queue. If the URI is not in the play queue, nothing happens.

rb_shell_clear_queue ()

gboolean            rb_shell_clear_queue                (RBShell *shell,
                                                         GError **error);

Removes all entries from the play queue.

rb_shell_quit ()

gboolean            rb_shell_quit                       (RBShell *shell,
                                                         GError **error);

Begins the process of shutting down Rhythmbox. This function will return. The error parameter and return value only exist because this function is part of the DBus interface.

rb_shell_do_notify ()

gboolean            rb_shell_do_notify                  (RBShell *shell,
                                                         gboolean requested,
                                                         GError **error);

Displays a notification of the current playing track.

rb_shell_register_entry_type_for_source ()

void                rb_shell_register_entry_type_for_source
                                                        (RBShell *shell,
                                                         RBSource *source,
                                                         RhythmDBEntryType *type);

Registers a source as the owner of entries of the specified type. The main effect of this is that calling rb_shell_get_source_by_entry_type with the same entry type will return the source. A source should only be registered as the owner of a single entry type.

rb_shell_get_source_by_entry_type ()

RBSource *          rb_shell_get_source_by_entry_type   (RBShell *shell,
                                                         RhythmDBEntryType *type);

Looks up and returns the source that owns entries of the specified type.

rb_shell_get_party_mode ()

gboolean            rb_shell_get_party_mode             (RBShell *shell);

Returns TRUE if the shell is in party mode

rb_shell_add_widget ()

void                rb_shell_add_widget                 (RBShell *shell,
                                                         GtkWidget *widget,
                                                         RBShellUILocation location,
                                                         gboolean expand,
                                                         gboolean fill);

Adds a widget to the main Rhythmbox window. See gtk_box_pack_start for details on how the expand and fill parameters work.

rb_shell_remove_widget ()

void                rb_shell_remove_widget              (RBShell *shell,
                                                         GtkWidget *widget,
                                                         RBShellUILocation location);

Removes a widget added with rb_shell_add_widget from the main window.

The "autostarted" property

  "autostarted"              gboolean              : Read / Write / Construct Only

Whether Rhythmbox was automatically started by the session manager

Default value: FALSE

The "clipboard" property

  "clipboard"                RBShellClipboard*     : Read

The RBShellClipboard instance

The "db" property

  "db"                       RhythmDB*             : Read

The RhythmDB instance

The "disable-plugins" property

  "disable-plugins"          gboolean              : Read / Write / Construct Only

If TRUE, disable plugins

Default value: FALSE

The "display-page-model" property

  "display-page-model"       RBDisplayPageModel*   : Read

The model underlying the display page tree

The "display-page-tree" property

  "display-page-tree"        RBDisplayPageTree*    : Read

The RBDisplayPageTree instance

The "dry-run" property

  "dry-run"                  gboolean              : Read / Write / Construct Only

If TRUE, don't write back file metadata changes.

Default value: FALSE

The "library-source" property

  "library-source"           RBLibrarySource*      : Read

The library source

The "no-registration" property

  "no-registration"          gboolean              : Read / Write / Construct Only

If TRUE, disable single-instance features.

Default value: FALSE

The "no-update" property

  "no-update"                gboolean              : Read / Write / Construct Only

If TRUE, don't update the database.

Default value: FALSE

The "playlist-manager" property

  "playlist-manager"         RBPlaylistManager*    : Read

The RBPlaylistManager instance

The "playlists-file" property

  "playlists-file"           gchar*                : Read / Write / Construct Only

The path to the playlist file

Default value: "playlists.xml"

The "prefs" property

  "prefs"                    RBShellPreferences*   : Read

The RBShellPreferences instance

The "queue-source" property

  "queue-source"             RBPlayQueueSource*    : Read

The play queue source

The "removable-media-manager" property

  "removable-media-manager"  RBRemovableMediaManager*  : Read

The RBRemovableMediaManager instance

The "rhythmdb-file" property

  "rhythmdb-file"            gchar*                : Read / Write / Construct Only

The path to the rhythmdb file

Default value: "rhythmdb.xml"

The "selected-page" property

  "selected-page"            RBDisplayPage*        : Read

The currently selected display page

The "shell-player" property

  "shell-player"             RBShellPlayer*        : Read

The RBShellPlayer instance

The "source-header" property

  "source-header"            RBSourceHeader*       : Read

The RBSourceHeader instance

The "track-transfer-queue" property

  "track-transfer-queue"     RBTrackTransferQueue*  : Read

The RBTrackTransferQueue instance

The "ui-manager" property

  "ui-manager"               GtkUIManager*         : Read

The GtkUIManager instance

The "visibility" property

  "visibility"               gboolean              : Read / Write

Whether the main window is currently visible.

Default value: TRUE

The "window" property

  "window"                   GtkWindow*            : Read

The main Rhythmbox window.

The "create-song-info" signal

void                user_function                      (RBShell    *shell,
                                                        RBSongInfo *song_info,
                                                        gboolean    multi,
                                                        gpointer    user_data)      : Run Last

Emitted when creating a new RBSongInfo window. Signal handlers can add pages to the song info window notebook to display additional information.

The "database-load-complete" signal

void                user_function                      (RBShell *shell,
                                                        gpointer user_data)      : Run Last

Emitted when the database has been loaded. This is intended to allow DBus clients that start a new instance of the application to wait until a reasonable amount of state has been loaded before making further requests.

The "notify-custom" signal

void                user_function                      (RBShell *shell,
                                                        guint    timeout,
                                                        gchar   *primary,
                                                        gchar   *secondary,
                                                        gchar   *image_uri,
                                                        gboolean requested,
                                                        gpointer user_data)      : Run Last

Emitted when a custom notification should be displayed to the user.

The "notify-playing-entry" signal

void                user_function                      (RBShell *shell,
                                                        gboolean arg1,
                                                        gpointer user_data)      : Run Last

Emitted when a notification should be displayed showing the current playing entry.

The "removable-media-scan-finished" signal

void                user_function                      (RBShell *shell,
                                                        gpointer user_data)      : Run Last

Emitted when the initial scan for removable media devices is complete. This is intended to allow plugins to request a device scan only if the scan on startup has already been done, but it isn't very useful for that. See "scanned" for a better approach to this problem.

The "visibility-changed" signal

void                user_function                      (RBShell *shell,
                                                        gboolean visibile,
                                                        gpointer user_data)      : Run Last

Emitted after the visibility of the main Rhythmbox window has changed.

The "visibility-changing" signal

gboolean            user_function                      (RBShell *shell,
                                                        gboolean initial,
                                                        gboolean visible,
                                                        gpointer user_data)      : Run Last

Emitted before the visibility of the main window changes. The return value overrides the visibility setting. If multiple signal handlers are attached, the last one wins.