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::mediaPlayer::PooledMediaResourceProviderInterface Class Referenceabstract

#include <PooledMediaResourceProviderInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::utils::mediaPlayer::PooledMediaResourceProviderInterface:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::avsCommon::utils::mediaPlayer::PooledMediaResourceProviderInterface:
Collaboration graph
[legend]

Public Member Functions

virtual ~PooledMediaResourceProviderInterface ()=default
 
virtual std::vector< std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeInterface > > getSpeakers () const =0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerFactoryInterface
virtual ~MediaPlayerFactoryInterface ()=default
 
virtual Fingerprint getFingerprint ()=0
 
virtual std::shared_ptr< MediaPlayerInterfaceacquireMediaPlayer ()=0
 
virtual bool releaseMediaPlayer (std::shared_ptr< MediaPlayerInterface > mediaPlayer)=0
 
virtual bool isMediaPlayerAvailable ()=0
 
virtual void addObserver (std::shared_ptr< MediaPlayerFactoryObserverInterface > observer)=0
 
virtual void removeObserver (std::shared_ptr< MediaPlayerFactoryObserverInterface > observer)=0
 

Detailed Description

A PooledMediaResourceProviderInterface allows access to MediaPlayerInterface instances as needed (and if available). This is a capability needed to support pre-buffering.

It also provides access to the ChannelVolumeInterfaces associated with the media players managed by this provider in order to perform volume adjustments on the players.

Instances are not expected to be Thread-safe.

Constructor & Destructor Documentation

◆ ~PooledMediaResourceProviderInterface()

virtual alexaClientSDK::avsCommon::utils::mediaPlayer::PooledMediaResourceProviderInterface::~PooledMediaResourceProviderInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getSpeakers()

virtual std::vector<std::shared_ptr<avsCommon::sdkInterfaces::ChannelVolumeInterface> > alexaClientSDK::avsCommon::utils::mediaPlayer::PooledMediaResourceProviderInterface::getSpeakers ( ) const
pure virtual

Gets all ChannelVolumeInterfaces associated with the media players managed by this instance.

Note
The number of channel volume interfaces is not guaranteed to match the number of media players managed by the instance.
Returns
A vector of pointers to ChannelVolumeInterfaces.

Implemented in alexaClientSDK::avsCommon::utils::mediaPlayer::PooledMediaResourceProvider.


The documentation for this class 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