path: root/doc/grilo/grilo-sections.txt

# Grilo API reference sections

# please add sections in alphabetical order using the following template
# leave two empty lines between sections
# <SECTION>
# <FILE>grl-xxx</FILE>
# <TITLE>GrlXxx</TITLE>
# typedefs
# macros
# constructor
# methods
# <SUBSECTION Standard>
# <SUBSECTION Private>
# </SECTION>

<INCLUDE>grilo.h</INCLUDE>

<SECTION>
<FILE>grl-plugin</FILE>
<TITLE>GrlPlugin</TITLE>
GrlPlugin
GrlPluginClass
GrlPluginDeinitFunc
GrlPluginInitFunc
GrlPluginRegisterKeysFunc
GRL_PLUGIN_AUTHOR
GRL_PLUGIN_DESCRIPTION
GRL_PLUGIN_LICENSE
GRL_PLUGIN_NAME
GRL_PLUGIN_SITE
GRL_PLUGIN_VERSION
grl_plugin_get_author
grl_plugin_get_description
grl_plugin_get_filename
grl_plugin_get_id
grl_plugin_get_license
grl_plugin_get_module
grl_plugin_get_module_name
grl_plugin_get_name
grl_plugin_get_site
grl_plugin_get_sources
grl_plugin_get_version
<SUBSECTION Standard>
GRL_IS_PLUGIN
GRL_IS_PLUGIN_CLASS
GRL_PLUGIN
GRL_PLUGIN_CLASS
GRL_PLUGIN_GET_CLASS
GRL_TYPE_PLUGIN
grl_plugin_get_type
<SUBSECTION Private>
GrlPluginPrivate
</SECTION>

<SECTION>
<FILE>grl-source</FILE>
<TITLE>GrlSource</TITLE>
GrlSource
GrlSourceClass
GrlResolutionFlags
GrlSourceBrowseSpec
GrlSourceChangeType
GrlSourceMediaFromUriSpec
GrlSourceQuerySpec
GrlSourceRemoveCb
GrlSourceRemoveSpec
GrlSourceResolveCb
GrlSourceResolveSpec
GrlSourceResultCb
GrlSourceSearchSpec
GrlSourceStoreCb
GrlSourceStoreMetadataSpec
GrlSourceStoreSpec
GrlSupportedOps
GrlSupportedMedia
GrlWriteFlags
grl_source_browse
grl_source_browse_sync
grl_source_get_auto_split_threshold
grl_source_get_caps
grl_source_get_description
grl_source_get_icon
grl_source_get_id
grl_source_get_media_from_uri
grl_source_get_media_from_uri_sync
grl_source_get_name
grl_source_get_plugin
grl_source_get_rank
grl_source_get_supported_media
grl_source_get_tags
grl_source_may_resolve
grl_source_notify_change
grl_source_notify_change_list
grl_source_notify_change_start
grl_source_notify_change_stop
grl_source_query
grl_source_query_sync
grl_source_remove
grl_source_remove_sync
grl_source_resolve
grl_source_resolve_sync
grl_source_search
grl_source_search_sync
grl_source_set_auto_split_threshold
grl_source_slow_keys
grl_source_store
grl_source_store_metadata
grl_source_store_metadata_sync
grl_source_store_sync
grl_source_supported_keys
grl_source_supported_operations
grl_source_test_media_from_uri
grl_source_writable_keys
<SUBSECTION Standard>
GRL_IS_SOURCE
GRL_IS_SOURCE_CLASS
GRL_SOURCE
GRL_SOURCE_CLASS
GRL_SOURCE_GET_CLASS
GRL_TYPE_SOURCE
grl_source_get_type
<SUBSECTION Private>
GrlSourcePrivate
</SECTION>

