#include <PlaylistParserInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::utils::playlistParser::PlaylistParserInterface:

Public Types
enum	PlaylistType { PlaylistType::M3U, PlaylistType::EXT_M3U, PlaylistType::PLS }
	The different types of playlists that are currently supported. More...

Public Member Functions
virtual	~PlaylistParserInterface ()=default

virtual int	parsePlaylist (std::string url, std::shared_ptr< PlaylistParserObserverInterface > observer, std::vector< PlaylistType > playlistTypesToNotBeParsed=std::vector< PlaylistType >())=0

Detailed Description

An interface that can be implemented to parse playlists in a DFS manner.

Member Enumeration Documentation

◆ PlaylistType

enum alexaClientSDK::avsCommon::utils::playlistParser::PlaylistParserInterface::PlaylistType

strong

The different types of playlists that are currently supported.

Enumerator
M3U
EXT_M3U
PLS

Constructor & Destructor Documentation

◆ ~PlaylistParserInterface()

virtual alexaClientSDK::avsCommon::utils::playlistParser::PlaylistParserInterface::~PlaylistParserInterface ( )

virtualdefault

Destructor.

Member Function Documentation

◆ parsePlaylist()

virtual int alexaClientSDK::avsCommon::utils::playlistParser::PlaylistParserInterface::parsePlaylist	(	std::string	url,
		std::shared_ptr< PlaylistParserObserverInterface >	observer,
		std::vector< PlaylistType >	playlistTypesToNotBeParsed = `std::vector< PlaylistType >()`
	)

pure virtual

This function returns immediately. It parses the playlist specified in the url asynchronously. The playlist will be parsed in a DFS manner. If the playlist contains a link to another playlist, then it will proceed to parse that before proceeding. Callbacks willbe issued PlaylistParserObserverInterface via the onPlaylistParsed call whenever a entry has been parsed.

Parameters

url	The url of the playlist to be parsed.
observer	The observer to be notified of playlist parsing.
playlistTypesToNotBeParsed	The playlist types to skip parsing of.

Returns: 0 if adding a new playlist parsing request to the queue failed or the id of the request otherwise. This id will be included in the callback to notify the observer which original request the callback is referencing.

The documentation for this class was generated from the following file:

/workplace/avs-device-sdk/AVSCommon/Utils/include/AVSCommon/Utils/PlaylistParser/PlaylistParserInterface.h

Public Types