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

#include <RemoteVideoPlayerConfiguration.h>

Collaboration diagram for alexaClientSDK::alexaRemoteVideoPlayerInterfaces::Configuration:
Collaboration graph
[legend]

Classes

struct  Catalog
 

Public Types

enum  SupportedOperations { SupportedOperations::PLAY_VIDEO, SupportedOperations::DISPLAY_SEARCH_RESULTS }
 

Public Member Functions

 Configuration ()
 
 Configuration (std::set< SupportedOperations > operations, std::set< acsdkAlexaVideoCommon::VideoEntity::EntityType > entityTypes, std::list< Catalog > catalogs)
 

Public Attributes

avsCommon::utils::Optional< std::set< SupportedOperations > > operations
 All directives supported by the skill. If it is not set, all directives will be assumed supported. More...
 
avsCommon::utils::Optional< std::set< acsdkAlexaVideoCommon::VideoEntity::EntityType > > entityTypes
 All entity types supported by the skill. More...
 
std::list< Catalogcatalogs
 Public and private catalogs supported by the skill. More...
 

Detailed Description

Configuration object used in the Discovery Response

Member Enumeration Documentation

◆ SupportedOperations

Enumeration of supported operations.

Enumerator
PLAY_VIDEO 

Play video content.

DISPLAY_SEARCH_RESULTS 

Display results for a user query.

Constructor & Destructor Documentation

◆ Configuration() [1/2]

alexaClientSDK::alexaRemoteVideoPlayerInterfaces::Configuration::Configuration ( )
inline

Default constructor. Add a catalog entry with sourceId set to 'imdb' and type set to PUBLIC_CATALOG.

◆ Configuration() [2/2]

alexaClientSDK::alexaRemoteVideoPlayerInterfaces::Configuration::Configuration ( std::set< SupportedOperations operations,
std::set< acsdkAlexaVideoCommon::VideoEntity::EntityType entityTypes,
std::list< Catalog catalogs 
)
inline

Constructor.

Parameters
operationsThe set of supported operations.
entityTypesThe set of supported entity types.
catalogsThe list of supported private and public catalogs.

Member Data Documentation

◆ catalogs

std::list<Catalog> alexaClientSDK::alexaRemoteVideoPlayerInterfaces::Configuration::catalogs

Public and private catalogs supported by the skill.

◆ entityTypes

avsCommon::utils::Optional<std::set<acsdkAlexaVideoCommon::VideoEntity::EntityType> > alexaClientSDK::alexaRemoteVideoPlayerInterfaces::Configuration::entityTypes

All entity types supported by the skill.

◆ operations

avsCommon::utils::Optional<std::set<SupportedOperations> > alexaClientSDK::alexaRemoteVideoPlayerInterfaces::Configuration::operations

All directives supported by the skill. If it is not set, all directives will be assumed supported.


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