alexaClientSDK::avsCommon::utils::playlistParser::IterativePlaylistParserInterface Class Reference

#include <IterativePlaylistParserInterface.h>

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

Public Member Functions
virtual bool	initializeParsing (std::string url)=0
virtual PlaylistEntry	next ()=0
virtual void	abort ()=0
virtual	~IterativePlaylistParserInterface ()=default

Detailed Description

An interface that can be implemented to parse playlists in a depth first search manner.

Constructor & Destructor Documentation

~IterativePlaylistParserInterface()

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

virtualdefault

Destructor.

Member Function Documentation

abort()

virtual void alexaClientSDK::avsCommon::utils::playlistParser::IterativePlaylistParserInterface::abort ( )

pure virtual

Abort the current playlist parsing by causing ongoing and future calls to next to fail. Calls to initializeParsing will reset abort.

Implemented in alexaClientSDK::playlistParser::IterativePlaylistParser.

initializeParsing()

virtual bool alexaClientSDK::avsCommon::utils::playlistParser::IterativePlaylistParserInterface::initializeParsing ( std::string  url )

pure virtual

Initialize the playlist parsing. Once succesfully initialized, the method next can be used to retrieve playlist entries.

Parameters

url	The root url that can either point to one media file or a playlist to be parsed.

Returns

true if it succeeds; false otherwise.

Implemented in alexaClientSDK::playlistParser::IterativePlaylistParser.

next()

virtual PlaylistEntry alexaClientSDK::avsCommon::utils::playlistParser::IterativePlaylistParserInterface::next ( )

pure virtual

Get the next element in the playlist.

Returns

The parsing result. The url field will be valid if parseResult is different than ERROR.

Implemented in alexaClientSDK::playlistParser::IterativePlaylistParser.

---

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

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