xplayer_pl_parser_new ()

XplayerPlParser *
xplayer_pl_parser_new (void);

Creates a XplayerPlParser object.

xplayer_pl_parser_parse ()

XplayerPlParserResult
xplayer_pl_parser_parse (XplayerPlParser *parser,
                         const char *uri,
                         gboolean fallback);

Parses a playlist given by the absolute URI uri . This method is synchronous, and will block on (e.g.) network requests to slow servers. xplayer_pl_parser_parse_async() is recommended instead.

Return values are as xplayer_pl_parser_parse_with_base().

xplayer_pl_parser_parse_async ()

void
xplayer_pl_parser_parse_async (XplayerPlParser *parser,
                               const char *uri,
                               gboolean fallback,
                               GCancellable *cancellable,
                               GAsyncReadyCallback callback,
                               gpointer user_data);

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 xplayer_pl_parser_parse(), which is the synchronous version of this function.

When the operation is finished, callback will be called. You can then call xplayer_pl_parser_parse_finish() to get the results of the operation.

xplayer_pl_parser_parse_finish ()

XplayerPlParserResult
xplayer_pl_parser_parse_finish (XplayerPlParser *parser,
                                GAsyncResult *async_result,
                                GError **error);

Finishes an asynchronous playlist parsing operation started with xplayer_pl_parser_parse_async() or xplayer_pl_parser_parse_with_base_async().

If parsing of the playlist is cancelled part-way through, XPLAYER_PL_PARSER_RESULT_CANCELLED is returned when this function is called.

xplayer_pl_parser_parse_with_base ()

XplayerPlParserResult
xplayer_pl_parser_parse_with_base (XplayerPlParser *parser,
                                   const char *uri,
                                   const char *base,
                                   gboolean fallback);

Parses a playlist given by the absolute URI uri , using base to resolve relative paths where appropriate.

xplayer_pl_parser_parse_with_base_async ()