<SECTION>
<FILE>grl-caps</FILE>
<TITLE>GrlCaps</TITLE>
GrlCaps
GrlCapsClass
GrlTypeFilter
grl_caps_new
grl_caps_get_key_filter
grl_caps_get_key_range_filter
grl_caps_get_type_filter
grl_caps_is_key_filter
grl_caps_is_key_range_filter
grl_caps_set_key_filter
grl_caps_set_key_range_filter
grl_caps_set_type_filter
grl_caps_test_option
<SUBSECTION Standard>
GRL_CAPS
GRL_CAPS_TYPE
GRL_CAPS_CLASS
GRL_CAPS_GET_CLASS
GRL_IS_CAPS
GRL_IS_CAPS_CLASS
GRL_TYPE_CAPS
grl_caps_get_type
<SUBSECTION Private>
GrlCapsPrivate
</SECTION>

<SECTION>
<FILE>grl-operation-options</FILE>
<TITLE>GrlOperationOptions</TITLE>
GrlOperationOptions
GrlOperationOptionsClass
grl_operation_options_new
grl_operation_options_copy
grl_operation_options_get_count
grl_operation_options_get_resolution_flags
grl_operation_options_get_key_filter
grl_operation_options_get_key_filter_list
grl_operation_options_get_key_range_filter
grl_operation_options_get_key_range_filter_list
grl_operation_options_get_skip
grl_operation_options_get_type_filter
grl_operation_options_obey_caps
grl_operation_options_set_count
grl_operation_options_set_resolution_flags
grl_operation_options_set_key_filter_dictionary
grl_operation_options_set_key_filter_value
grl_operation_options_set_key_filters
grl_operation_options_set_key_range_filter
grl_operation_options_set_key_range_filter_value
grl_operation_options_set_skip
grl_operation_options_set_type_filter
GRL_COUNT_INFINITY
<SUBSECTION Standard>
GRL_IS_OPERATION_OPTIONS
GRL_IS_OPERATION_OPTIONS_CLASS
GRL_OPERATION_OPTIONS
GRL_OPERATION_OPTIONS_CLASS
GRL_OPERATION_OPTIONS_GET_CLASS
GRL_TYPE_OPERATION_OPTIONS
grl_operation_options_get_type
<SUBSECTION Private>
GrlOperationOptionsPrivate
</SECTION>

<SECTION>
<FILE>grl-registry</FILE>
<TITLE>GrlRegistry</TITLE>
GrlRank
GrlRegistry
GrlRegistryClass
GrlPluginDescriptor
GRL_PLUGIN_LIST_VAR
GRL_PLUGIN_PATH_VAR
GRL_PLUGIN_RANKS_VAR
grl_registry_activate_all_plugins
grl_registry_activate_plugin_by_id
grl_registry_add_config
grl_registry_add_config_from_file
grl_registry_add_config_from_resource
grl_registry_add_directory
grl_registry_get_default
grl_registry_get_metadata_keys
grl_registry_get_plugins
grl_registry_get_sources
grl_registry_get_sources_by_operations
grl_registry_load_all_plugins
grl_registry_load_plugin
grl_registry_load_plugin_directory
grl_registry_load_plugin_from_desc
grl_registry_lookup_metadata_key
grl_registry_lookup_metadata_key_desc
grl_registry_lookup_metadata_key_name
grl_registry_lookup_metadata_key_relation
grl_registry_lookup_metadata_key_type
grl_registry_lookup_plugin
grl_registry_lookup_source
grl_registry_metadata_key_validate
grl_registry_register_metadata_key
grl_registry_register_source
grl_registry_unload_plugin
grl_registry_unregister_source
<SUBSECTION Standard>
GRL_IS_REGISTRY
GRL_IS_REGISTRY_CLASS
GRL_REGISTRY
GRL_REGISTRY_CLASS
GRL_REGISTRY_GET_CLASS
GRL_TYPE_REGISTRY
grl_registry_get_type
<SUBSECTION Private>
GrlRegistryPrivate
</SECTION>

