An alias for #GHashTable, used in the #TotemPlParser::entry-parsed and #TotemPlParser::playlist-started signals due to #GHashTable not being a boxed type when totem-pl-parser was originally written. The hash table is a mapping from field names (such as %TOTEM_PL_PARSER_FIELD_ALBUM) to their associated values. It is safe to use #GHashTable instead of #TotemPlParserMetadata everywhere. Metadata field for an entry's abstract text. Metadata field for an entry's album. Metadata field for an entry's default audio-track selection. The default track is defined as NULL. Note that the value is sent as a string. Metadata field for an entry's author/composer/director. Metadata field for an entry's "autoplay" flag, which is %TRUE if the entry should play automatically. Metadata field for an entry's base path. Metadata field for an entry's contact details for the webmaster. Metadata field for an entry's content rating. It is %TOTEM_PL_PARSER_CONTENT_RATING_CLEAN for clean content, %TOTEM_PL_PARSER_CONTENT_RATING_EXPLICIT for explicit content and %TOTEM_PL_PARSER_CONTENT_RATING_UNRATED for content which is not rated. Metadata field for an entry's content-type (usually a mime-type coming from a web server). Metadata field for an entry's copyright line. Metadata field for an entry's description. Metadata field for an entry's download URI. Only used if an alternate download location is available for the entry. Metadata field for an entry's playback duration, which should be parsed using totem_pl_parser_parse_duration(). Metadata field for an entry's playback duration, in milliseconds. It's only used when an entry's duration is available in that format, so one would get either the %TOTEM_PL_PARSER_FIELD_DURATION or %TOTEM_PL_PARSER_FIELD_DURATION_MS as metadata. Metadata field for an entry's playback end time. Metadata field for an entry's filesize in bytes. This is only advisory, and can sometimes not match the actual filesize of the stream. Metadata field for an entry's primary genre. This is a string of the form 'Genre1' or 'Genre1/SubGenre1". Metadata field for an entry's full genre. This is a concatenated string of the form 'Genre1/SubGenre1,Genre2/SubGenre2" etc. Metadata field for an entry's identifier. Its use is dependent on the format of the playlist parsed, and its origin. Metadata field for an entry's thumbnail image URI. Metadata field used to tell the calling code that the parsing of a playlist started. It is only %TRUE for the metadata passed to #TotemPlParser::playlist-started or #TotemPlParser::playlist-ended signal handlers. Metadata field for an entry's audio language. Metadata field for an entry's "more info" URI. Metadata field for an entry's status in a playlist. This is usually used when saving the state of an on-going playlist. Metadata field for an entry's publication date, which should be parsed using totem_pl_parser_parse_date(). Metadata field for an entry's preferred screen size. Metadata field for an entry's playback start time, which should be parsed using totem_pl_parser_parse_duration(). The URI of the entry's subtitle file. Metadata field for an entry's displayable title. Metadata field for an entry's preferred UI mode. Metadata field for an entry's URI. Metadata field for an entry's playback volume. All the fields in the #TotemPlParser structure are private and should never be accessed directly. Creates a #TotemPlParser object. a new #TotemPlParser Checks if the first @len bytes of @data can be parsed. %TRUE if @data can be parsed the data to check for parsability the length of data to check %TRUE if debug statements should be printed Checks if the file can be parsed. Files can be parsed if: <itemizedlist> <listitem><para>they have a special mimetype, or</para></listitem> <listitem><para>they have a mimetype which could be a video or a playlist.</para></listitem> </itemizedlist> %TRUE if @filename can be parsed the file to check for parsability %TRUE if debug statements should be printed Checks if the remote URI can be parsed. Note that this does not actually try to open the remote URI, or deduce its mime-type from filename, as this would bring too many false positives. %TRUE if @uri could be parsed the remote URI to check for parsability %TRUE if debug statements should be printed Parses the given date string and returns it as a <type>gint64</type> denoting the date in seconds since the UNIX Epoch. the date in seconds, or -1 on error the date string to parse %TRUE if debug statements should be printed Parses the given duration string and returns it as a <type>gint64</type> denoting the duration in seconds. the duration in seconds, or -1 on error the duration string to parse %TRUE if debug statements should be printed the generic signal handler for the #TotemPlParser::entry-parsed signal, which can be overridden by inheriting classes the generic signal handler for the #TotemPlParser::playlist-ended signal, which can be overridden by inheriting classes the generic signal handler for the #TotemPlParser::playlist-started signal, which can be overridden by inheriting classes Adds a glob to the list of mimetypes to ignore, so that any URI of that glob is ignored during playlist parsing. a #TotemPlParser a glob to ignore Adds a mimetype to the list of mimetypes to ignore, so that any URI of that mimetype is ignored during playlist parsing. a #TotemPlParser the mimetype to ignore Adds a scheme to the list of schemes to ignore, so that any URI using that scheme is ignored during playlist parsing. a #TotemPlParser the scheme to ignore Parses a playlist given by the absolute URI @uri. This method is synchronous, and will block on (e.g.) network requests to slow servers. totem_pl_parser_parse_async() is recommended instead. Return values are as totem_pl_parser_parse_with_base(). a #TotemPlParserResult a #TotemPlParser the URI of the playlist to parse %TRUE if the parser should add the playlist URI to the end of the playlist on parse failure Starts asynchronous parsing of a playlist given by the absolute URI @uri. @parser and @uri are both reffed/copied when this function is called, so can safely be freed after this function returns. For more details, see totem_pl_parser_parse(), which is the synchronous version of this function. When the operation is finished, @callback will be called. You can then call totem_pl_parser_parse_finish() to get the results of the operation. a #TotemPlParser the URI of the playlist to parse %TRUE if the parser should add the playlist URI to the end of the playlist on parse failure optional #GCancellable object, or %NULL a #GAsyncReadyCallback to call when parsing is finished data to pass to the @callback function Finishes an asynchronous playlist parsing operation started with totem_pl_parser_parse_async() or totem_pl_parser_parse_with_base_async(). If parsing of the playlist is cancelled part-way through, %TOTEM_PL_PARSER_RESULT_CANCELLED is returned when this function is called. a #TotemPlParserResult a #TotemPlParser a #GAsyncResult Parses a playlist given by the absolute URI @uri, using @base to resolve relative paths where appropriate. a #TotemPlParserResult a #TotemPlParser the URI of the playlist to parse the base path for relative filenames, or %NULL %TRUE if the parser should add the playlist URI to the end of the playlist on parse failure Starts asynchronous parsing of a playlist given by the absolute URI @uri, using @base to resolve relative paths where appropriate. @parser and @uri are both reffed/copied when this function is called, so can safely be freed after this function returns. For more details, see totem_pl_parser_parse_with_base(), which is the synchronous version of this function. When the operation is finished, @callback will be called. You can then call totem_pl_parser_parse_finish() to get the results of the operation. a #TotemPlParser the URI of the playlist to parse the base path for relative filenames, or %NULL %TRUE if the parser should add the playlist URI to the end of the playlist on parse failure optional #GCancellable object, or %NULL a #GAsyncReadyCallback to call when parsing is finished data to pass to the @callback function Writes the playlist held by @parser and @playlist out to the path pointed by @dest. The playlist is written in the format @type and is given the title @title. If the @output file is a directory the #G_IO_ERROR_IS_DIRECTORY error will be returned, and if the file is some other form of non-regular file then a #G_IO_ERROR_NOT_REGULAR_FILE error will be returned. Some file systems don't allow all file names, and may return a #G_IO_ERROR_INVALID_FILENAME error, and if the name is too long, #G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. In extreme cases, a #G_IO_ERROR_INVALID_ARGUMENT error can be returned, if parts of the playlist to be written are too long. If writing a PLA playlist and there is an error converting a URI's encoding, a code from #GConvertError will be returned. %TRUE on success a #TotemPlParser a #TotemPlPlaylist output #GFile the playlist title a #TotemPlParserType for the outputted playlist Starts asynchronous version of totem_pl_parser_save(). For more details see totem_pl_parser_save(). When the operation is finished, @callback will be called. You can then call totem_pl_parser_save_finish() to get the results of the operation. a #TotemPlParser a #TotemPlPlaylist output #GFile the playlist title a #TotemPlParserType for the outputted playlist a #GCancellable, or %NULL a #GAsyncReadyCallback to call when saving has finished data to pass to the @callback function Finishes an asynchronous playlist saving operation started with totem_pl_parser_save_async(). If saving of the playlist is cancelled part-way through, %G_IO_ERROR_CANCELLED will be returned when this function is called. %TRUE on success, %FALSE on failure. a #TotemPlParser a #GAsyncResult If %TRUE, the parser will output debug information. If %TRUE, the parser will not parse unsafe locations, such as local devices and local files if the playlist isn't local. This is useful if the library is parsing a playlist from a remote location such as a website. If %TRUE, the parser will attempt to parse a playlist, even if it appears to be unsupported (usually because of its filename extension). If %TRUE, the parser will recursively fetch playlists linked to by the current one. The ::entry-parsed signal is emitted when a new entry is parsed. the URI of the entry parsed a #GHashTable of metadata relating to the entry added The ::playlist-ended signal is emitted when a playlist is finished parsing. It is only called when #TotemPlParser::playlist-started has been called for that playlist. the URI of the playlist that finished parsing. The ::playlist-started signal is emitted when a playlist parsing has started. This signal isn't emitted for all types of playlists, but can be relied on to be called for playlists which support playlist metadata, such as title. the URI of the new playlist started a #GHashTable of metadata relating to the playlist that started. The class structure for the #TotemPlParser type. the parent class the generic signal handler for the #TotemPlParser::entry-parsed signal, which can be overridden by inheriting classes the generic signal handler for the #TotemPlParser::playlist-started signal, which can be overridden by inheriting classes the generic signal handler for the #TotemPlParser::playlist-ended signal, which can be overridden by inheriting classes Allows you to differentiate between different errors occurring during file operations in a #TotemPlParser. Error attempting to open a disc device when no disc is present An attempted mount operation failed Playlist to be saved is empty Gives the result of parsing a playlist. The playlist could not be handled. There was an error parsing the playlist. The playlist was parsed successfully. The playlist was ignored due to its scheme or MIME type (see totem_pl_parser_add_ignored_scheme() and totem_pl_parser_add_ignored_mimetype()). Parsing of the playlist was cancelled part-way through. The type of playlist a #TotemPlParser will parse. PLS parser M3U parser M3U (DOS linebreaks) parser XSPF parser iRiver PLA parser All the fields in the #TotemPlPlaylist structure are private and should never be accessed directly. Creates a new #TotemPlPlaylist object. The newly created #TotemPlPlaylist Appends a new empty element to @playlist, and modifies @iter so it points to it. To fill in values, you need to call totem_pl_playlist_set() or totem_pl_playlist_set_value(). a #TotemPlPlaylist an unset #TotemPlPlaylistIter for returning the location Gets the value for one or more keys from the element pointed by @iter. a #TotemPlPlaylist a #TotemPlPlaylistIter pointing to some item in @playlist pairs of key/return location for value, terminated by %NULL See totem_pl_playlist_get(), this function takes a va_list. a #TotemPlPlaylist a #TotemPlPlaylistIter pointing to some item in @playlist a va_list Gets the value for @key (Such as %TOTEM_PL_PARSER_FIELD_URI) in the playlist item pointed by @iter. %TRUE if @iter contains data for @key. a #TotemPlPlaylist a #TotemPlPlaylistIter pointing to some item in @playlist data key an empty #GValue to set Inserts a new empty element to @playlist at @position, and modifies @iter so it points to it. To fill in values, you need to call totem_pl_playlist_set() or totem_pl_playlist_set_value(). @position may be minor than 0 to prepend elements, or bigger than the current @playlist size to append elements. a #TotemPlPlaylist position in the playlist an unset #TotemPlPlaylistIter for returning the location Modifies @iter so it points to the first element in @playlist. %TRUE if there is such first element. a #TotemPlPlaylist an unset #TotemPlPlaylistIter for returning the location Modifies @iter so it points to the next element it previously pointed to. This function will return %FALSE if there was no next element, or @iter didn't actually point to any element in @playlist. %TRUE if there was next element. a #TotemPlPlaylist a #TotemPlPlaylistIter pointing to some item in @playlist Modifies @iter so it points to the previous element it previously pointed to. This function will return %FALSE if there was no previous element, or @iter didn't actually point to any element in @playlist. %TRUE if there was previous element. a #TotemPlPlaylist a #TotemPlPlaylistIter pointing to some item in @playlist Prepends a new empty element to @playlist, and modifies @iter so it points to it. To fill in values, you need to call totem_pl_playlist_set() or totem_pl_playlist_set_value(). a #TotemPlPlaylist an unset #TotemPlPlaylistIter for returning the location Sets the value for one or several keys in the element pointed by @iter. a #TotemPlPlaylist a #TotemPlPlaylistIter pointing to some item in @playlist key/value string pairs, terminated with %NULL See totem_pl_playlist_set(), this function takes a va_list. a #TotemPlPlaylist a #TotemPlPlaylistIter pointing to some item in @playlist a va_list Sets the value for @key in the element pointed by @iter. %TRUE if the value could be stored in @playlist a #TotemPlPlaylist a #TotemPlPlaylistIter pointing to some item in @playlist key to set the value for #GValue containing the key value Returns the number of elements in @playlist. The number of elements a #TotemPlPlaylist All the fields in the #TotemPlPlaylistClass structure are private and should never be accessed directly. the parent class All the fields in the #TotemPlPlaylistIter structure are private and should never be accessed directly. This file has various different disc utility functions for getting the media types and labels of discs. The functions in this file refer to MRLs, which are a special form of URIs used by xine to refer to things such as DVDs. An example of an MRL would be <literal>dvd:///dev/scd0</literal>, which is not a valid URI as far as, for example, GIO is concerned. The rest of the totem-pl-parser API exclusively uses URIs. #TotemPlParser is a general-purpose playlist parser and writer, with support for several different types of playlist. Note that totem-pl-parser requires a main loop to operate properly (e.g. for the #TotemPlParser::entry-parsed signal to be emitted). <example> <title>Reading a Playlist</title> <programlisting> TotemPlParser *pl = totem_pl_parser_new (); g_object_set (pl, "recurse", FALSE, "disable-unsafe", TRUE, NULL); g_signal_connect (G_OBJECT (pl), "playlist-started", G_CALLBACK (playlist_started), NULL); g_signal_connect (G_OBJECT (pl), "entry-parsed", G_CALLBACK (entry_parsed), NULL); if (totem_pl_parser_parse (pl, "http://example.com/playlist.pls", FALSE) != TOTEM_PL_PARSER_RESULT_SUCCESS) g_error ("Playlist parsing failed."); g_object_unref (pl); </programlisting> </example> <example> <title>Reading a Playlist Asynchronously</title> <programlisting> TotemPlParser *pl = totem_pl_parser_new (); g_object_set (pl, "recurse", FALSE, "disable-unsafe", TRUE, NULL); g_signal_connect (G_OBJECT (pl), "playlist-started", G_CALLBACK (playlist_started), NULL); g_signal_connect (G_OBJECT (pl), "entry-parsed", G_CALLBACK (entry_parsed), NULL); totem_pl_parser_parse_async (pl, "http://example.com/playlist.pls", FALSE, NULL, parse_cb, NULL); g_object_unref (pl); static void parse_cb (TotemPlParser *parser, GAsyncResult *result, gpointer user_data) { GError *error = NULL; if (totem_pl_parser_parse_finish (parser, result, &error) != TOTEM_PL_PARSER_RESULT_SUCCESS) { g_error ("Playlist parsing failed: %s", error->message); g_error_free (error); } } </programlisting> </example> <example> <title>Getting Metadata from Entries</title> <programlisting> static void entry_parsed (TotemPlParser *parser, const gchar *uri, GHashTable *metadata, gpointer user_data) { gchar *title = g_hash_table_lookup (metadata, TOTEM_PL_PARSER_FIELD_TITLE); if (title != NULL) g_message ("Entry title: %s", title); else g_message ("Entry (URI: %s) has no title.", uri); } </programlisting> </example> <example> <title>Writing a Playlist</title> <programlisting> { TotemPlParser *pl; TotemPlPlaylist *playlist; TotemPlPlaylistIter iter; GFile *file; pl = totem_pl_parser_new (); playlist = totem_pl_playlist_new (); file = g_file_new_for_path ("/tmp/playlist.pls"); totem_pl_playlist_append (playlist, &iter); totem_pl_playlist_set (playlist, &iter, TOTEM_PL_PARSER_FIELD_URI, "file:///1.ogg", TOTEM_PL_PARSER_FIELD_TITLE, "1.ogg", NULL); totem_pl_playlist_append (playlist, &iter); totem_pl_playlist_set (playlist, &iter, TOTEM_PL_PARSER_FIELD_URI, "file:///2.ogg", NULL); if (totem_pl_parser_save (pl, playlist, file, "Title", TOTEM_PL_PARSER_PLS, NULL) != TRUE) { g_error ("Playlist writing failed."); } g_object_unref (playlist); g_object_unref (pl); g_object_unref (file); } </programlisting> </example> #TotemPlPlaylist represents a playlist, provides API to either navigate through the playlist elements, or perform additions or modifications. See also totem_pl_parser_save(). #TotemPlPlaylistIter refers to an element in a playlist and is designed to bridge between application provided playlist widgets or objects, and #TotemPlParser's saving code.