From 5cc45a27c170810d537b1b479573eeb45cc0de1c Mon Sep 17 00:00:00 2001 From: Todd Zullinger Date: Mon, 8 Dec 2008 01:16:58 +0000 Subject: Update API documentation Add new functions and missing enums, macros, and structs to the proper places in the documentation, remove old/unused functions, and clean up various minor issues. git-svn-id: https://gtkpod.svn.sf.net/svnroot/gtkpod/libgpod/trunk@2159 f01d2545-417e-4e96-918e-98f8d0dbbcb6 --- docs/reference/libgpod-docs.xml | 3 +- docs/reference/libgpod-sections.txt | 152 ++++++++++++++++++++-------- docs/reference/tmpl/artwork.sgml | 58 +++++++++-- docs/reference/tmpl/chapterdata.sgml | 124 +++++++++++++++++++++++ docs/reference/tmpl/device.sgml | 80 ++++++++------- docs/reference/tmpl/itunesdb-copying.sgml | 4 +- docs/reference/tmpl/itunesdb-db.sgml | 120 +++++++++++----------- docs/reference/tmpl/itunesdb-lowlevel.sgml | 34 +++---- docs/reference/tmpl/itunesdb-time.sgml | 14 ++- docs/reference/tmpl/libgpod-unused.sgml | 29 ------ docs/reference/tmpl/photodb.sgml | 154 +++++++++++++++-------------- docs/reference/tmpl/track.sgml | 20 ++++ 12 files changed, 525 insertions(+), 267 deletions(-) create mode 100644 docs/reference/tmpl/chapterdata.sgml (limited to 'docs/reference') diff --git a/docs/reference/libgpod-docs.xml b/docs/reference/libgpod-docs.xml index c6c46b6..4c999fe 100644 --- a/docs/reference/libgpod-docs.xml +++ b/docs/reference/libgpod-docs.xml @@ -26,7 +26,7 @@ - 2006 + 2006-2008 Christophe Fergeau @@ -88,6 +88,7 @@ + diff --git a/docs/reference/libgpod-sections.txt b/docs/reference/libgpod-sections.txt index 7b7e217..0db7680 100644 --- a/docs/reference/libgpod-sections.txt +++ b/docs/reference/libgpod-sections.txt @@ -2,8 +2,7 @@ itunesdb-db The Itdb_iTunesDB structure Itdb_iTunesDB -ItdbUserDataDestroyFunc -ItdbUserDataDuplicateFunc +ItdbFileError itdb_new itdb_free @@ -15,6 +14,9 @@ itdb_get_mountpoint itdb_tracks_number itdb_tracks_number_nontransferred itdb_playlists_number + +ItdbUserDataDestroyFunc +ItdbUserDataDuplicateFunc
@@ -42,16 +44,17 @@ itdb_get_itunessd_path itdb_get_artworkdb_path itdb_get_photodb_path itdb_get_photos_thumb_dir -itdb_get_path +itdb_get_path itdb_resolve_path -itdb_shuffle_write -itdb_shuffle_write_file + itdb_cp itdb_cp_get_dest_filename itdb_cp_finalize itdb_parse_file itdb_write_file +itdb_shuffle_write +itdb_shuffle_write_file itdb_duplicate
@@ -79,6 +82,8 @@ itdb_track_by_id itdb_track_id_tree_create itdb_track_id_tree_destroy itdb_track_id_tree_by_id +itdb_track_get_thumbnail +itdb_track_has_thumbnails itdb_track_set_thumbnails itdb_track_set_thumbnails_from_data itdb_track_set_thumbnails_from_pixbuf @@ -149,6 +154,22 @@ itdb_spl_update_all itdb_spl_update_live +
+chapterdata +Chapter Data +Itdb_Chapter +Itdb_Chapterdata +itdb_chapter_new +itdb_chapter_duplicate +itdb_chapter_free +itdb_chapterdata_new +itdb_chapterdata_add_chapter +itdb_chapterdata_duplicate +itdb_chapterdata_remove_chapter +itdb_chapterdata_remove_chapters +itdb_chapterdata_free +
+
device Device @@ -160,16 +181,17 @@ itdb_device_read_sysinfo itdb_device_get_sysinfo itdb_device_set_sysinfo itdb_device_write_sysinfo +Itdb_IpodInfo itdb_device_get_ipod_info itdb_device_supports_artwork itdb_device_supports_photo +itdb_device_supports_video itdb_info_get_ipod_info_table +Itdb_IpodGeneration itdb_info_get_ipod_generation_string +Itdb_IpodModel itdb_info_get_ipod_model_name_string itdb_init_ipod -Itdb_IpodGeneration -Itdb_IpodInfo -Itdb_IpodModel Itdb_ArtworkFormat
@@ -177,57 +199,57 @@ Itdb_ArtworkFormat artwork Artwork Itdb_Artwork -Itdb_Thumb itdb_artwork_new itdb_artwork_duplicate itdb_artwork_free +itdb_artwork_get_pixbuf +itdb_artwork_set_thumbnail itdb_artwork_set_thumbnail_from_data itdb_artwork_set_thumbnail_from_pixbuf itdb_artwork_remove_thumbnails +Itdb_Thumb itdb_thumb_duplicate itdb_thumb_free +itdb_thumb_to_pixbuf_at_size +itdb_thumb_to_pixbufs
photodb Photo database -Itdb_PhotoAlbum Itdb_PhotoDB -itdb_photodb_add_photo -itdb_photodb_add_photo_from_data -itdb_photodb_add_photo_from_pixbuf itdb_photodb_create itdb_photodb_free itdb_photodb_parse +itdb_photodb_write + +itdb_photodb_add_photo +itdb_photodb_add_photo_from_data +itdb_photodb_add_photo_from_pixbuf +itdb_photodb_remove_photo + +Itdb_PhotoAlbum +itdb_photodb_photoalbum_create itdb_photodb_photoalbum_add_photo itdb_photodb_photoalbum_by_name -itdb_photodb_photoalbum_create itdb_photodb_photoalbum_remove -itdb_photodb_remove_photo -itdb_photodb_write
Internal +DEBUG_ARTWORK G_GNUC_INTERNAL -g_stat -g_mkdir -g_rename -g_printf -G_IS_DIR_SEPARATOR dump_mhif dump_mhia -dump_mhod_type_1 -dump_mhod_type_3 dump_mhni dump_mhod +dump_mhod_string dump_mhii dump_mhl dump_mhsd dump_mhfd dump_mhba -ITUNESDB_MAX_SIZE MHeader MhlHeader MhbdHeader @@ -238,6 +260,7 @@ MhypHeader MhipHeader MhitHeader ArtworkDB_MhodHeader +ArtworkDB_MhodHeaderString MhfdHeader MhliHeader MhiiHeader @@ -248,39 +271,78 @@ MhlfHeader MhifHeader MhiaHeader MhitHeader471 -ArtworkDB_MhodHeaderArtworkType3 MhodHeaderString -MhodHeaderArtworkType1 MhodHeaderSmartPlaylistData MhodHeaderSmartPlaylistRuleString MhodHeaderSmartPlaylistRuleNonString MhodHeaderSmartPlaylistRule iTunesDB_MhsdHeader MhodHeader -MhodHeaderArtworkType3 -playcount NO_PLAYCOUNT WCONTENTS_STEPSIZE -RED_BITS -RED_SHIFT -RED_MASK -GREEN_BITS -GREEN_SHIFT -GREEN_MASK -BLUE_BITS -BLUE_SHIFT -BLUE_MASK DBParseContext db_parse_context_get_m_header iPodSong DB_TO_CPU_GET DB_TO_CPU_GET_DB -ItdbFileError ITDB_FILE_ERROR itdb_file_error_quark -itdb_get_artwork_info_from_type +ITDB_DEVICE_ERROR +ItdbDeviceError +itdb_device_error_quark DbType Itdb_DB +ItdbThumbDataType + +GChecksum +GChecksumType +g_checksum_copy +g_checksum_free +g_checksum_get_digest +g_checksum_get_string +g_checksum_new +g_checksum_type_get_length +g_checksum_update +g_compute_checksum_for_data +g_compute_checksum_for_string + +SysInfoIpodProperties +itdb_sysinfo_extended_parse +itdb_sysinfo_properties_free + +ALPHA_BITS_555 +ALPHA_BITS_888 +ALPHA_MASK_555 +ALPHA_MASK_888 +ALPHA_SHIFT_555 +ALPHA_SHIFT_888 +BLUE_BITS_555 +BLUE_BITS_565 +BLUE_BITS_888 +BLUE_MASK_555 +BLUE_MASK_565 +BLUE_MASK_888 +BLUE_SHIFT_555 +BLUE_SHIFT_565 +BLUE_SHIFT_888 +GREEN_BITS_555 +GREEN_BITS_565 +GREEN_BITS_888 +GREEN_MASK_555 +GREEN_MASK_565 +GREEN_MASK_888 +GREEN_SHIFT_555 +GREEN_SHIFT_565 +GREEN_SHIFT_888 +RED_BITS_555 +RED_BITS_565 +RED_BITS_888 +RED_MASK_555 +RED_MASK_565 +RED_MASK_888 +RED_SHIFT_555 +RED_SHIFT_565 +RED_SHIFT_888 ITDB_SPLACTION_LAST_HOURS_VALUE ITDB_SPLACTION_LAST_MINUTES_VALUE @@ -296,5 +358,15 @@ ITDB_SPLACTION_LAST_QUARTER ITDB_SPLACTION_LAST_SOLAR_YEAR ITDB_SPLACTION_LAST_SIDEREAL_YEAR +SHA_BLOCKSIZE +SHA_BYTE +SHA_BYTE_ORDER +SHA_DIGESTSIZE +SHA_INFO +SHA_LONG +SHA_VERSION +sha_final +sha_init +sha_update +itdb_compute_hash
- diff --git a/docs/reference/tmpl/artwork.sgml b/docs/reference/tmpl/artwork.sgml index a93704b..00a87f3 100644 --- a/docs/reference/tmpl/artwork.sgml +++ b/docs/reference/tmpl/artwork.sgml @@ -42,37 +42,53 @@ album/track artwork. For working with photos, see the @userdata_duplicate: @userdata_destroy: - + -@data_type: -@rotation: +@Returns: - + + +@artwork: @Returns: - + @artwork: + + + + + + + +@device: +@artwork: +@width: +@height: @Returns: - + @artwork: +@filename: +@rotation: +@error: +@Returns: @@ -108,6 +124,14 @@ album/track artwork. For working with photos, see the @artwork: + + + + + +@data_type: +@rotation: + @@ -125,3 +149,25 @@ album/track artwork. For working with photos, see the @thumb: + + + + + +@device: +@thumb: +@width: +@height: +@Returns: + + + + + + + +@device: +@thumb: +@Returns: + + diff --git a/docs/reference/tmpl/chapterdata.sgml b/docs/reference/tmpl/chapterdata.sgml new file mode 100644 index 0000000..6c83b9b --- /dev/null +++ b/docs/reference/tmpl/chapterdata.sgml @@ -0,0 +1,124 @@ + +Chapter Data + + +Data structure to store chapter data for tracks + + + +Chapters allow for a large file to be divided into sections. The start and stop +points in the track are defined here, as well as the title for each chapter. + + + + + + + + + + + + + + + +@startpos: +@chaptertitle: +@reserved_int1: +@reserved_int2: +@reserved1: +@reserved2: + + + + + + +@chapters: +@unk024: +@unk028: +@unk032: +@reserved_int1: +@reserved_int2: +@reserved1: +@reserved2: + + + + + + +@Returns: + + + + + + + +@chapter: +@Returns: + + + + + + + +@chapter: + + + + + + + +@Returns: + + + + + + + +@chapterdata: +@startpos: +@chaptertitle: +@Returns: + + + + + + + +@chapterdata: +@Returns: + + + + + + + +@chapterdata: +@chapter: + + + + + + + +@chapterdata: + + + + + + + +@chapterdata: + + diff --git a/docs/reference/tmpl/device.sgml b/docs/reference/tmpl/device.sgml index c4b69e6..391ee00 100644 --- a/docs/reference/tmpl/device.sgml +++ b/docs/reference/tmpl/device.sgml @@ -94,16 +94,22 @@ These functions are for reading and setting information about the iPod. @Returns: - + -@device: -@Returns: - +@model_number: +@capacity: +@ipod_model: +@ipod_generation: +@musicdirs: +@reserved_int1: +@reserved_int2: +@reserved1: +@reserved2: - + @@ -112,7 +118,7 @@ These functions are for reading and setting information about the iPod. @Returns: - + @@ -121,41 +127,29 @@ These functions are for reading and setting information about the iPod. @Returns: - - - - - -@Returns: - - - + -@generation: +@device: @Returns: - + -@model: +@device: @Returns: - + -@mountpoint: -@model_number: -@ipod_name: -@error: @Returns: @@ -179,26 +173,22 @@ These functions are for reading and setting information about the iPod. @ITDB_IPOD_GENERATION_NANO_1: @ITDB_IPOD_GENERATION_NANO_2: @ITDB_IPOD_GENERATION_NANO_3: +@ITDB_IPOD_GENERATION_NANO_4: @ITDB_IPOD_GENERATION_VIDEO_1: @ITDB_IPOD_GENERATION_VIDEO_2: @ITDB_IPOD_GENERATION_CLASSIC_1: +@ITDB_IPOD_GENERATION_CLASSIC_2: @ITDB_IPOD_GENERATION_TOUCH_1: @ITDB_IPOD_GENERATION_IPHONE_1: - + -@model_number: -@capacity: -@ipod_model: -@ipod_generation: -@musicdirs: -@reserved_int1: -@reserved_int2: -@reserved1: -@reserved2: +@generation: +@Returns: + @@ -228,6 +218,9 @@ These functions are for reading and setting information about the iPod. @ITDB_IPOD_MODEL_NANO_GREEN: @ITDB_IPOD_MODEL_NANO_PINK: @ITDB_IPOD_MODEL_NANO_RED: +@ITDB_IPOD_MODEL_NANO_YELLOW: +@ITDB_IPOD_MODEL_NANO_PURPLE: +@ITDB_IPOD_MODEL_NANO_ORANGE: @ITDB_IPOD_MODEL_IPHONE_1: @ITDB_IPOD_MODEL_SHUFFLE_SILVER: @ITDB_IPOD_MODEL_SHUFFLE_PINK: @@ -240,6 +233,27 @@ These functions are for reading and setting information about the iPod. @ITDB_IPOD_MODEL_CLASSIC_BLACK: @ITDB_IPOD_MODEL_TOUCH_BLACK: + + + + + +@model: +@Returns: + + + + + + + +@mountpoint: +@model_number: +@ipod_name: +@error: +@Returns: + + diff --git a/docs/reference/tmpl/itunesdb-copying.sgml b/docs/reference/tmpl/itunesdb-copying.sgml index 5b28c10..134362e 100644 --- a/docs/reference/tmpl/itunesdb-copying.sgml +++ b/docs/reference/tmpl/itunesdb-copying.sgml @@ -6,8 +6,8 @@ Managing files on the iPod -These functions are for copying, renaming, and getting information about the -files and directories on the iPod +These functions are for copying, renaming, and retrieving information +about the files and directories on the iPod. diff --git a/docs/reference/tmpl/itunesdb-db.sgml b/docs/reference/tmpl/itunesdb-db.sgml index 27d3f52..9d4bcee 100644 --- a/docs/reference/tmpl/itunesdb-db.sgml +++ b/docs/reference/tmpl/itunesdb-db.sgml @@ -2,15 +2,15 @@ iPod database reading/writing -Functions to create, read, write the iPod database +Functions to read, write, and create an iPod database -These functions are for creating, reading, writing, and deleting the iPod +These functions are for reading, writing, creating, and deleting an iPod database and getting the total number of tracks and playlists. -Overview of using the iPod database: +Overview of using an iPod database: itdb_parse(): read the iTunesDB and ArtworkDB @@ -20,72 +20,65 @@ itdb_write(): write the iTunesDB and ArtworkDB itdb_parse() will return a #Itdb_iTunesDB structure with GLists -containing all tracks (each track is represented by a #Itdb_Track -structure) and the playlists (each playlist is represented by a -#Itdb_Playlist structure). +containing all tracks the playlists in the database. Each track is +represented by an #Itdb_Track. Each playlist is represented by an +#Itdb_Playlist. See the Tracks +and Playlists sections for +details on tracks and playlists, respectively. -A number of functions for adding, removing, duplicating tracks -are available. Please see -Tracks for details. +Each #Itdb_Playlist has a GList called @members which contains all of +the tracks in the playlist. Tracks referenced in a playlist must also +be present in the @tracks GList of the #Itdb_iTunesDB. -In each #Itdb_Playlist structure you can find a GList called -'members' with listing all member tracks. Each track referenced -in a playlist must also be present in the tracks GList of the -iTunesDB. +The iPod must contain one master playlist (MPL) containing all tracks +accessible on the iPod through the Music->Tracks/Albums/Artists/etc. +menu. In addition to the MPL there can be a number of normal +playlists accessible through the Music->Playlists menu on the iPod. +Tracks that are a member of one of these normal playlists must also be +a member of the MPL. -The iPod must contain one master playlist (MPL) containing all -tracks accessible on the iPod through the -Music->Tracks/Albums/Artists... menu. Besides the MPL there can -be a number of normal playlists accessible through the -Music->Playlists menu on the iPod. Tracks that are a member of -one of these normal playlists must also be a member of the MPL. +The Podcasts playlist is just another playlist with some internal +flags set differently. Tracks in the Podcasts playlist are not +normally members of the MPL (so on the iPod they will only show up +under the Podcasts menu). All tracks referenced must be in the +@tracks GList of the #Itdb_iTunesDB, however. -The Podcasts playlist is just another playlist with some -internal flags set differently. Also, member tracks in the -Podcasts playlist are not normally members of the MPL (so on the -iPod they will only show up under the Podcasts menu). All tracks -referenced must be in the tracklist of the #Itdb_iTunesDB, -however. +Each track may have a thumbnail associated with it. You can retrieve a +#GdkPixmap of the thumbnail using itdb_artwork_get_pixbuf(). A +thumbnail can be added with itdb_track_set_thumbnails(). A thumbnail +can be removed with itdb_track_remove_thumbnails(). Please see the +Artwork section for more +details on artwork related functions and structures. + -A number of functions to add/remove playlists, or add/remove -tracks are available. Please see -Playlists for details. - - -Each track can have a thumbnail associated with it. You can -retrieve a GdkPixmap of the thumbnail using -itdb_artwork_get_pixbuf(). You can remove a thumbnail with -itdb_track_remove_thumbnails(). And finally, you can set a new -thumbnail using itdb_track_set_thumbnails(). - - -Please note that iTunes additionally stores the artwork as tags +Be aware that iTunes additionally stores the artwork as tags in the original music file. That's also from where the data is read when artwork is displayed in iTunes, and there can be more than one piece of artwork. libgpod does not store the artwork as tags in the original music file. As a consequence, if iTunes attempts to access the artwork, it will find none, and remove libgpod's artwork. Luckily, iTunes will only attempt to access -the artwork if you select a track in iTunes. (To work around +the artwork if you select a track in iTunes. To work around this, gtkpod keeps a list of the original filename of all artwork and silently adds the thumbnails if they were 'lost'. Your application might want to do something similar, or you can supply patches for (optionally!) adding tags to the original music -files.) +files. + The #Itdb_iTunesDB, #Itdb_Playlist and #Itdb_Track structures each -have a userdata and a usertype field that can be used by the -application to store application-specific additional data. If -userdata is a pointer to an external structure, you can supply a -#ItdbUserDataDuplicateFunc and a #ItdbUserDataDestroyFunc so that -this data can be duplicated or freed automatically with a call -to the library _duplicate()/_free() functions. +have @userdata and @usertype fields that can be used by the +application to store additional application-specific data. If +@userdata is a pointer to an external structure, you can supply a +#ItdbUserDataDuplicateFunc and a #ItdbUserDataDestroyFunc so that this +data can be duplicated or freed automatically with a call to the +library _duplicate()/_free() functions. @@ -116,22 +109,16 @@ to the library _duplicate()/_free() functions. @userdata_duplicate: @userdata_destroy: - + -@userdata: - - - - - - - -@userdata: -@Returns: - +@ITDB_FILE_ERROR_SEEK: +@ITDB_FILE_ERROR_CORRUPT: +@ITDB_FILE_ERROR_NOTFOUND: +@ITDB_FILE_ERROR_RENAME: +@ITDB_FILE_ERROR_ITDB_CORRUPT: @@ -214,3 +201,20 @@ to the library _duplicate()/_free() functions. @Returns: + + + + + +@userdata: + + + + + + + +@userdata: +@Returns: + + diff --git a/docs/reference/tmpl/itunesdb-lowlevel.sgml b/docs/reference/tmpl/itunesdb-lowlevel.sgml index 9b8aaa8..9026d76 100644 --- a/docs/reference/tmpl/itunesdb-lowlevel.sgml +++ b/docs/reference/tmpl/itunesdb-lowlevel.sgml @@ -137,73 +137,73 @@ control over the iPod database. @Returns: - + -@itdb: +@from_file: +@to_file: @error: @Returns: - + -@itdb: +@track: +@mountpoint: @filename: @error: @Returns: - + -@from_file: -@to_file: +@track: +@mountpoint: +@dest_filename: @error: @Returns: - + -@track: -@mountpoint: @filename: @error: @Returns: - + -@track: -@mountpoint: -@dest_filename: +@itdb: +@filename: @error: @Returns: - + -@filename: +@itdb: @error: @Returns: - + diff --git a/docs/reference/tmpl/itunesdb-time.sgml b/docs/reference/tmpl/itunesdb-time.sgml index aeee4fb..c0e33a7 100644 --- a/docs/reference/tmpl/itunesdb-time.sgml +++ b/docs/reference/tmpl/itunesdb-time.sgml @@ -2,15 +2,19 @@ Time handling -Helper functions to convert between Epoch time and Mac (iPod) time +[DEPRECATED] Helper functions to convert between Epoch time and Mac +(iPod) time -The functions provide conversion between Epoch time and Mac (iPod) time. These -functions are now obsolete and should no longer be used, libgpod automatically -converts to/from Epoch time and iPod time when writing/reading the iPod -databases +The functions provide conversion between Epoch time and Mac (iPod) +time. + +These functions are now obsolete and should no longer be used, libgpod +automatically converts to/from Epoch time and iPod time when +writing/reading the iPod databases. + diff --git a/docs/reference/tmpl/libgpod-unused.sgml b/docs/reference/tmpl/libgpod-unused.sgml index ccbb77d..2fae13d 100644 --- a/docs/reference/tmpl/libgpod-unused.sgml +++ b/docs/reference/tmpl/libgpod-unused.sgml @@ -118,35 +118,6 @@ iTunesDB - - - - - -@ITDB_FILE_ERROR_SEEK: -@ITDB_FILE_ERROR_CORRUPT: -@ITDB_FILE_ERROR_NOTFOUND: -@ITDB_FILE_ERROR_RENAME: -@ITDB_FILE_ERROR_ITDB_CORRUPT: - - - - - - -@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: -@ITDB_THUMB_COVER_XLARGE: -@ITDB_THUMB_COVER_MEDIUM: -@ITDB_THUMB_COVER_SMEDIUM: -@ITDB_THUMB_COVER_XSMALL: -@ITDB_THUMB_CHAPTER_SMALL: -@ITDB_THUMB_CHAPTER_LARGE: - diff --git a/docs/reference/tmpl/photodb.sgml b/docs/reference/tmpl/photodb.sgml index 59a7a4d..aded6bf 100644 --- a/docs/reference/tmpl/photodb.sgml +++ b/docs/reference/tmpl/photodb.sgml @@ -60,19 +60,20 @@ Library Album if called with no name. If you cannot add photos because your iPod is not recognized, you may have to set the iPod model by calling +itdb_device_set_sysinfo(), e.g. for an 80 GB 6th generation +iPod Video, you would use: + +itdb_device_set_sysinfo (db->device, "ModelNumStr", "MA450"); + -itdb_device_set_sysinfo (db->device, "ModelNumStr", model); - - -For example, "MA450" would stand for an 80 GB 6th generation iPod Video. See -itdb_device.c for a list of supported models. -This information will be written to the iPod when the PhotoDB is -saved (itdb_device_write_sysinfo() is called). +The model number will be saved on the iPod when the PhotoDB is +written (itdb_photodb_write() calls itdb_device_write_sysinfo()). Have a look at the - + -@name: -@members: -@album_type: -@playmusic: -@repeat: -@random: -@show_titles: -@transition_direction: -@slide_duration: -@transition_duration: -@song_id: -@unk024: -@unk028: -@unk044: -@unk048: -@album_id: -@prev_album_id: +@photos: +@photoalbums: +@device: @reserved_int1: @reserved_int2: @reserved1: @@ -121,22 +108,42 @@ directory of the libgpod source for an example of how to use the interface. @userdata_duplicate: @userdata_destroy: - + -@photos: -@photoalbums: -@device: -@reserved_int1: -@reserved_int2: -@reserved1: -@reserved2: -@usertype: -@userdata: -@userdata_duplicate: -@userdata_destroy: +@mountpoint: +@Returns: + + + + + + + +@photodb: + + + + + + + +@mp: +@error: +@Returns: + + + + + + + +@photodb: +@error: +@Returns: + @@ -178,30 +185,56 @@ directory of the libgpod source for an example of how to use the interface. @Returns: - + -@mountpoint: -@Returns: +@db: +@album: +@photo: - + @photodb: +@name: +@members: +@album_type: +@playmusic: +@repeat: +@random: +@show_titles: +@transition_direction: +@slide_duration: +@transition_duration: +@song_id: +@unk024: +@unk028: +@unk044: +@unk048: +@album_id: +@prev_album_id: +@reserved_int1: +@reserved_int2: +@reserved1: +@reserved2: +@usertype: +@userdata: +@userdata_duplicate: +@userdata_destroy: - - + -@mp: -@error: +@db: +@albumname: +@pos: @Returns: @@ -226,17 +259,6 @@ directory of the libgpod source for an example of how to use the interface. @Returns: - - - - - -@db: -@albumname: -@pos: -@Returns: - - @@ -247,23 +269,3 @@ directory of the libgpod source for an example of how to use the interface. @remove_pics: - - - - - -@db: -@album: -@photo: - - - - - - - -@photodb: -@error: -@Returns: - - diff --git a/docs/reference/tmpl/track.sgml b/docs/reference/tmpl/track.sgml index 3a3c14f..a6ff7fb 100644 --- a/docs/reference/tmpl/track.sgml +++ b/docs/reference/tmpl/track.sgml @@ -252,6 +252,26 @@ information about an iPod track. @Returns: + + + + + +@track: +@width: +@height: +@Returns: + + + + + + + +@track: +@Returns: + + -- cgit