#include <PlaylistParser.h>

Inheritance diagram for alexaClientSDK::playlistParser::PlaylistParser:

Collaboration diagram for alexaClientSDK::playlistParser::PlaylistParser:

Public Member Functions
int	parsePlaylist (std::string url, std::shared_ptr< avsCommon::utils::playlistParser::PlaylistParserObserverInterface > observer, std::vector< PlaylistType > playlistTypesToNotBeParsed=std::vector< PlaylistType >()) override

void	doShutdown () override

Public Member Functions inherited from alexaClientSDK::avsCommon::utils::playlistParser::PlaylistParserInterface
virtual	~PlaylistParserInterface ()=default

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

Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
	RequiresShutdown (const std::string &name)

virtual	~RequiresShutdown ()
	Destructor. More...

const std::string &	name () const

void	shutdown ()

bool	isShutdown () const

Static Public Member Functions
static std::unique_ptr< PlaylistParser >	create (std::shared_ptr< avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface > contentFetcherFactory)

Static Public Attributes
static const int	START_FAILURE = 0
	A return value that indicates a failure to start the playlist parsing. More...

Additional Inherited Members
Public Types inherited from alexaClientSDK::avsCommon::utils::playlistParser::PlaylistParserInterface
enum	PlaylistType { PlaylistType::M3U, PlaylistType::EXT_M3U, PlaylistType::PLS }
	The different types of playlists that are currently supported. More...

Member Function Documentation

◆ create()

static std::unique_ptr<PlaylistParser> alexaClientSDK::playlistParser::PlaylistParser::create ( std::shared_ptr< avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface > contentFetcherFactory )

static

Creates a new PlaylistParser instance.

Parameters

contentFetcherFactory A factory that can create HTTPContentFetcherInterfaces.

Returns: An std::unique_ptr to a new PlaylistParser if successful or nullptr otherwise.

◆ doShutdown()

void alexaClientSDK::playlistParser::PlaylistParser::doShutdown ( )

overridevirtual

Prepares/enables this object to be deleted. This should be the last function called on this object prior to deleting (or resetting) its shared_ptr.

Warning

Attempting to call functions on this object after calling shutdown() can result in undefined behavior.
Neglecting to call shutdown() on this object can result in resource leaks or other undefined behavior.

Implements alexaClientSDK::avsCommon::utils::RequiresShutdown.

◆ parsePlaylist()

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

override

Member Data Documentation

◆ START_FAILURE

const int alexaClientSDK::playlistParser::PlaylistParser::START_FAILURE = 0

static

A return value that indicates a failure to start the playlist parsing.

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

/workplace/avs-device-sdk/PlaylistParser/include/PlaylistParser/PlaylistParser.h

Public Member Functions

Static Public Member Functions