GNOME.org
 

[grilo] doc: Update documentation

commit 485c5fb691525195559c809298350176138c013b
Author: Juan A. Suarez Romero <jasuarez igalia com>
Date:   Mon Apr 18 18:44:26 2011 +0000

    doc: Update documentation
    
    Signed-off-by: Juan A. Suarez Romero <jasuarez igalia com>

 doc/grilo/grilo-docs.sgml             |    7 ++-
 doc/grilo/grilo-sections.txt          |  143 ++++++++++++++++++++++++++++++++-
 doc/grilo/grilo.types                 |    1 +
 doc/grilo/quick-start-using-grilo.xml |   22 +++--
 4 files changed, 161 insertions(+), 12 deletions(-)
---
diff --git a/doc/grilo/grilo-docs.sgml b/doc/grilo/grilo-docs.sgml
index b1d6b7e..332e1e3 100644
--- a/doc/grilo/grilo-docs.sgml
+++ b/doc/grilo/grilo-docs.sgml
@@ -55,10 +55,15 @@
       <xi:include href="xml/grl-multiple.xml"/>
     </chapter>
 
+    <chapter id="configure">
+      <title>Configuring plug-ins</title>
+      <xi:include href="xml/grl-config.xml"/>
+    </chapter>
+
     <chapter id="data">
       <title>Media data</title>
       <xi:include href="xml/grl-data.xml"/>
-      <xi:include href="xml/grl-config.xml"/>
+      <xi:include href="xml/grl-related-keys.xml"/>
       <xi:include href="xml/grl-media.xml"/>
       <xi:include href="xml/grl-media-box.xml"/>
       <xi:include href="xml/grl-media-video.xml"/>
diff --git a/doc/grilo/grilo-sections.txt b/doc/grilo/grilo-sections.txt
index 32675ae..8f7c08a 100644
--- a/doc/grilo/grilo-sections.txt
+++ b/doc/grilo/grilo-sections.txt
@@ -45,10 +45,14 @@ grl_metadata_source_filter_slow
 grl_metadata_source_filter_writable
 grl_metadata_source_key_depends
 grl_metadata_source_writable_keys
+grl_metadata_source_may_resolve
 grl_metadata_source_resolve
 grl_metadata_source_resolve_sync
+grl_metadata_source_set_operation_data
+grl_metadata_source_get_opearation_data
 grl_metadata_source_set_metadata
 grl_metadata_source_set_metadata_sync
+grl_metadata_source_cancel
 grl_metadata_source_get_id
 grl_metadata_source_get_name
 grl_metadata_source_get_description
@@ -100,6 +104,7 @@ GrlMediaPluginPrivate
 <SECTION>
 <FILE>grl-media-source</FILE>
 <TITLE>GrlMediaSource</TITLE>
+GrlMediaSourceChangeType
 GrlMediaSource
 GrlMediaSourceResultCb
 GrlMediaSourceMetadataCb
@@ -132,6 +137,11 @@ grl_media_source_set_auto_split_threshold
 grl_media_source_get_auto_split_threshold
 grl_media_source_test_media_from_uri
 grl_media_source_get_media_from_uri
+grl_media_source_get_media_from_uri_sync
+grl_media_source_notify_change_start
+grl_media_source_notify_change_stop
+grl_media_source_notify_change_list
+grl_media_source_notify_change
 <SUBSECTION Standard>
 GRL_MEDIA_SOURCE
 GRL_IS_MEDIA_SOURCE
@@ -161,13 +171,16 @@ grl_plugin_registry_load
 grl_plugin_registry_load_directory
 grl_plugin_registry_unload
 grl_plugin_registry_load_all
+grl_plugin_registry_load_by_id
 grl_plugin_registry_register_source
 grl_plugin_registry_unregister_source
 grl_plugin_registry_lookup_source
 grl_plugin_registry_get_sources
 grl_plugin_registry_get_sources_by_operations
 grl_plugin_registry_register_metadata_key
+grl_plugin_registry_register_metadata_key_relation
 grl_plugin_registry_lookup_metadata_key
+grl_plugin_registry_lookup_metadata_key_relation
 grl_plugin_registry_get_metadata_keys
 grl_plugin_registry_add_config
 grl_plugin_registry_add_config_from_file