<SECTION>
<FILE>grl-related-keys</FILE>
<TITLE>GrlRelatedKeys</TITLE>
GrlRelatedKeys
GrlRelatedKeysClass
grl_related_keys_new
grl_related_keys_new_valist
grl_related_keys_new_with_keys
grl_related_keys_dup
grl_related_keys_get
grl_related_keys_get_binary
grl_related_keys_get_boolean
grl_related_keys_get_boxed
grl_related_keys_get_float
grl_related_keys_get_int
grl_related_keys_get_int64
grl_related_keys_get_keys
grl_related_keys_get_string
grl_related_keys_has_key
grl_related_keys_set
grl_related_keys_set_binary
grl_related_keys_set_boolean
grl_related_keys_set_boxed
grl_related_keys_set_float
grl_related_keys_set_int
grl_related_keys_set_int64
grl_related_keys_set_string
grl_related_keys_remove
<SUBSECTION Standard>
GRL_IS_RELATED_KEYS
GRL_IS_RELATED_KEYS_CLASS
GRL_RELATED_KEYS
GRL_RELATED_KEYS_CLASS
GRL_RELATED_KEYS_GET_CLASS
GRL_TYPE_RELATED_KEYS
grl_related_keys_get_type
<SUBSECTION Private>
GrlRelatedKeysPrivate
</SECTION>

<SECTION>
<FILE>grl-config</FILE>
<TITLE>GrlConfig</TITLE>
GrlConfig
GrlConfigClass
GRL_CONFIG_KEY_APIKEY
GRL_CONFIG_KEY_APIKEY_BLOB
GRL_CONFIG_KEY_APISECRET
GRL_CONFIG_KEY_APITOKEN
GRL_CONFIG_KEY_APITOKEN_SECRET
GRL_CONFIG_KEY_PASSWORD
GRL_CONFIG_KEY_PLUGIN
GRL_CONFIG_KEY_SOURCE
GRL_CONFIG_KEY_USERNAME
grl_config_new
grl_config_get_api_key
grl_config_get_api_key_blob
grl_config_get_api_secret
grl_config_get_api_token
grl_config_get_api_token_secret
grl_config_get_binary
grl_config_get_boolean
grl_config_get_float
grl_config_get_int
grl_config_get_password
grl_config_get_plugin
grl_config_get_source
grl_config_get_string
grl_config_get_username
grl_config_has_param
grl_config_set
grl_config_set_api_key
grl_config_set_api_key_blob
grl_config_set_api_secret
grl_config_set_api_token
grl_config_set_api_token_secret
grl_config_set_binary
grl_config_set_boolean
grl_config_set_float
grl_config_set_int
grl_config_set_password
grl_config_set_plugin
grl_config_set_source
grl_config_set_string
grl_config_set_username
<SUBSECTION Standard>
GRL_CONFIG
GRL_CONFIG_CLASS
GRL_CONFIG_GET_CLASS
GRL_IS_CONFIG
GRL_IS_CONFIG_CLASS
GRL_TYPE_CONFIG
grl_config_get_type
<SUBSECTION Private>
GrlConfigPrivate
</SECTION>