void
xplayer_pl_parser_parse_with_base_async
                               (XplayerPlParser *parser,
                                const char *uri,
                                const char *base,
                                gboolean fallback,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

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 xplayer_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 xplayer_pl_parser_parse_finish() to get the results of the operation.

xplayer_pl_parser_save ()

gboolean
xplayer_pl_parser_save (XplayerPlParser *parser,
                        XplayerPlPlaylist *playlist,
                        GFile *dest,
                        const gchar *title,
                        XplayerPlParserType type,
                        GError **error);

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.

xplayer_pl_parser_parse_duration ()

gint64
xplayer_pl_parser_parse_duration (const char *duration,
                                  gboolean debug);

Parses the given duration string and returns it as a gint64 denoting the duration in seconds.

xplayer_pl_parser_parse_date ()

guint64
xplayer_pl_parser_parse_date (const char *date_str,
                              gboolean debug);

Parses the given date string and returns it as a gint64 denoting the date in seconds since the UNIX Epoch.

xplayer_pl_parser_add_ignored_scheme ()

void
xplayer_pl_parser_add_ignored_scheme (XplayerPlParser *parser,
                                      const char *scheme);

Adds a scheme to the list of schemes to ignore, so that any URI using that scheme is ignored during playlist parsing.

xplayer_pl_parser_add_ignored_mimetype ()

void
xplayer_pl_parser_add_ignored_mimetype
                               (XplayerPlParser *parser,
                                const char *mimetype);

Adds a mimetype to the list of mimetypes to ignore, so that any URI of that mimetype is ignored during playlist parsing.

xplayer_pl_parser_can_parse_from_data ()

gboolean
xplayer_pl_parser_can_parse_from_data (const char *data,
                                       gsize len,
                                       gboolean debug);

Checks if the first len bytes of data can be parsed.

xplayer_pl_parser_can_parse_from_filename ()

gboolean
xplayer_pl_parser_can_parse_from_filename
                               (const char *filename,
                                gboolean debug);

Checks if the file can be parsed. Files can be parsed if:

xplayer_pl_parser_can_parse_from_uri ()

gboolean
xplayer_pl_parser_can_parse_from_uri (const char *uri,
                                      gboolean debug);

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.

XplayerPlParser

typedef struct _XplayerPlParser XplayerPlParser;

All the fields in the XplayerPlParser structure are private and should never be accessed directly.

XplayerPlParserClass

typedef struct {
	GObjectClass parent_class;

	/* signals */
	void (*entry_parsed) (XplayerPlParser *parser,
			      const char *uri,
			      GHashTable *metadata);
	void (*playlist_started) (XplayerPlParser *parser,
				  const char *uri,
				  GHashTable *metadata);
	void (*playlist_ended) (XplayerPlParser *parser,
				const char *uri);
} XplayerPlParserClass;

The class structure for the XplayerPlParser type.

enum XplayerPlParserResult

Gives the result of parsing a playlist.

enum XplayerPlParserType

The type of playlist a XplayerPlParser will parse.

enum XplayerPlParserError

Allows you to differentiate between different errors occurring during file operations in a XplayerPlParser.

XplayerPlParserMetadata

typedef GHashTable XplayerPlParserMetadata;

An alias for GHashTable, used in the “entry-parsed” and “playlist-started” signals due to GHashTable not being a boxed type when xplayer-pl-parser was originally written.

The hash table is a mapping from field names (such as XPLAYER_PL_PARSER_FIELD_ALBUM) to their associated values.

It is safe to use GHashTable instead of XplayerPlParserMetadata everywhere.

XPLAYER_PL_PARSER_FIELD_URI

#define XPLAYER_PL_PARSER_FIELD_URI		"url"

Metadata field for an entry's URI.

Since: 2.26

XPLAYER_PL_PARSER_FIELD_GENRE

#define XPLAYER_PL_PARSER_FIELD_GENRE		"genre"

Metadata field for an entry's genre.

XPLAYER_PL_PARSER_FIELD_TITLE

#define XPLAYER_PL_PARSER_FIELD_TITLE		"title"

Metadata field for an entry's displayable title.

XPLAYER_PL_PARSER_FIELD_AUTHOR

#define XPLAYER_PL_PARSER_FIELD_AUTHOR		"author"

Metadata field for an entry's author/composer/director.

XPLAYER_PL_PARSER_FIELD_ALBUM

#define XPLAYER_PL_PARSER_FIELD_ALBUM		"album"

Metadata field for an entry's album.

XPLAYER_PL_PARSER_FIELD_BASE

#define XPLAYER_PL_PARSER_FIELD_BASE		"base"

Metadata field for an entry's base path.

XPLAYER_PL_PARSER_FIELD_VOLUME

#define XPLAYER_PL_PARSER_FIELD_VOLUME		"volume"

Metadata field for an entry's playback volume.

XPLAYER_PL_PARSER_FIELD_AUTOPLAY

#define XPLAYER_PL_PARSER_FIELD_AUTOPLAY		"autoplay"

Metadata field for an entry's "autoplay" flag, which is TRUE if the entry should play automatically.

XPLAYER_PL_PARSER_FIELD_DURATION

#define XPLAYER_PL_PARSER_FIELD_DURATION		"duration"

Metadata field for an entry's playback duration, which should be parsed using xplayer_pl_parser_parse_duration().

XPLAYER_PL_PARSER_FIELD_DURATION_MS

#define XPLAYER_PL_PARSER_FIELD_DURATION_MS "duration-ms"

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 XPLAYER_PL_PARSER_FIELD_DURATION or XPLAYER_PL_PARSER_FIELD_DURATION_MS as metadata.

XPLAYER_PL_PARSER_FIELD_STARTTIME

#define XPLAYER_PL_PARSER_FIELD_STARTTIME		"starttime"

Metadata field for an entry's playback start time, which should be parsed using xplayer_pl_parser_parse_duration().

XPLAYER_PL_PARSER_FIELD_ENDTIME

#define XPLAYER_PL_PARSER_FIELD_ENDTIME		"endtime"

Metadata field for an entry's playback end time.

XPLAYER_PL_PARSER_FIELD_COPYRIGHT

#define XPLAYER_PL_PARSER_FIELD_COPYRIGHT		"copyright"

Metadata field for an entry's copyright line.

XPLAYER_PL_PARSER_FIELD_ABSTRACT

#define XPLAYER_PL_PARSER_FIELD_ABSTRACT		"abstract"

Metadata field for an entry's abstract text.

XPLAYER_PL_PARSER_FIELD_DESCRIPTION

#define XPLAYER_PL_PARSER_FIELD_DESCRIPTION "description"

Metadata field for an entry's description.

XPLAYER_PL_PARSER_FIELD_SUMMARY

#define XPLAYER_PL_PARSER_FIELD_SUMMARY		XPLAYER_PL_PARSER_FIELD_DESCRIPTION

Metadata field for an entry's summary. (In practice, identical to XPLAYER_PL_PARSER_FIELD_DESCRIPTION.)

XPLAYER_PL_PARSER_FIELD_MOREINFO

#define XPLAYER_PL_PARSER_FIELD_MOREINFO		"moreinfo"

Metadata field for an entry's "more info" URI.

XPLAYER_PL_PARSER_FIELD_SCREENSIZE

#define XPLAYER_PL_PARSER_FIELD_SCREENSIZE "screensize"

Metadata field for an entry's preferred screen size.

XPLAYER_PL_PARSER_FIELD_UI_MODE

#define XPLAYER_PL_PARSER_FIELD_UI_MODE		"ui-mode"

Metadata field for an entry's preferred UI mode.

XPLAYER_PL_PARSER_FIELD_PUB_DATE

#define XPLAYER_PL_PARSER_FIELD_PUB_DATE		"publication-date"

Metadata field for an entry's publication date, which should be parsed using xplayer_pl_parser_parse_date().

XPLAYER_PL_PARSER_FIELD_FILESIZE

#define XPLAYER_PL_PARSER_FIELD_FILESIZE		"filesize"

Metadata field for an entry's filesize in bytes. This is only advisory, and can sometimes not match the actual filesize of the stream.

XPLAYER_PL_PARSER_FIELD_LANGUAGE

#define XPLAYER_PL_PARSER_FIELD_LANGUAGE		"language"

Metadata field for an entry's audio language.

XPLAYER_PL_PARSER_FIELD_CONTACT

#define XPLAYER_PL_PARSER_FIELD_CONTACT		"contact"

Metadata field for an entry's contact details for the webmaster.

XPLAYER_PL_PARSER_FIELD_IMAGE_URI

#define XPLAYER_PL_PARSER_FIELD_IMAGE_URI		"image-url"

Metadata field for an entry's thumbnail image URI.

Since: 2.26

XPLAYER_PL_PARSER_FIELD_DOWNLOAD_URI

#define XPLAYER_PL_PARSER_FIELD_DOWNLOAD_URI "download-url"

Metadata field for an entry's download URI. Only used if an alternate download location is available for the entry.

Since: 2.26

XPLAYER_PL_PARSER_FIELD_ID

#define XPLAYER_PL_PARSER_FIELD_ID		"id"

Metadata field for an entry's identifier. Its use is dependent on the format of the playlist parsed, and its origin.

XPLAYER_PL_PARSER_FIELD_IS_PLAYLIST

#define XPLAYER_PL_PARSER_FIELD_IS_PLAYLIST "is-playlist"

Metadata field used to tell the calling code that the parsing of a playlist started. It is only TRUE for the metadata passed to “playlist-started” or “playlist-ended” signal handlers.

XPLAYER_PL_PARSER_FIELD_SUBTITLE_URI

#define XPLAYER_PL_PARSER_FIELD_SUBTITLE_URI "subtitle-uri"

The URI of the entry's subtitle file.

XPLAYER_PL_PARSER_FIELD_CONTENT_TYPE

#define XPLAYER_PL_PARSER_FIELD_CONTENT_TYPE "content-type"

Metadata field for an entry's content-type (usually a mime-type coming from a web server).

The “debug” property

  “debug”                    gboolean

If TRUE, the parser will output debug information.

Flags: Read / Write

Default value: FALSE

The “disable-unsafe” property

  “disable-unsafe”           gboolean

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.

Flags: Read / Write

Default value: FALSE

The “force” property

  “force”                    gboolean

If TRUE, the parser will attempt to parse a playlist, even if it appears to be unsupported (usually because of its filename extension).

Flags: Read / Write

Default value: FALSE

The “recurse” property

  “recurse”                  gboolean

If TRUE, the parser will recursively fetch playlists linked to by the current one.

Flags: Read / Write / Construct

Default value: TRUE

The “entry-parsed” signal

void
user_function (XplayerPlParser         *parser,
               gchar                   *uri,
               XplayerPlParserMetadata *metadata,
               gpointer                 user_data)

The ::entry-parsed signal is emitted when a new entry is parsed.

Flags: Run Last

The “playlist-ended” signal

void
user_function (XplayerPlParser *parser,
               gchar           *uri,
               gpointer         user_data)

The ::playlist-ended signal is emitted when a playlist is finished parsing. It is only called when “playlist-started” has been called for that playlist.

Flags: Run Last

The “playlist-started” signal

void
user_function (XplayerPlParser         *parser,
               gchar                   *uri,
               XplayerPlParserMetadata *metadata,
               gpointer                 user_data)

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.

Flags: Run Last