@@ -189,27 +202,40 @@ GrlPluginRegistryPrivate
 GRL_CONFIG_KEY_PLUGIN
 GRL_CONFIG_KEY_SOURCE
 GRL_CONFIG_KEY_APIKEY
+GRL_CONFIG_KEY_APIKEY_BLOB
 GRL_CONFIG_KEY_APITOKEN
 GRL_CONFIG_KEY_APISECRET
+GRL_CONFIG_KEY_USERNAME
+GRL_CONFIG_KEY_PASSWORD
 GrlConfigClass
 grl_config_set_plugin
 grl_config_set_source
 grl_config_set_api_key
+grl_config_set_api_key_blob
 grl_config_set_api_token
 grl_config_set_api_secret
+grl_config_set_username
+grl_config_set_password
 grl_config_get_plugin
 grl_config_get_api_key
+grl_config_get_api_key_blob
 grl_config_get_api_token
 grl_config_get_api_secret
+grl_config_get_username
+grl_config_get_password
 grl_config_new
 grl_config_set
 grl_config_set_string
 grl_config_set_int
 grl_config_set_float
-grl_config_get
+grl_config_set_boolean
+grl_config_set_binary
 grl_config_get_string
 grl_config_get_int
 grl_config_get_float
+grl_config_get_boolean
+grl_config_get_binary
+grl_config_has_param
 <SUBSECTION Standard>
 GRL_CONFIG
 GRL_IS_CONFIG
@@ -234,9 +260,11 @@ grl_media_set_title
 grl_media_set_description
 grl_media_set_source
 grl_media_set_thumbnail
+grl_media_set_thumbnail_binary
 grl_media_set_site
 grl_media_set_duration
 grl_media_set_date
+grl_media_set_creation_date
 grl_media_set_mime
 grl_media_set_play_count
 grl_media_set_last_played
@@ -247,23 +275,39 @@ grl_media_set_studio
 grl_media_set_certificate
 grl_media_set_license
 grl_media_set_rating
+grl_media_set_url_data
+grl_media_add_url_data
+grl_media_add_author
+grl_media_add_thumbnail
+grl_media_add_thumbnail_binary
+grl_media_add_external_player
+grl_media_add_external_url
 grl_media_get_id
 grl_media_get_url
+grl_media_get_url_data
+grl_media_get_url_data_nth
 grl_media_get_author
+grl_media_get_author_nth
 grl_media_get_title
 grl_media_get_description
 grl_media_get_source
 grl_media_get_thumbnail
+grl_media_get_thumbnail_nth
+grl_media_get_thumbnail_binary
+grl_media_get_thumbnail_binary_nth
 grl_media_get_site
 grl_media_get_duration
 grl_media_get_date
+grl_media_get_creation_date
 grl_media_get_mime
 grl_media_get_rating
 grl_media_get_play_count
 grl_media_get_last_position
 grl_media_get_last_played
 grl_media_get_player
+grl_media_get_player_nth
 grl_media_get_external_url
+grl_media_get_external_url_nth
 grl_media_get_studio
 grl_media_get_certificate
 grl_media_get_license
@@ -290,15 +334,31 @@ grl_data_set
 grl_data_set_string
 grl_data_set_int
 grl_data_set_float
+grl_data_set_binary
 grl_data_get
 grl_data_get_string
 grl_data_get_int
 grl_data_get_float
+grl_data_get_binary
 grl_data_add
 grl_data_remove
 grl_data_has_key
 grl_data_get_keys
 grl_data_key_is_known
+grl_data_add_related_keys
+grl_data_add_string
+grl_data_add_int
+grl_data_add_float
+grl_data_add_binary
+grl_data_length
+grl_data_get_related_keys
+grl_data_get_all_single_related_keys
+grl_data_get-single_values_for_key
+grl_data_get_all_single_related_keys_string
+grl_data_get_single_value_for_key_string
+grl_data_remove_nth
+grl_data_set_related_keys
+grl_data_dup
 grl_data_set_overwrite
 grl_data_get_overwrite
 <SUBSECTION Standard>
@@ -361,11 +421,21 @@ grl_media_audio_set_album
 grl_media_audio_set_genre
 grl_media_audio_set_lyrics
 grl_media_audio_set_bitrate