<SECTION>
<FILE>grl-media</FILE>
<TITLE>GrlMedia</TITLE>
GrlMedia
GrlMediaClass
GrlMediaSerializeType
GrlMediaType
grl_media_new
grl_media_audio_new
grl_media_image_new
grl_media_video_new
grl_media_container_new
grl_media_is_audio
grl_media_is_image
grl_media_is_video
grl_media_is_container
grl_media_add_artist
grl_media_add_author
grl_media_add_director
grl_media_add_external_player
grl_media_add_external_url
grl_media_add_genre
grl_media_add_keyword
grl_media_add_lyrics
grl_media_add_mb_artist_id
grl_media_add_performer
grl_media_add_producer
grl_media_add_region_data
grl_media_add_thumbnail
grl_media_add_thumbnail_binary
grl_media_add_url_data
grl_media_get_album
grl_media_get_album_artist
grl_media_get_album_disc_number
grl_media_get_artist
grl_media_get_artist_nth
grl_media_get_author
grl_media_get_author_nth
grl_media_get_bitrate
grl_media_get_camera_model
grl_media_get_certificate
grl_media_get_childcount
grl_media_get_composer
grl_media_get_composer_nth
grl_media_get_creation_date
grl_media_get_description
grl_media_get_director
grl_media_get_director_nth
grl_media_get_duration
grl_media_get_episode
grl_media_get_episode_title
grl_media_get_exposure_time
grl_media_get_favourite
grl_media_get_flash_used
grl_media_get_framerate
grl_media_get_genre
grl_media_get_genre_nth
grl_media_get_height
grl_media_get_external_url
grl_media_get_external_url_nth
grl_media_get_id
grl_media_get_iso_speed
grl_media_get_keyword
grl_media_get_keyword_nth
grl_media_get_last_played
grl_media_get_last_position
grl_media_get_license
grl_media_get_lyrics
grl_media_get_lyrics_nth
grl_media_get_mb_album_id
grl_media_get_mb_artist_id
grl_media_get_mb_artist_id_nth
grl_media_get_mb_recording_id
grl_media_get_mb_track_id
grl_media_get_media_type
grl_media_get_mime
grl_media_get_modification_date
grl_media_get_orientation
grl_media_get_original_title
grl_media_get_performer
grl_media_get_performer_nth
grl_media_get_producer
grl_media_get_producer_nth
grl_media_get_play_count
grl_media_get_player
grl_media_get_player_nth
grl_media_get_publication_date
grl_media_get_rating
grl_media_get_region
grl_media_get_region_data
grl_media_get_region_data_nth
grl_media_get_season
grl_media_get_show
grl_media_get_site
grl_media_get_source
grl_media_get_start_time
grl_media_get_studio
grl_media_get_thumbnail
grl_media_get_thumbnail_binary
grl_media_get_thumbnail_binary_nth
grl_media_get_thumbnail_nth
grl_media_get_track_number
grl_media_get_title
grl_media_get_url
grl_media_get_url_data
grl_media_get_url_data_nth
grl_media_get_size
grl_media_get_width
grl_media_serialize
grl_media_serialize_extended
grl_media_set_album
grl_media_set_album_artist
grl_media_set_album_disc_number
grl_media_set_artist
grl_media_set_author
grl_media_set_bitrate
grl_media_set_camera_model
grl_media_set_certificate
grl_media_set_childcount
grl_media_set_composer
grl_media_set_creation_date
grl_media_set_description
grl_media_set_director
grl_media_set_duration
grl_media_set_episode
grl_media_set_episode_title
grl_media_set_exposure_time
grl_media_set_external_player
grl_media_set_external_url
grl_media_set_favourite
grl_media_set_flash_used
grl_media_set_framerate
grl_media_set_genre
grl_media_set_height
grl_media_set_id
grl_media_set_iso_speed
grl_media_set_keyword
grl_media_set_last_played
grl_media_set_last_position
grl_media_set_license
grl_media_set_lyrics
grl_media_set_mb_album_id
grl_media_set_mb_artist_id
grl_media_set_mb_recording_id
grl_media_set_mb_track_id
grl_media_set_mime
grl_media_set_modification_date
grl_media_set_original_title
grl_media_set_orientation
grl_media_set_performer
grl_media_set_producer
grl_media_set_play_count
grl_media_set_publication_date
grl_media_set_rating
grl_media_set_region
grl_media_set_region_data
grl_media_set_season
grl_media_set_show
grl_media_set_site
grl_media_set_source
grl_media_set_studio
grl_media_set_thumbnail
grl_media_set_thumbnail_binary
grl_media_set_title
grl_media_set_track_number
grl_media_set_url
grl_media_set_url_data
grl_media_set_size
grl_media_set_width
grl_media_unserialize
<SUBSECTION Standard>
GRL_IS_MEDIA
GRL_IS_MEDIA_CLASS
GRL_MEDIA
GRL_MEDIA_CLASS
GRL_MEDIA_GET_CLASS
GRL_TYPE_MEDIA
grl_media_get_type
GrlMediaPrivate
</SECTION>

