AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::utils::playlistParser::IterativePlaylistParserInterface Class Referenceabstract

#include <IterativePlaylistParserInterface.h>

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

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 ( )


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.

urlThe root url that can either point to one media file or a playlist to be parsed.
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.

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:

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0