+grl_media_audio_set_url_data
+grl_media_audio_add_artist
+grl_media_audio_add_genre
+grl_media_audio_add_lyrics
+grl_media_audio_add_url_data
 grl_media_audio_get_artist
+grl_media_audio_get_artist_nth
 grl_media_audio_get_album
 grl_media_audio_get_genre
+grl_media_audio_get_genre_nth
 grl_media_audio_get_lyrics
+grl_media_audio_get_lyrics_nth
 grl_media_audio_get_bitrate
+grl_media_audio_get_url_data
+grl_media_audio_get_url_data_nth
 grl_media_audio_new
 <SUBSECTION Standard>
 GRL_MEDIA_AUDIO
@@ -385,8 +455,22 @@ grl_media_image_set_width
 grl_media_image_set_height
 grl_media_image_get_width
 grl_media_image_get_height
-grl_media_image_new
+grl_media_image_get_camera_model
+grl_media_image_get_flash_used
+grl_media_image_get_exposure_time
+grl_media_image_get_iso_speed
+grl_media_image_get_orientation
 grl_media_image_set_size
+grl_media_image_get_url_data
+grl_media_image_get_url_data_nth
+grl_media_image_set_url_data
+grl_media_image_add_url_data
+grl_media_image_set_camera_model
+grl_media_image_set_flash_used
+grl_media_image_set_exposure_time
+grl_media_image_set_iso_speed
+grl_media_image_set_orientation
+grl_media_image_new
 <SUBSECTION Standard>
 GRL_MEDIA_IMAGE
 GRL_IS_MEDIA_IMAGE
@@ -398,13 +482,46 @@ GRL_MEDIA_IMAGE_GET_CLASS
 </SECTION>
 
 <SECTION>
+<FILE>grl-related-keys</FILE>
+<TITLE>GrlRelatedKeys</TITLE>
+GrlRelatedKeysClass
+grl_related_keys_new
+grl_related_keys_new_valist
+grl_related_keys_new_with_keys
+grl_related_keys_set
+grl_related_keys_set_string
+grl_related_keys_set_int
+grl_related_keys_set_float
+grl_related_keys_set_binary
+grl_related_keys_get
+grl_related_keys_get_string
+grl_related_keys_get_int
+grl_related_keys_get_float
+grl_related_keys_get_binary
+grl_related_keys_add
+grl_related_keys_has_key
+grl_related_keys_get_keys
+grl_related_keys_key_is_known
+grl_related_keys_dup
+<SUBSECTION Standard>
+GRL_RELATED_KEYS
+GRL_IS_RELATED_KEYS
+GRL_TYPE_RELATED_KEYS
+grl_related_keys_get_type
+GRL_RELATED_KEYS_CLASS
+GRL_IS_RELATED_KEYS_CLASS
+GRL_RELATED_KEYS_GET_CLASS
+<SUBSECTION Private>
+GrlRelatedKeysPrivate
+</SECTION>
+
+<SECTION>
 <FILE>grl-metadata-key</FILE>
 <TITLE>GrlMetadataKey<TITLE>
 GRL_METADATA_KEY_GET_ID
 GRL_METADATA_KEY_GET_NAME
 GRL_METADATA_KEY_GET_DESC
 GRL_METADATA_KEY_GET_TYPE
-GRL_METADATA_KEY_CHILDCOUNT_UNKNOWN
 GRL_KEYID_FORMAT
 grl_metadata_key_list_new
 GrlKeyID
@@ -434,14 +551,34 @@ GRL_METADATA_KEY_SITE
 GRL_METADATA_KEY_SOURCE
 GRL_METADATA_KEY_STUDIO
 GRL_METADATA_KEY_THUMBNAIL
+GRL_METADATA_KEY_THUMBNAIL_BINARY
 GRL_METADATA_KEY_TITLE
 GRL_METADATA_KEY_URL
 GRL_METADATA_KEY_WIDTH
