|
|
|
Rhythmbox Development Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | Signals | ||||
enum RBShellActivationType; enum RBShellError; GQuark rb_shell_error_quark (void); enum RBShellUILocation; struct RBShell; struct RBShellClass; gboolean rb_shell_present (RBShell *shell,guint32 timestamp,GError **error); RBSource * rb_shell_guess_source_for_uri (RBShell *shell,const char *uri); gboolean rb_shell_add_uri (RBShell *shell,const char *uri,const char *title,const char *genre,GError **error); gboolean rb_shell_load_uri (RBShell *shell,const char *uri,gboolean play,GError **error); void rb_shell_toggle_visibility (RBShell *shell); gboolean rb_shell_get_song_properties (RBShell *shell,const char *uri,GHashTable **properties,GError **error); gboolean rb_shell_set_song_property (RBShell *shell,const char *uri,const char *propname,const GValue *value,GError **error); gboolean rb_shell_quit (RBShell *shell,GError **error); gboolean rb_shell_activate_source_by_uri (RBShell *shell,const char *source_uri,guint play,GError **error); gboolean rb_shell_activate_source (RBShell *shell,RBSource *source,guint play,GError **error); void rb_shell_notify_custom (RBShell *shell,guint timeout,const char *primary,const char *secondary,const char *image_uri,gboolean requested); gboolean rb_shell_do_notify (RBShell *shell,gboolean requested,GError **error); void rb_shell_register_entry_type_for_source (RBShell *shell,RBSource *source,RhythmDBEntryType *type); RBSource * rb_shell_get_source_by_entry_type (RBShell *shell,RhythmDBEntryType *type); gboolean rb_shell_get_party_mode (RBShell *shell); void rb_shell_append_display_page (RBShell *shell,RBDisplayPage *page,RBDisplayPage *parent); void rb_shell_add_widget (RBShell *shell,GtkWidget *widget,RBShellUILocation location,gboolean expand,gboolean fill); void rb_shell_remove_widget (RBShell *shell,GtkWidget *widget,RBShellUILocation location);
"accel-group" GtkAccelGroup* : Read "application" RBApplication* : Read / Write / Construct Only "autostarted" gboolean : Read / Write / Construct Only "clipboard" RBShellClipboard* : Read "db" RhythmDB* : Read "disable-plugins" gboolean : Read / Write / Construct Only "display-page-model" RBDisplayPageModel* : Read "display-page-tree" RBDisplayPageTree* : Read "dry-run" gboolean : Read / Write / Construct Only "library-source" RBLibrarySource* : Read "no-registration" gboolean : Read / Write / Construct Only "no-update" gboolean : Read / Write / Construct Only "playlist-manager" RBPlaylistManager* : Read "playlists-file" gchar* : Read / Write / Construct Only "prefs" RBShellPreferences* : Read "queue-source" RBPlayQueueSource* : Read "removable-media-manager" RBRemovableMediaManager* : Read "rhythmdb-file" gchar* : Read / Write / Construct Only "selected-page" RBDisplayPage* : Read "shell-player" RBShellPlayer* : Read "track-transfer-queue" RBTrackTransferQueue* : Read "visibility" gboolean : Read / Write "window" GtkWindow* : Read
"create-song-info" :Run Last"notify-custom" :Run Last"notify-playing-entry" :Run Last"visibility-changed" :Run Last"visibility-changing" :Run Last
RBShell is the main application class in Rhythmbox. It creates and holds references to the other main objects (RBShellPlayer, RhythmDB, RBDisplayPageTree), constructs the main window UI, and provides the basic DBus interface.
typedef enum {
RB_SHELL_ACTIVATION_SELECT = 0,
RB_SHELL_ACTIVATION_PLAY = 1,
RB_SHELL_ACTIVATION_ALWAYS_PLAY = 2
} RBShellActivationType;
typedef enum {
RB_SHELL_ERROR_NO_SUCH_URI,
RB_SHELL_ERROR_NO_SUCH_PROPERTY,
RB_SHELL_ERROR_IMMUTABLE_PROPERTY,
RB_SHELL_ERROR_INVALID_PROPERTY_TYPE,
RB_SHELL_ERROR_NO_SOURCE_FOR_URI
} RBShellError;
GQuark rb_shell_error_quark (void);
Returns the GQuark used for RBShell errors
Returns : |
shell error GQuark |
typedef enum {
RB_SHELL_UI_LOCATION_SIDEBAR,
RB_SHELL_UI_LOCATION_RIGHT_SIDEBAR,
RB_SHELL_UI_LOCATION_MAIN_TOP,
RB_SHELL_UI_LOCATION_MAIN_BOTTOM
} RBShellUILocation;
struct RBShellClass {
GtkApplicationClass 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);
};
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.
|
the RBShell |
|
GTK timestamp to use (for focus-stealing prevention) |
|
not used |
Returns : |
not used. |
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.
|
the RBSource |
|
the URI to guess a source for |
Returns : |
the most appropriate RBSource for the uri. [transfer none] |
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
|
the RBShell |
|
the URI to add |
|
optional title value for the URI |
|
optional genre value for the URI |
|
returns error information |
Returns : |
TRUE if the URI was added successfully |
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.
|
the RBShell |
|
the URI to load |
|
if TRUE, start playing the URI (if possible) |
|
returns error information |
Returns : |
TRUE if the URI was added successfully |
void rb_shell_toggle_visibility (RBShell *shell);
Toggles the visibility of the main Rhythmbox window.
|
the RBShell |
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.
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.
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.
|
the RBShell |
|
not used |
Returns : |
not important |
gboolean rb_shell_activate_source_by_uri (RBShell *shell,const char *source_uri,guint play,GError **error);
Searches for a source matching source_uri and if found, selects it,
and depending on the value of play, may start playing from it.
Device-based sources will match the device node or mount point URI.
Other types of sources may have their own URI scheme or format.
This is part of the DBus interface.
gboolean rb_shell_activate_source (RBShell *shell,RBSource *source,guint play,GError **error);
void rb_shell_notify_custom (RBShell *shell,guint timeout,const char *primary,const char *secondary,const char *image_uri,gboolean requested);
gboolean rb_shell_do_notify (RBShell *shell,gboolean requested,GError **error);
Displays a notification of the current playing track.
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.
|
the RBShell |
|
the RBSource to register |
|
the RhythmDBEntryType to register for |
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.
|
the RBShell |
|
entry type for which to find a source |
Returns : |
source instance, if any. [transfer none] |
gboolean rb_shell_get_party_mode (RBShell *shell);
Returns TRUE if the shell is in party mode
void rb_shell_append_display_page (RBShell *shell,RBDisplayPage *page,RBDisplayPage *parent);
Adds a new display page to the shell.
|
the RBShell |
|
the new RBDisplayPage |
|
the parent page for the new page. [allow-none] |
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.
void rb_shell_remove_widget (RBShell *shell,GtkWidget *widget,RBShellUILocation location);
Removes a widget added with rb_shell_add_widget from the main window.
"accel-group" property"accel-group" GtkAccelGroup* : Read
A GtkAccelGroup instance to use for additional accelerator keys
"application" property"application" RBApplication* : Read / Write / Construct Only
RBApplication instance.
"autostarted" property"autostarted" gboolean : Read / Write / Construct Only
Whether Rhythmbox was automatically started by the session manager
Default value: FALSE
"disable-plugins" property"disable-plugins" gboolean : Read / Write / Construct Only
If TRUE, disable plugins
Default value: FALSE
"display-page-model" property"display-page-model" RBDisplayPageModel* : Read
The model underlying the display page tree
"display-page-tree" property"display-page-tree" RBDisplayPageTree* : Read
The RBDisplayPageTree instance
"dry-run" property"dry-run" gboolean : Read / Write / Construct Only
If TRUE, don't write back file metadata changes.
Default value: FALSE
"no-registration" property"no-registration" gboolean : Read / Write / Construct Only
If TRUE, disable single-instance features.
Default value: FALSE
"no-update" property"no-update" gboolean : Read / Write / Construct Only
If TRUE, don't update the database.
Default value: FALSE
"playlist-manager" property"playlist-manager" RBPlaylistManager* : Read
The RBPlaylistManager instance
"playlists-file" property"playlists-file" gchar* : Read / Write / Construct Only
The path to the playlist file
Default value: "playlists.xml"
"removable-media-manager" property"removable-media-manager" RBRemovableMediaManager* : Read
The RBRemovableMediaManager instance
"rhythmdb-file" property"rhythmdb-file" gchar* : Read / Write / Construct Only
The path to the rhythmdb file
Default value: "rhythmdb.xml"
"selected-page" property"selected-page" RBDisplayPage* : Read
The currently selected display page
"track-transfer-queue" property"track-transfer-queue" RBTrackTransferQueue* : Read
The RBTrackTransferQueue instance
"visibility" property"visibility" gboolean : Read / Write
Whether the main window is currently visible.
Default value: TRUE
"create-song-info" signalvoid 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 RBShell |
|
the new RBSongInfo window |
|
if TRUE, the song info window is for multiple entries |
|
user data set when the signal handler was connected. |
"notify-custom" signalvoid 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 RBShell |
|
length of time (in seconds) to display the notification |
|
main notification text |
|
secondary notification text |
|
URI for an image to include in the notification (optional) |
|
if TRUE, the notification was triggered by an explicit user action |
|
user data set when the signal handler was connected. |
"notify-playing-entry" signalvoid user_function (RBShell *shell,
gboolean arg1,
gpointer user_data) : Run Last
Emitted when a notification should be displayed showing the current playing entry.
|
the RBShell |
|
user data set when the signal handler was connected. |
"visibility-changed" signalvoid user_function (RBShell *shell,
gboolean visibile,
gpointer user_data) : Run Last
Emitted after the visibility of the main Rhythmbox window has changed.
|
the RBShell |
|
new visibility |
|
user data set when the signal handler was connected. |
"visibility-changing" signalgboolean 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.