<SECTION>
<FILE>grl-data</FILE>
<TITLE>GrlData</TITLE>
GrlData
GrlDataClass
grl_data_new
grl_data_add_binary
grl_data_add_boxed
grl_data_add_float
grl_data_add_for_id
grl_data_add_int
grl_data_add_int64
grl_data_add_related_keys
grl_data_add_string
grl_data_dup
grl_data_get
grl_data_get_binary
grl_data_get_boolean
grl_data_get_boxed
grl_data_get_float
grl_data_set_for_id
grl_data_get_int
grl_data_get_int64
grl_data_get_keys
grl_data_get_related_keys
grl_data_get_single_values_for_key
grl_data_get_single_values_for_key_string
grl_data_get_string
grl_data_has_key
grl_data_length
grl_data_remove
grl_data_remove_nth
grl_data_set
grl_data_set_binary
grl_data_set_boolean
grl_data_set_boxed
grl_data_set_float
grl_data_set_int
grl_data_set_int64
grl_data_set_related_keys
grl_data_set_string
<SUBSECTION Standard>
GRL_DATA
GRL_DATA_CLASS
GRL_DATA_GET_CLASS
GRL_IS_DATA
GRL_IS_DATA_CLASS
GRL_TYPE_DATA
grl_data_get_type
<SUBSECTION Private>
GrlDataPrivate
</SECTION>

<SECTION>
<FILE>grl-metadata-key</FILE>
GrlKeyID
GRLKEYID_TO_POINTER
GRLPOINTER_TO_KEYID
GRL_KEYID_FORMAT
GRL_METADATA_KEY_GET_DESC
GRL_METADATA_KEY_GET_ID
GRL_METADATA_KEY_GET_NAME
GRL_METADATA_KEY_GET_TYPE
GRL_METADATA_KEY_ALBUM
GRL_METADATA_KEY_ALBUM_ARTIST
GRL_METADATA_KEY_ALBUM_DISC_NUMBER
GRL_METADATA_KEY_ARTIST
GRL_METADATA_KEY_AUDIO_TRACK
GRL_METADATA_KEY_AUTHOR
GRL_METADATA_KEY_BITRATE
GRL_METADATA_KEY_CAMERA_MODEL
GRL_METADATA_KEY_CERTIFICATE
GRL_METADATA_KEY_CHILDCOUNT
GRL_METADATA_KEY_COMPOSER
GRL_METADATA_KEY_CREATION_DATE
GRL_METADATA_KEY_DESCRIPTION
GRL_METADATA_KEY_DIRECTOR
GRL_METADATA_KEY_DURATION
GRL_METADATA_KEY_EPISODE
GRL_METADATA_KEY_EPISODE_TITLE
GRL_METADATA_KEY_EXPOSURE_TIME
GRL_METADATA_KEY_EXTERNAL_PLAYER
GRL_METADATA_KEY_EXTERNAL_URL
GRL_METADATA_KEY_FAVOURITE
GRL_METADATA_KEY_FLASH_USED
GRL_METADATA_KEY_FRAMERATE
GRL_METADATA_KEY_GENRE
GRL_METADATA_KEY_HEIGHT
GRL_METADATA_KEY_ID
GRL_METADATA_KEY_INVALID
GRL_METADATA_KEY_ISO_SPEED
GRL_METADATA_KEY_KEYWORD
GRL_METADATA_KEY_LAST_PLAYED
GRL_METADATA_KEY_LAST_POSITION
GRL_METADATA_KEY_LICENSE
GRL_METADATA_KEY_LYRICS
GRL_METADATA_KEY_MB_ALBUM_ID
GRL_METADATA_KEY_MB_ARTIST_ID
GRL_METADATA_KEY_MB_RECORDING_ID
GRL_METADATA_KEY_MB_TRACK_ID
GRL_METADATA_KEY_MIME
GRL_METADATA_KEY_MODIFICATION_DATE
GRL_METADATA_KEY_ORIENTATION
GRL_METADATA_KEY_ORIGINAL_TITLE
GRL_METADATA_KEY_PERFORMER
GRL_METADATA_KEY_PLAY_COUNT
GRL_METADATA_KEY_PRODUCER
GRL_METADATA_KEY_PUBLICATION_DATE
GRL_METADATA_KEY_RATING
GRL_METADATA_KEY_REGION
GRL_METADATA_KEY_SEASON
GRL_METADATA_KEY_SHOW
GRL_METADATA_KEY_SITE
GRL_METADATA_KEY_SIZE
GRL_METADATA_KEY_SOURCE
GRL_METADATA_KEY_START_TIME
GRL_METADATA_KEY_STUDIO
GRL_METADATA_KEY_THUMBNAIL
GRL_METADATA_KEY_THUMBNAIL_BINARY
GRL_METADATA_KEY_TITLE
GRL_METADATA_KEY_TITLE_FROM_FILENAME
GRL_METADATA_KEY_TRACK_NUMBER
GRL_METADATA_KEY_URL
GRL_METADATA_KEY_WIDTH
grl_metadata_key_get_desc
grl_metadata_key_get_name
grl_metadata_key_get_type
grl_metadata_key_list_new
</SECTION>

