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

#include <PlaylistParserInterface.h>

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

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

The different types of playlists that are currently supported.


Constructor & Destructor Documentation

◆ ~PlaylistParserInterface()

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


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.

urlThe url of the playlist to be parsed.
observerThe observer to be notified of playlist parsing.
playlistTypesToNotBeParsedThe playlist types to skip parsing of.
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:

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