diff options
Diffstat (limited to 'docs/reference/tmpl')
| -rw-r--r-- | docs/reference/tmpl/Internal.sgml | 19 | ||||
| -rw-r--r-- | docs/reference/tmpl/artwork.sgml | 160 | ||||
| -rw-r--r-- | docs/reference/tmpl/device.sgml | 129 | ||||
| -rw-r--r-- | docs/reference/tmpl/itunesdb-copying.sgml | 74 | ||||
| -rw-r--r-- | docs/reference/tmpl/itunesdb-db.sgml | 133 | ||||
| -rw-r--r-- | docs/reference/tmpl/itunesdb-lowlevel.sgml | 164 | ||||
| -rw-r--r-- | docs/reference/tmpl/itunesdb-time.sgml | 45 | ||||
| -rw-r--r-- | docs/reference/tmpl/libgpod-unused.sgml | 126 | ||||
| -rw-r--r-- | docs/reference/tmpl/playlists.sgml | 287 | ||||
| -rw-r--r-- | docs/reference/tmpl/smart-playlists.sgml | 269 | ||||
| -rw-r--r-- | docs/reference/tmpl/track.sgml | 232 |
11 files changed, 1638 insertions, 0 deletions
diff --git a/docs/reference/tmpl/Internal.sgml b/docs/reference/tmpl/Internal.sgml new file mode 100644 index 0000000..5bae25a --- /dev/null +++ b/docs/reference/tmpl/Internal.sgml @@ -0,0 +1,19 @@ +<!-- ##### SECTION Title ##### --> +Internal + +<!-- ##### SECTION Short_Description ##### --> +Symbols to be hidden ;) + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + diff --git a/docs/reference/tmpl/artwork.sgml b/docs/reference/tmpl/artwork.sgml new file mode 100644 index 0000000..a7ce2a5 --- /dev/null +++ b/docs/reference/tmpl/artwork.sgml @@ -0,0 +1,160 @@ +<!-- ##### SECTION Title ##### --> +Artwork + +<!-- ##### SECTION Short_Description ##### --> +Data structure to store iPod artwork (cover and photos) + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT Itdb_Artwork ##### --> +<para> + +</para> + +@thumbnails: +@artwork_size: +@id: + +<!-- ##### STRUCT Itdb_Thumb ##### --> +<para> + +</para> + +@type: +@filename: +@offset: +@size: +@width: +@height: + +<!-- ##### ENUM ItdbThumbType ##### --> +<para> + +</para> + +@ITDB_THUMB_COVER_SMALL: +@ITDB_THUMB_COVER_LARGE: +@ITDB_THUMB_PHOTO_SMALL: +@ITDB_THUMB_PHOTO_LARGE: +@ITDB_THUMB_PHOTO_FULL_SCREEN: +@ITDB_THUMB_PHOTO_TV_SCREEN: + +<!-- ##### FUNCTION itdb_artwork_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION itdb_artwork_duplicate ##### --> +<para> + +</para> + +@artwork: +@Returns: + + +<!-- ##### FUNCTION itdb_artwork_free ##### --> +<para> + +</para> + +@artwork: + + +<!-- ##### FUNCTION itdb_artwork_add_thumbnail ##### --> +<para> + +</para> + +@artwork: +@type: +@filename: +@Returns: + + +<!-- ##### FUNCTION itdb_artwork_remove_thumbnail ##### --> +<para> + +</para> + +@artwork: +@thumb: + + +<!-- ##### FUNCTION itdb_artwork_remove_thumbnails ##### --> +<para> + +</para> + +@artwork: + + +<!-- ##### FUNCTION itdb_artwork_get_thumb_by_type ##### --> +<para> + +</para> + +@artwork: +@type: +@Returns: + + +<!-- ##### FUNCTION itdb_thumb_get_gdk_pixbuf ##### --> +<para> + +</para> + +@device: +@thumb: +@Returns: + + +<!-- ##### FUNCTION itdb_thumb_duplicate ##### --> +<para> + +</para> + +@thumb: +@Returns: + + +<!-- ##### FUNCTION itdb_thumb_free ##### --> +<para> + +</para> + +@thumb: + + +<!-- ##### FUNCTION itdb_thumb_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION itdb_thumb_get_filename ##### --> +<para> + +</para> + +@device: +@thumb: +@Returns: + + diff --git a/docs/reference/tmpl/device.sgml b/docs/reference/tmpl/device.sgml new file mode 100644 index 0000000..07090ed --- /dev/null +++ b/docs/reference/tmpl/device.sgml @@ -0,0 +1,129 @@ +<!-- ##### SECTION Title ##### --> +Device + +<!-- ##### SECTION Short_Description ##### --> +Data structure holding information about the iPod (model, mount point, ...) + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT Itdb_Device ##### --> +<para> + +</para> + +@mountpoint: +@musicdirs: +@byte_order: +@endianess_reversed: + +<!-- ##### FUNCTION itdb_device_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION itdb_device_free ##### --> +<para> + +</para> + +@device: + + +<!-- ##### FUNCTION itdb_device_set_mountpoint ##### --> +<para> + +</para> + +@device: +@mp: + + +<!-- ##### FUNCTION itdb_device_read_sysinfo ##### --> +<para> + +</para> + +@device: +@Returns: + + +<!-- ##### FUNCTION itdb_device_get_sysinfo ##### --> +<para> + +</para> + +@device: +@field: +@Returns: + + +<!-- ##### STRUCT Itdb_IpodModel ##### --> +<para> + +</para> + +@model_number: +@capacity: +@model_type: +@generation: + +<!-- ##### STRUCT Itdb_ArtworkFormat ##### --> +<para> + +</para> + +@type: +@width: +@height: +@correlation_id: + +<!-- ##### ENUM Itdb_Generation ##### --> +<para> + +</para> + +@UNKNOWN_GENERATION: +@FIRST_GENERATION: +@SECOND_GENERATION: +@THIRD_GENERATION: +@FOURTH_GENERATION: +@FIFTH_GENERATION: +@MOBILE_GENERATION: + +<!-- ##### ENUM Itdb_ModelType ##### --> +<para> + +</para> + +@MODEL_TYPE_INVALID: +@MODEL_TYPE_UNKNOWN: +@MODEL_TYPE_COLOR: +@MODEL_TYPE_COLOR_U2: +@MODEL_TYPE_REGULAR: +@MODEL_TYPE_REGULAR_U2: +@MODEL_TYPE_MINI: +@MODEL_TYPE_MINI_BLUE: +@MODEL_TYPE_MINI_PINK: +@MODEL_TYPE_MINI_GREEN: +@MODEL_TYPE_MINI_GOLD: +@MODEL_TYPE_SHUFFLE: +@MODEL_TYPE_NANO_WHITE: +@MODEL_TYPE_NANO_BLACK: +@MODEL_TYPE_VIDEO_WHITE: +@MODEL_TYPE_VIDEO_BLACK: +@MODEL_TYPE_MOBILE_1: + diff --git a/docs/reference/tmpl/itunesdb-copying.sgml b/docs/reference/tmpl/itunesdb-copying.sgml new file mode 100644 index 0000000..82bfe94 --- /dev/null +++ b/docs/reference/tmpl/itunesdb-copying.sgml @@ -0,0 +1,74 @@ +<!-- ##### SECTION Title ##### --> +File handling functions + +<!-- ##### SECTION Short_Description ##### --> +Functions to copy new files to the iPod + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION itdb_cp_track_to_ipod ##### --> +<para> + +</para> + +@track: +@filename: +@error: +@Returns: + + +<!-- ##### FUNCTION itdb_filename_fs2ipod ##### --> +<para> + +</para> + +@filename: + + +<!-- ##### FUNCTION itdb_filename_ipod2fs ##### --> +<para> + +</para> + +@ipod_file: + + +<!-- ##### FUNCTION itdb_filename_on_ipod ##### --> +<para> + +</para> + +@track: +@Returns: + + +<!-- ##### FUNCTION itdb_musicdirs_number ##### --> +<para> + +</para> + +@itdb: +@Returns: + + +<!-- ##### FUNCTION itdb_rename_files ##### --> +<para> + +</para> + +@mp: +@error: +@Returns: + + diff --git a/docs/reference/tmpl/itunesdb-db.sgml b/docs/reference/tmpl/itunesdb-db.sgml new file mode 100644 index 0000000..37fc775 --- /dev/null +++ b/docs/reference/tmpl/itunesdb-db.sgml @@ -0,0 +1,133 @@ +<!-- ##### SECTION Title ##### --> +iPod database reading/writing + +<!-- ##### SECTION Short_Description ##### --> +Functions to create, read, write the iPod database + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT Itdb_iTunesDB ##### --> +<para> + +</para> + +@tracks: +@playlists: +@filename: +@device: +@version: +@id: +@usertype: +@userdata: +@userdata_duplicate: +@userdata_destroy: + +<!-- ##### USER_FUNCTION ItdbUserDataDestroyFunc ##### --> +<para> + +</para> + +@userdata: + + +<!-- ##### USER_FUNCTION ItdbUserDataDuplicateFunc ##### --> +<para> + +</para> + +@userdata: +@Returns: + + +<!-- ##### FUNCTION itdb_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION itdb_free ##### --> +<para> + +</para> + +@itdb: + + +<!-- ##### FUNCTION itdb_parse ##### --> +<para> + +</para> + +@mp: +@error: +@Returns: + + +<!-- ##### FUNCTION itdb_write ##### --> +<para> + +</para> + +@itdb: +@error: +@Returns: + + +<!-- ##### FUNCTION itdb_set_mountpoint ##### --> +<para> + +</para> + +@itdb: +@mp: + + +<!-- ##### FUNCTION itdb_get_mountpoint ##### --> +<para> + +</para> + +@itdb: +@Returns: + + +<!-- ##### FUNCTION itdb_tracks_number ##### --> +<para> + +</para> + +@itdb: +@Returns: + + +<!-- ##### FUNCTION itdb_tracks_number_nontransferred ##### --> +<para> + +</para> + +@itdb: +@Returns: + + +<!-- ##### FUNCTION itdb_playlists_number ##### --> +<para> + +</para> + +@itdb: +@Returns: + + diff --git a/docs/reference/tmpl/itunesdb-lowlevel.sgml b/docs/reference/tmpl/itunesdb-lowlevel.sgml new file mode 100644 index 0000000..b91b65c --- /dev/null +++ b/docs/reference/tmpl/itunesdb-lowlevel.sgml @@ -0,0 +1,164 @@ +<!-- ##### SECTION Title ##### --> +Low-level functions + +<!-- ##### SECTION Short_Description ##### --> +Low-level functions which shouldn't be needed in normal situations + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION itdb_get_control_dir ##### --> +<para> + +</para> + +@mountpoint: +@Returns: + + +<!-- ##### FUNCTION itdb_get_itunes_dir ##### --> +<para> + +</para> + +@mountpoint: +@Returns: + + +<!-- ##### FUNCTION itdb_get_music_dir ##### --> +<para> + +</para> + +@mountpoint: +@Returns: + + +<!-- ##### FUNCTION itdb_get_artwork_dir ##### --> +<para> + +</para> + +@mountpoint: +@Returns: + + +<!-- ##### FUNCTION itdb_get_device_dir ##### --> +<para> + +</para> + +@mountpoint: +@Returns: + + +<!-- ##### FUNCTION itdb_get_itunesdb_path ##### --> +<para> + +</para> + +@mountpoint: +@Returns: + + +<!-- ##### FUNCTION itdb_get_artworkdb_path ##### --> +<para> + +</para> + +@mountpoint: +@Returns: + + +<!-- ##### FUNCTION itdb_get_path ##### --> +<para> + +</para> + +@dir: +@file: +@Returns: + + +<!-- ##### FUNCTION itdb_resolve_path ##### --> +<para> + +</para> + +@root: +@components: +@Returns: + + +<!-- ##### FUNCTION itdb_shuffle_write ##### --> +<para> + +</para> + +@itdb: +@error: +@Returns: + + +<!-- ##### FUNCTION itdb_shuffle_write_file ##### --> +<para> + +</para> + +@itdb: +@filename: +@error: +@Returns: + + +<!-- ##### FUNCTION itdb_cp ##### --> +<para> + +</para> + +@from_file: +@to_file: +@error: +@Returns: + + +<!-- ##### FUNCTION itdb_parse_file ##### --> +<para> + +</para> + +@filename: +@error: +@Returns: + + +<!-- ##### FUNCTION itdb_write_file ##### --> +<para> + +</para> + +@itdb: +@filename: +@error: +@Returns: + + +<!-- ##### FUNCTION itdb_duplicate ##### --> +<para> + +</para> + +@itdb: +@Returns: + + diff --git a/docs/reference/tmpl/itunesdb-time.sgml b/docs/reference/tmpl/itunesdb-time.sgml new file mode 100644 index 0000000..d06849e --- /dev/null +++ b/docs/reference/tmpl/itunesdb-time.sgml @@ -0,0 +1,45 @@ +<!-- ##### SECTION Title ##### --> +Time handling + +<!-- ##### SECTION Short_Description ##### --> +Helper functions to convert between Epoch time and Mac (iPod) time + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION itdb_time_get_mac_time ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION itdb_time_mac_to_host ##### --> +<para> + +</para> + +@mactime: +@Returns: + + +<!-- ##### FUNCTION itdb_time_host_to_mac ##### --> +<para> + +</para> + +@time: +@Returns: + + diff --git a/docs/reference/tmpl/libgpod-unused.sgml b/docs/reference/tmpl/libgpod-unused.sgml new file mode 100644 index 0000000..6fd94dc --- /dev/null +++ b/docs/reference/tmpl/libgpod-unused.sgml @@ -0,0 +1,126 @@ +<!-- ##### SECTION ./tmpl/itunesdb.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/itunesdb.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/itunesdb.sgml:Short_Description ##### --> +Main data structure to manipulate an iPod content (songs, playlists, ...) + + +<!-- ##### SECTION ./tmpl/itunesdb.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/itunesdb.sgml:Title ##### --> +iTunesDB + + +<!-- ##### MACRO ITDB_FILE_ERROR ##### --> +<para> + +</para> + + +<!-- ##### ENUM ItdbFileError ##### --> +<para> + +</para> + +@ITDB_FILE_ERROR_SEEK: +@ITDB_FILE_ERROR_CORRUPT: +@ITDB_FILE_ERROR_NOTFOUND: +@ITDB_FILE_ERROR_RENAME: +@ITDB_FILE_ERROR_ITDB_CORRUPT: + +<!-- ##### MACRO SPLACTION_LAST_FORTNIGHT ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_HOURS_VALUE ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_LUNARCYCLE_VALUE ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_MINUTES_VALUE ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_MOMENT ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_OSTENT ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_QUARTER ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_SIDEREAL_DAY ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_SIDEREAL_YEAR ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_SOLAR_YEAR ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_SWATCH_BEAT ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_VINAL ##### --> +<para> + +</para> + + +<!-- ##### MACRO SPLACTION_LAST_YEARS_VALUE ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION itdb_file_error_quark ##### --> +<para> + +</para> + +@Returns: + diff --git a/docs/reference/tmpl/playlists.sgml b/docs/reference/tmpl/playlists.sgml new file mode 100644 index 0000000..70395be --- /dev/null +++ b/docs/reference/tmpl/playlists.sgml @@ -0,0 +1,287 @@ +<!-- ##### SECTION Title ##### --> +Playlists + +<!-- ##### SECTION Short_Description ##### --> +Data structure to represent an iPod playlist + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT Itdb_Playlist ##### --> +<para> + +</para> + +@itdb: +@name: +@type: +@flag1: +@flag2: +@flag3: +@num: +@members: +@is_spl: +@timestamp: +@id: +@mhodcount: +@libmhodcount: +@sortorder: +@podcastflag: +@splpref: +@splrules: +@usertype: +@userdata: +@userdata_duplicate: +@userdata_destroy: + +<!-- ##### ENUM ItdbPlaylistSortOrder ##### --> +<para> + +</para> + +@ITDB_PSO_MANUAL: +@ITDB_PSO_TITLE: +@ITDB_PSO_ALBUM: +@ITDB_PSO_ARTIST: +@ITDB_PSO_BIRATE: +@ITDB_PSO_GENRE: +@ITDB_PSO_FILETYPE: +@ITDB_PSO_TIME_MODIFIED: +@ITDB_PSO_TRACK_NR: +@ITDB_PSO_SIZE: +@ITDB_PSO_TIME: +@ITDB_PSO_YEAR: +@ITDB_PSO_SAMPLERATE: +@ITDB_PSO_COMMENT: +@ITDB_PSO_TIME_ADDED: +@ITDB_PSO_EQUALIZER: +@ITDB_PSO_COMPOSER: +@ITDB_PSO_PLAYCOUNT: +@ITDB_PSO_TIME_PLAYED: +@ITDB_PSO_CD_NR: +@ITDB_PSO_RATING: +@ITDB_PSO_RELEASE_DATE: +@ITDB_PSO_BPM: +@ITDB_PSO_GROUPING: +@ITDB_PSO_CATEGORY: +@ITDB_PSO_DESCRIPTION: + +<!-- ##### FUNCTION itdb_playlist_new ##### --> +<para> + +</para> + +@title: +@spl: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_free ##### --> +<para> + +</para> + +@pl: + + +<!-- ##### FUNCTION itdb_playlist_duplicate ##### --> +<para> + +</para> + +@pl: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_add ##### --> +<para> + +</para> + +@itdb: +@pl: +@pos: + + +<!-- ##### FUNCTION itdb_playlist_move ##### --> +<para> + +</para> + +@pl: +@pos: + + +<!-- ##### FUNCTION itdb_playlist_remove ##### --> +<para> + +</para> + +@pl: + + +<!-- ##### FUNCTION itdb_playlist_unlink ##### --> +<para> + +</para> + +@pl: + + +<!-- ##### FUNCTION itdb_playlist_add_track ##### --> +<para> + +</para> + +@pl: +@track: +@pos: + + +<!-- ##### FUNCTION itdb_playlist_remove_track ##### --> +<para> + +</para> + +@pl: +@track: + + +<!-- ##### FUNCTION itdb_playlist_contains_track ##### --> +<para> + +</para> + +@pl: +@track: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_contain_track_number ##### --> +<para> + +</para> + +@tr: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_tracks_number ##### --> +<para> + +</para> + +@pl: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_mpl ##### --> +<para> + +</para> + +@itdb: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_is_mpl ##### --> +<para> + +</para> + +@pl: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_set_mpl ##### --> +<para> + +</para> + +@pl: + + +<!-- ##### FUNCTION itdb_playlist_podcasts ##### --> +<para> + +</para> + +@itdb: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_is_podcasts ##### --> +<para> + +</para> + +@pl: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_set_podcasts ##### --> +<para> + +</para> + +@pl: + + +<!-- ##### FUNCTION itdb_playlist_exists ##### --> +<para> + +</para> + +@itdb: +@pl: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_by_id ##### --> +<para> + +</para> + +@itdb: +@id: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_by_nr ##### --> +<para> + +</para> + +@itdb: +@num: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_by_name ##### --> +<para> + +</para> + +@itdb: +@name: +@Returns: + + +<!-- ##### FUNCTION itdb_playlist_randomize ##### --> +<para> + +</para> + +@pl: + + diff --git a/docs/reference/tmpl/smart-playlists.sgml b/docs/reference/tmpl/smart-playlists.sgml new file mode 100644 index 0000000..d910ccd --- /dev/null +++ b/docs/reference/tmpl/smart-playlists.sgml @@ -0,0 +1,269 @@ +<!-- ##### SECTION Title ##### --> +Smart Playlists + +<!-- ##### SECTION Short_Description ##### --> +Data structures used to manipulate iPod smart playlists + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT SPLPref ##### --> +<para> + +</para> + +@liveupdate: +@checkrules: +@checklimits: +@limittype: +@limitsort: +@limitvalue: +@matchcheckedonly: + +<!-- ##### STRUCT SPLRule ##### --> +<para> + +</para> + +@field: +@action: +@string: +@fromvalue: +@fromdate: +@fromunits: +@tovalue: +@todate: +@tounits: +@unk052: +@unk056: +@unk060: +@unk064: +@unk068: + +<!-- ##### STRUCT SPLRules ##### --> +<para> + +</para> + +@unk004: +@match_operator: +@rules: + +<!-- ##### ENUM SPLAction ##### --> +<para> + +</para> + +@SPLACTION_IS_INT: +@SPLACTION_IS_GREATER_THAN: +@SPLACTION_IS_LESS_THAN: +@SPLACTION_IS_IN_THE_RANGE: +@SPLACTION_IS_IN_THE_LAST: +@SPLACTION_IS_STRING: +@SPLACTION_CONTAINS: +@SPLACTION_STARTS_WITH: +@SPLACTION_ENDS_WITH: +@SPLACTION_IS_NOT_INT: +@SPLACTION_IS_NOT_GREATER_THAN: +@SPLACTION_IS_NOT_LESS_THAN: +@SPLACTION_IS_NOT_IN_THE_RANGE: +@SPLACTION_IS_NOT_IN_THE_LAST: +@SPLACTION_IS_NOT: +@SPLACTION_DOES_NOT_CONTAIN: +@SPLACTION_DOES_NOT_START_WITH: +@SPLACTION_DOES_NOT_END_WITH: + +<!-- ##### ENUM SPLFieldType ##### --> +<para> + +</para> + +@splft_string: +@splft_int: +@splft_boolean: +@splft_date: +@splft_playlist: +@splft_unknown: + +<!-- ##### ENUM SPLActionType ##### --> +<para> + +</para> + +@splat_string: +@splat_int: +@splat_date: +@splat_range_int: +@splat_range_date: +@splat_inthelast: +@splat_playlist: +@splat_none: +@splat_invalid: +@splat_unknown: + +<!-- ##### ENUM SPLField ##### --> +<para> + +</para> + +@SPLFIELD_SONG_NAME: +@SPLFIELD_ALBUM: +@SPLFIELD_ARTIST: +@SPLFIELD_BITRATE: +@SPLFIELD_SAMPLE_RATE: +@SPLFIELD_YEAR: +@SPLFIELD_GENRE: +@SPLFIELD_KIND: +@SPLFIELD_DATE_MODIFIED: +@SPLFIELD_TRACKNUMBER: +@SPLFIELD_SIZE: +@SPLFIELD_TIME: +@SPLFIELD_COMMENT: +@SPLFIELD_DATE_ADDED: +@SPLFIELD_COMPOSER: +@SPLFIELD_PLAYCOUNT: +@SPLFIELD_LAST_PLAYED: +@SPLFIELD_DISC_NUMBER: +@SPLFIELD_RATING: +@SPLFIELD_COMPILATION: +@SPLFIELD_BPM: +@SPLFIELD_GROUPING: +@SPLFIELD_PLAYLIST: + +<!-- ##### MACRO SPLDATE_IDENTIFIER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SPL_MAXSTRINGLENGTH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SPL_STRING_MAXLEN ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION itdb_splr_get_field_type ##### --> +<para> + +</para> + +@splr: +@Returns: + + +<!-- ##### FUNCTION itdb_splr_get_action_type ##### --> +<para> + +</para> + +@splr: +@Returns: + + +<!-- ##### FUNCTION itdb_splr_validate ##### --> +<para> + +</para> + +@splr: + + +<!-- ##### FUNCTION itdb_splr_remove ##### --> +<para> + +</para> + +@pl: +@splr: + + +<!-- ##### FUNCTION itdb_splr_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION itdb_splr_add ##### --> +<para> + +</para> + +@pl: +@splr: +@pos: + + +<!-- ##### FUNCTION itdb_splr_add_new ##### --> +<para> + +</para> + +@pl: +@pos: +@Returns: + + +<!-- ##### FUNCTION itdb_spl_copy_rules ##### --> +<para> + +</para> + +@dest: +@src: + + +<!-- ##### FUNCTION itdb_splr_eval ##### --> +<para> + +</para> + +@splr: +@track: +@Returns: + + +<!-- ##### FUNCTION itdb_spl_update ##### --> +<para> + +</para> + +@spl: + + +<!-- ##### FUNCTION itdb_spl_update_all ##### --> +<para> + +</para> + +@itdb: + + +<!-- ##### FUNCTION itdb_spl_update_live ##### --> +<para> + +</para> + +@itdb: + + diff --git a/docs/reference/tmpl/track.sgml b/docs/reference/tmpl/track.sgml new file mode 100644 index 0000000..a96c52f --- /dev/null +++ b/docs/reference/tmpl/track.sgml @@ -0,0 +1,232 @@ +<!-- ##### SECTION Title ##### --> +Tracks + +<!-- ##### SECTION Short_Description ##### --> +Data structure to store metadata about an iPod track + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT Itdb_Track ##### --> +<para> + +</para> + +@itdb: +@title: +@ipod_path: +@album: +@artist: +@genre: +@filetype: +@comment: +@category: +@composer: +@grouping: +@description: +@podcasturl: +@podcastrss: +@chapterdata: +@subtitle: +@id: +@size: +@tracklen: +@cd_nr: +@cds: +@track_nr: +@tracks: +@bitrate: +@samplerate: +@samplerate_low: +@year: +@volume: +@soundcheck: +@time_added: +@time_played: +@time_modified: +@bookmark_time: +@rating: +@playcount: +@playcount2: +@recent_playcount: +@transferred: +@BPM: +@app_rating: +@type1: +@type2: +@compilation: +@starttime: +@stoptime: +@checked: +@dbid: +@drm_userid: +@visible: +@filetype_marker: +@artwork_count: +@artwork_size: +@samplerate2: +@unk126: +@unk132: +@time_released: +@unk144: +@unk146: +@unk148: +@unk152: +@unk156: +@unk160: +@has_artwork: +@flag2: +@flag3: +@flag4: +@dbid2: +@lyrics_flag: +@movie_flag: +@mark_unplayed: +@unk179: +@unk180: +@unk184: +@samplecount: +@unk192: +@unk196: +@unk200: +@unk204: +@unk208: +@unk212: +@unk216: +@unk220: +@unk224: +@unk228: +@unk232: +@unk236: +@unk240: +@chapterdata_raw: +@chapterdata_raw_length: +@artwork: +@usertype: +@userdata: +@userdata_duplicate: +@userdata_destroy: + +<!-- ##### FUNCTION itdb_track_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION itdb_track_free ##### --> +<para> + +</para> + +@track: + + +<!-- ##### FUNCTION itdb_track_add ##### --> +<para> + +</para> + +@itdb: +@track: +@pos: + + +<!-- ##### FUNCTION itdb_track_remove ##### --> +<para> + +</para> + +@track: + + +<!-- ##### FUNCTION itdb_track_unlink ##### --> +<para> + +</para> + +@track: + + +<!-- ##### FUNCTION itdb_track_duplicate ##### --> +<para> + +</para> + +@tr: +@Returns: + + +<!-- ##### FUNCTION itdb_track_by_id ##### --> +<para> + +</para> + +@itdb: +@id: +@Returns: + + +<!-- ##### FUNCTION itdb_track_id_tree_create ##### --> +<para> + +</para> + +@itdb: +@Returns: + + +<!-- ##### FUNCTION itdb_track_id_tree_destroy ##### --> +<para> + +</para> + +@idtree: + + +<!-- ##### FUNCTION itdb_track_id_tree_by_id ##### --> +<para> + +</para> + +@idtree: +@id: +@Returns: + + +<!-- ##### FUNCTION itdb_track_set_thumbnails ##### --> +<para> + +</para> + +@track: +@filename: +@Returns: + + +<!-- ##### FUNCTION itdb_track_remove_thumbnails ##### --> +<para> + +</para> + +@track: + + +<!-- ##### MACRO ITDB_RATING_STEP ##### --> +<para> + +</para> + + + |
