AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Types | Public Member Functions | Public Attributes | List of all members
alexaClientSDK::playlistParser::PlayItem Struct Reference

#include <M3UParser.h>

Collaboration diagram for alexaClientSDK::playlistParser::PlayItem:
Collaboration graph
[legend]

Public Types

enum  Type { Type::PLAYLIST_URL, Type::MEDIA_INFO }
 

Public Member Functions

 PlayItem (std::string playlistURL)
 
 PlayItem (avsCommon::utils::playlistParser::PlaylistEntry playlistEntry)
 

Public Attributes

enum alexaClientSDK::playlistParser::PlayItem::Type type
 
const std::string playlistURL
 If type == PLAYLIST_URL, url to parse next playlist. More...
 
const avsCommon::utils::playlistParser::PlaylistEntry playlistEntry
 If type == MEDIA_INFO, holds information about next PlaylistEntry. More...
 

Detailed Description

A struct to contain next play item. A PlayItem could either be a Playlist URL (to parse) or Media Info (to play).

Member Enumeration Documentation

◆ Type

Enum to hold the type of PlayItem.

If PlayItem is another playlist, then type is set to PLAYLIST_URL. If PlayItem is information about media to play, then type is set to MEDIA_INFO.

Enumerator
PLAYLIST_URL 
MEDIA_INFO 

Constructor & Destructor Documentation

◆ PlayItem() [1/2]

alexaClientSDK::playlistParser::PlayItem::PlayItem ( std::string  playlistURL)

Constructor for play item which holds an URL to playlist.

Parameters
playlistURLThe URL of a playlist to parse next.

◆ PlayItem() [2/2]

alexaClientSDK::playlistParser::PlayItem::PlayItem ( avsCommon::utils::playlistParser::PlaylistEntry  playlistEntry)

Constructor for play item which holds info about PlaylistEntry.

Parameters
playlistEntryThe PlaylistEntry to play next.

Member Data Documentation

◆ playlistEntry

const avsCommon::utils::playlistParser::PlaylistEntry alexaClientSDK::playlistParser::PlayItem::playlistEntry
Initial value:

If type == MEDIA_INFO, holds information about next PlaylistEntry.

◆ playlistURL

const std::string alexaClientSDK::playlistParser::PlayItem::playlistURL

If type == PLAYLIST_URL, url to parse next playlist.

◆ type

enum alexaClientSDK::playlistParser::PlayItem::Type alexaClientSDK::playlistParser::PlayItem::type

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

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