commit 56e81090c5e8bcdccaf496de908c95c2f0660e67
Author: Christophe Fergeau <[email protected]>
Date: Sat Mar 27 00:38:20 2010 +0100
update API doc
docs/reference/libgpod-sections.txt | 31 ++++++++++++++++++++++++
docs/reference/tmpl/chapterdata.sgml | 9 +++++++
docs/reference/tmpl/device.sgml | 11 ++++++++-
docs/reference/tmpl/itunesdb-copying.sgml | 18 ++++++++++++++
docs/reference/tmpl/itunesdb-db.sgml | 22 ++++++++++++++++-
docs/reference/tmpl/itunesdb-lowlevel.sgml | 9 +++++++
docs/reference/tmpl/photodb.sgml | 35 ++++++++++++++++++++++++++++
docs/reference/tmpl/playlists.sgml | 9 ++++++-
docs/reference/tmpl/track.sgml | 13 ++++++++-
src/itdb.h | 8 ++++++
10 files changed, 159 insertions(+), 6 deletions(-)
---
diff --git a/docs/reference/libgpod-sections.txt
b/docs/reference/libgpod-sections.txt
index 7370694..7df25c3 100644
--- a/docs/reference/libgpod-sections.txt
+++ b/docs/reference/libgpod-sections.txt
@@ -2,6 +2,7 @@
<FILE>itunesdb-db</FILE>
<TITLE>The Itdb_iTunesDB structure</TITLE>
Itdb_iTunesDB
+Itdb_iTunesDB_Private
ItdbFileError
itdb_new
@@ -29,6 +30,9 @@ itdb_filename_ipod2fs
itdb_filename_on_ipod
itdb_musicdirs_number
itdb_rename_files
+
+itdb_start_sync
+itdb_stop_sync
</SECTION>
<SECTION>
@@ -42,6 +46,7 @@ itdb_get_device_dir
itdb_get_photos_dir
itdb_get_itunesdb_path
itdb_get_itunessd_path
+itdb_get_itunescdb_path
itdb_get_artworkdb_path
itdb_get_photodb_path
itdb_get_photos_thumb_dir
@@ -71,6 +76,7 @@ itdb_time_host_to_mac
<FILE>track</FILE>
<TITLE>Tracks</TITLE>
Itdb_Track
+Itdb_Track_Private
Itdb_Mediatype
ITDB_RATING_STEP
itdb_track_new
@@ -96,6 +102,7 @@ itdb_track_remove_thumbnails
<FILE>playlists</FILE>
<TITLE>Playlists</TITLE>
Itdb_Playlist
+Itdb_Playlist_Private
ItdbPlaylistSortOrder
itdb_playlist_new
itdb_playlist_free
@@ -123,6 +130,7 @@ itdb_playlist_by_nr
itdb_playlist_by_name
itdb_playlist_randomize
+
</SECTION>
<SECTION>
@@ -168,6 +176,7 @@ itdb_chapterdata_add_chapter
itdb_chapterdata_duplicate
itdb_chapterdata_remove_chapter
itdb_chapterdata_remove_chapters
+itdb_chapterdata_unlink_chapter
itdb_chapterdata_free
</SECTION>
@@ -231,10 +240,17 @@ itdb_photodb_add_photo_from_pixbuf
itdb_photodb_remove_photo
Itdb_PhotoAlbum
+
+itdb_photodb_photoalbum_free
+itdb_photodb_photoalbum_new
+itdb_photodb_photoalbum_add
+itdb_photodb_photoalbum_unlink
+
itdb_photodb_photoalbum_create
itdb_photodb_photoalbum_add_photo
itdb_photodb_photoalbum_by_name
itdb_photodb_photoalbum_remove
+
</SECTION>
<SECTION>
@@ -284,6 +300,7 @@ MhodHeaderSmartPlaylistData
MhodHeaderSmartPlaylistRuleString
MhodHeaderSmartPlaylistRuleNonString
MhodHeaderSmartPlaylistRule
+Itdb_Playlist_Mhsd5_Type
iTunesDB_MhsdHeader
MhodHeader
NO_PLAYCOUNT
@@ -302,6 +319,12 @@ DbType
Itdb_DB
ItdbChecksumType
ItdbThumbDataType
+Itdb_Thumb_File
+Itdb_Thumb_Ipod
+Itdb_Thumb_Ipod_Item
+Itdb_Thumb_Memory
+Itdb_Thumb_Pixbuf
+Itdb_Item_Id
GChecksum
GChecksumType
@@ -378,4 +401,12 @@ sha_final
sha_init
sha_update
itdb_compute_hash
+
+u32
+u64
+u8
+ROTL
+ROTL16
+ROTL24
+ROTL8
</SECTION>
diff --git a/docs/reference/tmpl/chapterdata.sgml
b/docs/reference/tmpl/chapterdata.sgml
index 6c83b9b..53a59f1 100644
--- a/docs/reference/tmpl/chapterdata.sgml
+++ b/docs/reference/tmpl/chapterdata.sgml
@@ -114,6 +114,15 @@ points in the track are defined here, as well as the title
for each chapter.
@chapterdata:
+<!-- ##### FUNCTION itdb_chapterdata_unlink_chapter ##### -->
+<para>
+
+</para>
+
+...@chapterdata:
+...@chapter:
+
+
<!-- ##### FUNCTION itdb_chapterdata_free ##### -->
<para>
diff --git a/docs/reference/tmpl/device.sgml b/docs/reference/tmpl/device.sgml
index 225b153..c21e2e6 100644
--- a/docs/reference/tmpl/device.sgml
+++ b/docs/reference/tmpl/device.sgml
@@ -29,6 +29,7 @@ These functions are for reading and setting information about
the iPod.
@sysinfo_extended:
@sysinfo_changed:
@timezone_shift:
+...@iphone_sync_context:
<!-- ##### FUNCTION itdb_device_new ##### -->
<para>
@@ -160,6 +161,12 @@ These functions are for reading and setting information
about the iPod.
@ITDB_IPOD_GENERATION_TOUCH_1:
@ITDB_IPOD_GENERATION_IPHONE_1:
@ITDB_IPOD_GENERATION_SHUFFLE_4:
+...@itdb_ipod_generation_touch_2:
+...@itdb_ipod_generation_iphone_2:
+...@itdb_ipod_generation_iphone_3:
+...@itdb_ipod_generation_classic_3:
+...@itdb_ipod_generation_nano_5:
+...@itdb_ipod_generation_touch_3:
<!-- ##### FUNCTION itdb_info_get_ipod_generation_string ##### -->
<para>
@@ -211,8 +218,10 @@ These functions are for reading and setting information
about the iPod.
@ITDB_IPOD_MODEL_SHUFFLE_RED:
@ITDB_IPOD_MODEL_CLASSIC_SILVER:
@ITDB_IPOD_MODEL_CLASSIC_BLACK:
-...@itdb_ipod_model_touch_black:
+...@itdb_ipod_model_touch_silver:
@ITDB_IPOD_MODEL_SHUFFLE_BLACK:
+...@itdb_ipod_model_iphone_white:
+...@itdb_ipod_model_iphone_black:
<!-- ##### FUNCTION itdb_info_get_ipod_model_name_string ##### -->
<para>
diff --git a/docs/reference/tmpl/itunesdb-copying.sgml
b/docs/reference/tmpl/itunesdb-copying.sgml
index 134362e..0d6705f 100644
--- a/docs/reference/tmpl/itunesdb-copying.sgml
+++ b/docs/reference/tmpl/itunesdb-copying.sgml
@@ -73,3 +73,21 @@ about the files and directories on the iPod.
@Returns:
+<!-- ##### FUNCTION itdb_start_sync ##### -->
+<para>
+
+</para>
+
+...@itdb:
+...@returns:
+
+
+<!-- ##### FUNCTION itdb_stop_sync ##### -->
+<para>
+
+</para>
+
+...@itdb:
+...@returns:
+
+
diff --git a/docs/reference/tmpl/itunesdb-db.sgml
b/docs/reference/tmpl/itunesdb-db.sgml
index 3074fed..d4b377e 100644
--- a/docs/reference/tmpl/itunesdb-db.sgml
+++ b/docs/reference/tmpl/itunesdb-db.sgml
@@ -100,15 +100,33 @@ library _duplicate()/_free() functions.
@device:
@version:
@id:
-...@reserved_int1:
+...@tzoffset:
@reserved_int2:
-...@reserved1:
+...@priv:
@reserved2:
@usertype:
@userdata:
@userdata_duplicate:
@userdata_destroy:
+<!-- ##### STRUCT Itdb_iTunesDB_Private ##### -->
+<para>
+
+</para>
+
+...@mhsd5_playlists:
+...@unk_0x22:
+...@id_0x24:
+...@lang:
+...@pid:
+...@unk_0x50:
+...@unk_0x54:
+...@audio_language:
+...@subtitle_language:
+...@unk_0xa4:
+...@unk_0xa6:
+...@unk_0xa8:
+
<!-- ##### ENUM ItdbFileError ##### -->
<para>
diff --git a/docs/reference/tmpl/itunesdb-lowlevel.sgml
b/docs/reference/tmpl/itunesdb-lowlevel.sgml
index 9026d76..1c89c91 100644
--- a/docs/reference/tmpl/itunesdb-lowlevel.sgml
+++ b/docs/reference/tmpl/itunesdb-lowlevel.sgml
@@ -90,6 +90,15 @@ control over the iPod database.
@Returns:
+<!-- ##### FUNCTION itdb_get_itunescdb_path ##### -->
+<para>
+
+</para>
+
+...@mountpoint:
+...@returns:
+
+
<!-- ##### FUNCTION itdb_get_artworkdb_path ##### -->
<para>
diff --git a/docs/reference/tmpl/photodb.sgml b/docs/reference/tmpl/photodb.sgml
index 6c81ea3..655394f 100644
--- a/docs/reference/tmpl/photodb.sgml
+++ b/docs/reference/tmpl/photodb.sgml
@@ -227,6 +227,41 @@ directory of the libgpod source for an example of how to
use the interface.
@userdata_duplicate:
@userdata_destroy:
+<!-- ##### FUNCTION itdb_photodb_photoalbum_free ##### -->
+<para>
+
+</para>
+
+...@album:
+
+
+<!-- ##### FUNCTION itdb_photodb_photoalbum_new ##### -->
+<para>
+
+</para>
+
+...@albumname:
+...@returns:
+
+
+<!-- ##### FUNCTION itdb_photodb_photoalbum_add ##### -->
+<para>
+
+</para>
+
+...@db:
+...@album:
+...@pos:
+
+
+<!-- ##### FUNCTION itdb_photodb_photoalbum_unlink ##### -->
+<para>
+
+</para>
+
+...@album:
+
+
<!-- ##### FUNCTION itdb_photodb_photoalbum_create ##### -->
<para>
diff --git a/docs/reference/tmpl/playlists.sgml
b/docs/reference/tmpl/playlists.sgml
index f34dffe..4eb23c2 100644
--- a/docs/reference/tmpl/playlists.sgml
+++ b/docs/reference/tmpl/playlists.sgml
@@ -43,13 +43,20 @@ a playlist, etc.
@reserved101:
@reserved_int1:
@reserved_int2:
-...@reserved1:
+...@priv:
@reserved2:
@usertype:
@userdata:
@userdata_duplicate:
@userdata_destroy:
+<!-- ##### STRUCT Itdb_Playlist_Private ##### -->
+<para>
+
+</para>
+
+...@mhsd5_type:
+
<!-- ##### ENUM ItdbPlaylistSortOrder ##### -->
<para>
diff --git a/docs/reference/tmpl/track.sgml b/docs/reference/tmpl/track.sgml
index 8f64e08..e4d6511 100644
--- a/docs/reference/tmpl/track.sgml
+++ b/docs/reference/tmpl/track.sgml
@@ -126,7 +126,7 @@ information about an iPod track.
@unk252:
@gapless_track_flag:
@gapless_album_flag:
-...@album_id:
+...@obsolete:
@artwork:
@mhii_link:
@reserved_int1:
@@ -135,7 +135,7 @@ information about an iPod track.
@reserved_int4:
@reserved_int5:
@reserved_int6:
-...@reserved1:
+...@priv:
@reserved2:
@reserved3:
@reserved4:
@@ -146,6 +146,15 @@ information about an iPod track.
@userdata_duplicate:
@userdata_destroy:
+<!-- ##### STRUCT Itdb_Track_Private ##### -->
+<para>
+
+</para>
+
+...@album_id:
+...@artist_id:
+...@composer_id:
+
<!-- ##### ENUM Itdb_Mediatype ##### -->
<para>
diff --git a/src/itdb.h b/src/itdb.h
index fbcd1b0..36700c4 100644
--- a/src/itdb.h
+++ b/src/itdb.h
@@ -1031,6 +1031,8 @@ struct _Itdb_iTunesDB
* @unk028: Unknown, seems to be always 0
* @unk044: Unknown, seems to always be 0
* @unk048: Unknown, seems to always be 0
+ * @album_id: Unique integer for each playlist. This is set
+ * automatically when the PhotoDB is written.
* @prev_album_id: The id of the previous playlist. This is set
* automatically when the PhotoDB is written.
* @reserved_int1: Reserved for future use
@@ -1229,6 +1231,11 @@ typedef enum
* @ITDB_MEDIATYPE_AUDIOBOOK: Audio books
* @ITDB_MEDIATYPE_MUSICVIDEO: Music videos
* @ITDB_MEDIATYPE_TVSHOW: TV Shows
+ * @ITDB_MEDIATYPE_RINGTONE: Ringtone
+ * @ITDB_MEDIATYPE_RENTAL: Rental
+ * @ITDB_MEDIATYPE_ITUNES_EXTRA: ?
+ * @ITDB_MEDIATYPE_MEMO: Memo
+ * @ITDB_MEDIATYPE_ITUNES_U: iTunes U
*
* Mediatype definitions
*
@@ -1548,6 +1555,7 @@ typedef struct _Itdb_Track_Private Itdb_Track_Private;
* @userdata: For use by application
* @userdata_duplicate: A function to duplicate #userdata
* @userdata_destroy: A function to free #userdata
+ * @priv: Private data
*
* Structure representing a track in an iTunesDB
*
------------------------------------------------------------------------------
This SF.net email is sponsored by Sprint
What will you do first with EVO, the first 4G phone?
Visit sprint.com/first -- http://p.sf.net/sfu/sprint-com-first
_______________________________________________
gtkpod-cvs2 mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gtkpod-cvs2