+GRL_METADATA_KEY_SEASON
+GRL_METADATA_KEY_EPISODE
+GRL_METADATA_KEY_SHOW
+GRL_METADATA_KEY_CREATION_DATE
+GRL_METADATA_KEY_CAMERA_MODEL
+GRL_METADATA_KEY_ORIENTATION
+GRL_METADATA_KEY_KEY_FLASH_USED
+GRL_METADATA_KEY_EXPOSURE_TIME
+GRL_METADATA_KEY_ISO_SPEED
 grl_metadata_key_get_name
 grl_metadata_key_get_desc
 </SECTION>
 
 <SECTION>
+<FILE>grl-definitions</FILE>
+<TITLE>Definitions</TITLE>
+GRL_METADATA_KEY_CHILDCOUNT_UNKNOWN
+GRL_SOURCE_REMAINING_UNKNOWN
+<SUBSECTION Private>
+GRL_PADDING
+GRL_PADDING_SMALL
+</SECTION>
+
+<SECTION>
 <FILE>grl-util</FILE>
 grl_paging_translate
 grl_list_from_va
diff --git a/doc/grilo/grilo.types b/doc/grilo/grilo.types
index 1a4886d..edb02d6 100644
--- a/doc/grilo/grilo.types
+++ b/doc/grilo/grilo.types
@@ -10,6 +10,7 @@
 
 grl_data_get_type
 grl_config_get_type
+grl_related_keys_get_type
 grl_media_get_type
 grl_media_box_get_type
 grl_media_audio_get_type
diff --git a/doc/grilo/quick-start-using-grilo.xml b/doc/grilo/quick-start-using-grilo.xml
index 4984edc..e5a6087 100644
--- a/doc/grilo/quick-start-using-grilo.xml
+++ b/doc/grilo/quick-start-using-grilo.xml
@@ -80,6 +80,7 @@ static void
 load_plugins (void)
 {
   GrlPluginRegistry *registry;
+  GError *error = NULL;
 
   registry = grl_plugin_registry_get_default ();
 
@@ -94,8 +95,8 @@ load_plugins (void)
      The registry will look for plugins in the default
      plugin path and directories specified using the
      GRL_PLUGIN_PATH environment variable */
-  if (!grl_plugin_registry_load_all (registry)) {
-    g_error ("Failed to load plugins.");
+  if (!grl_plugin_registry_load_all (registry, &error)) {
+    g_error ("Failed to load plugins: %s", error->message);
   }
 }
 
@@ -229,12 +230,13 @@ static void
 load_plugins (void)
 {
   GrlPluginRegistry *registry;
+  GError *error = NULL;
 
   registry = grl_plugin_registry_get_default ();
   g_signal_connect (registry, "source-added",
 		    G_CALLBACK (source_added_cb), NULL);
-  if (!grl_plugin_registry_load_all (registry)) {
-    g_error ("Failed to load plugins.");
+  if (!grl_plugin_registry_load_all (registry, &error)) {
+    g_error ("Failed to load plugins: %s", error->message);
   }
 }
 
@@ -338,12 +340,13 @@ static void
 load_plugins (void)
 {
   GrlPluginRegistry *registry;
+  GError *error = NULL;
 
   registry = grl_plugin_registry_get_default ();
   g_signal_connect (registry, "source-added",
 		    G_CALLBACK (source_added_cb), NULL);
-  if (!grl_plugin_registry_load_all (registry)) {
-    g_error ("Failed to load plugins.");
+  if (!grl_plugin_registry_load_all (registry, &error)) {
+    g_error ("Failed to load plugins: %s", error->message);
   }
 }
 
@@ -457,6 +460,7 @@ const gchar *target_source_id = NULL;
 
 static void
 metadata_cb (GrlMediaSource *source,
+             guint metadata_id,
 	     GrlMedia *media,
 	     gpointer user_data,
 	     const GError *error)
@@ -541,11 +545,13 @@ static void
 load_plugins (void)
 {
   GrlPluginRegistry *registry;
+  GError *error = NULL;
+
   registry = grl_plugin_registry_get_default ();
   g_signal_connect (registry, "source-added",
 		    G_CALLBACK (source_added_cb), NULL);
-  if (!grl_plugin_registry_load_all (registry)) {
-    g_error ("Failed to load plugins.");
+  if (!grl_plugin_registry_load_all (registry, &error)) {
+    g_error ("Failed to load plugins: %s", error->message);
   }
 }
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]