Top | ![]() |
![]() |
![]() |
![]() |
char * | (*RhythmDBEntryTypeStringFunc) () |
gboolean | (*RhythmDBEntryTypeBooleanFunc) () |
void | (*RhythmDBEntryTypeSyncFunc) () |
const char * | rhythmdb_entry_type_get_name () |
char * | rhythmdb_entry_get_playback_uri () |
void | rhythmdb_entry_update_availability () |
void | rhythmdb_entry_created () |
void | rhythmdb_entry_pre_destroy () |
gboolean | rhythmdb_entry_can_sync_metadata () |
void | rhythmdb_entry_sync_metadata () |
#define | RHYTHMDB_ENTRY_TYPE_SONG |
#define | RHYTHMDB_ENTRY_TYPE_IMPORT_ERROR |
#define | RHYTHMDB_ENTRY_TYPE_IGNORE |
RhythmDBEntryType * | rhythmdb_get_song_entry_type () |
RhythmDBEntryType * | rhythmdb_get_error_entry_type () |
RhythmDBEntryType * | rhythmdb_get_ignore_entry_type () |
RhythmDBEntryCategory | category | Read / Write / Construct Only |
RhythmDB * | db | Read / Write / Construct Only |
gchar * | name | Read / Write / Construct Only |
gboolean | save-to-disk | Read / Write / Construct Only |
guint | type-data-size | Read / Write / Construct Only |
enum | RhythmDBEntryCategory |
enum | RhythmDBEntryAvailability |
struct | RhythmDBEntryType |
struct | RhythmDBEntryTypeClass |
This is the base class for database entry type classes, which provide some aspects of the behaviour of database entry types. There are different entry types for songs, radio streams, podcast feeds and episodes, and so on.
Plugins written in Python or Vala can create new entry types by subclassing and overriding any methods required. Plugins written in C can create a new instance of the RhythmDBEntryType base class and use its function pointer members rather than subclassing.
char * (*RhythmDBEntryTypeStringFunc) (RhythmDBEntryType *entry_type
,RhythmDBEntry *entry
);
gboolean (*RhythmDBEntryTypeBooleanFunc) (RhythmDBEntryType *entry_type
,RhythmDBEntry *entry
);
void (*RhythmDBEntryTypeSyncFunc) (RhythmDBEntryType *entry_type
,RhythmDBEntry *entry
,GSList *changes
,GError **error
);
const char *
rhythmdb_entry_type_get_name (RhythmDBEntryType *etype
);
Returns the name of the entry type
char *
rhythmdb_entry_get_playback_uri (RhythmDBEntry *entry
);
Returns an allocated string containing the playback URI for entry
,
or NULL if the entry cannot be played.
void rhythmdb_entry_update_availability (RhythmDBEntry *entry
,RhythmDBEntryAvailability avail
);
Updates entry
to reflect its new availability.
void
rhythmdb_entry_created (RhythmDBEntry *entry
);
Calls the entry type's post-creation method for entry
.
void
rhythmdb_entry_pre_destroy (RhythmDBEntry *entry
);
Calls the entry type's pre-deletion method for entry
.
gboolean
rhythmdb_entry_can_sync_metadata (RhythmDBEntry *entry
);
Calls the entry type's method to check if it can sync metadata for entry
.
Usually this is only true for entries backed by files, where tag-writing is
enabled, and the appropriate tag-writing facilities are available.
void rhythmdb_entry_sync_metadata (RhythmDBEntry *entry
,GSList *changes
,GError **error
);
Calls the entry type's method to sync metadata changes for entry
.
entry |
a RhythmDBEntry |
|
changes |
a list of RhythmDBEntryChange structures. |
[element-type RB.RhythmDBEntryChange] |
error |
returns error information |
#define RHYTHMDB_ENTRY_TYPE_IMPORT_ERROR (rhythmdb_get_error_entry_type ())
RhythmDBEntryType *
rhythmdb_get_song_entry_type (void
);
Returns the RhythmDBEntryType for normal songs.
RhythmDBEntryType *
rhythmdb_get_error_entry_type (void
);
Returns the RhythmDBEntryType for import errors
RhythmDBEntryType *
rhythmdb_get_ignore_entry_type (void
);
Returns the RhythmDBEntryType for ignored files
Categories used to group entry types. These are used in a few places to control handling of entries.
Various events that can result in changes to the entry's availability.
struct RhythmDBEntryTypeClass { GObjectClass parent_class; /* methods */ void (*entry_created) (RhythmDBEntryType *etype, RhythmDBEntry *entry); void (*destroy_entry) (RhythmDBEntryType *etype, RhythmDBEntry *entry); char * (*get_playback_uri) (RhythmDBEntryType *etype, RhythmDBEntry *entry); void (*update_availability) (RhythmDBEntryType *etype, RhythmDBEntry *entry, RhythmDBEntryAvailability avail); gboolean (*can_sync_metadata) (RhythmDBEntryType *etype, RhythmDBEntry *entry); void (*sync_metadata) (RhythmDBEntryType *etype, RhythmDBEntry *entry, GSList *changes, GError **error); };
“category”
property“category” RhythmDBEntryCategory
The RhythmDBEntryCategory that this entry type fits into.
Flags: Read / Write / Construct Only
Default value: RHYTHMDB_ENTRY_NORMAL
“name”
property“name” gchar *
Entry type name. This must be unique.
Flags: Read / Write / Construct Only
Default value: NULL
“save-to-disk”
property“save-to-disk” gboolean
If TRUE
, entries of this type should be written to the
on-disk database.
Flags: Read / Write / Construct Only
Default value: FALSE
“type-data-size”
property“type-data-size” guint
The size of the type-specific data structure to allocate for each entry of this type.
Flags: Read / Write / Construct Only
Default value: 0