<SECTION>
<FILE>grl-util</FILE>
grl_date_time_from_iso8601
grl_list_from_va
grl_paging_translate
</SECTION>

<SECTION>
<FILE>grilo</FILE>
grl_init
grl_init_get_option_group
grl_deinit
</SECTION>

<SECTION>
<FILE>grl-definitions</FILE>
GRL_METADATA_KEY_CHILDCOUNT_UNKNOWN
GRL_SOURCE_REMAINING_UNKNOWN
<SUBSECTION Private>
GRL_PADDING
GRL_PADDING_SMALL
</SECTION>

<SECTION>
<FILE>grl-multiple</FILE>
<TITLE>Multiple</TITLE>
grl_multiple_get_media_from_uri
grl_multiple_search
grl_multiple_search_sync
</SECTION>

<SECTION>
<FILE>grl-operation</FILE>
grl_operation_cancel
grl_operation_get_data
grl_operation_set_data
grl_operation_set_data_full
</SECTION>

<SECTION>
<FILE>grl-log</FILE>
GrlLogDomain
GrlLogLevel
GRL_LOG
GRL_LOG_DOMAIN
GRL_LOG_DOMAIN_DEFAULT
GRL_LOG_DOMAIN_EXTERN
GRL_LOG_DOMAIN_FREE
GRL_LOG_DOMAIN_INIT
GRL_LOG_DOMAIN_STATIC
GRL_DEBUG
GRL_ERROR
GRL_INFO
GRL_MESSAGE
GRL_WARNING
grl_log
grl_log_configure
grl_log_domain_free
grl_log_domain_new
</SECTION>

<SECTION>
<FILE>grl-error</FILE>
GrlCoreError
GRL_CORE_ERROR
</SECTION>

<SECTION>
<FILE>grl-net-wc</FILE>
<TITLE>GrlNetWc</TITLE>
GrlNetWc
GrlNetWcClass
GrlNetWcError
GRL_NET_WC_ERROR
grl_net_wc_new
grl_net_wc_error_quark
grl_net_wc_flush_delayed_requests
grl_net_wc_request_async
grl_net_wc_request_finish
grl_net_wc_request_with_headers_async
grl_net_wc_request_with_headers_hash_async
grl_net_wc_set_cache
grl_net_wc_set_cache_size
grl_net_wc_set_log_level
grl_net_wc_set_throttling
<SUBSECTION Standard>
GRL_IS_NET_WC
GRL_IS_NET_WC_CLASS
GRL_NET_WC
GRL_NET_WC_CLASS
GRL_NET_WC_GET_CLASS
GRL_TYPE_NET_WC
grl_net_wc_get_type
<SUBSECTION Private>
GrlNetWcPrivate
</SECTION>

<SECTION>
<FILE>grl-pls</FILE>
<TITLE>GrlPls</TITLE>
GrlPlsFilterFunc
grl_pls_media_is_playlist
grl_pls_browse
grl_pls_browse_sync
grl_pls_browse_by_spec
grl_pls_file_to_media
grl_pls_get_file_attributes
</SECTION>