AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::mediaPlayer::AttachmentReaderSource Class Reference

#include <AttachmentReaderSource.h>

Inheritance diagram for alexaClientSDK::mediaPlayer::AttachmentReaderSource:
Inheritance graph
Collaboration diagram for alexaClientSDK::mediaPlayer::AttachmentReaderSource:
Collaboration graph

Public Member Functions

 ~AttachmentReaderSource ()
Overridden SourceInterface methods.
bool isPlaybackRemote () const override
- Public Member Functions inherited from alexaClientSDK::mediaPlayer::BaseStreamSource
 BaseStreamSource (PipelineInterface *pipeline, const std::string &className)
 ~BaseStreamSource () override
bool hasAdditionalData () override
bool handleEndOfStream () override
void preprocess () override
void addObserver (std::shared_ptr< SourceObserverInterface > observer) override
void removeObserver (std::shared_ptr< SourceObserverInterface > observer) override
- Public Member Functions inherited from alexaClientSDK::mediaPlayer::SourceInterface
 SourceInterface (const std::string &className)
virtual ~SourceInterface ()=default
- Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
 RequiresShutdown (const std::string &name)
virtual ~RequiresShutdown ()
 Destructor. More...
const std::string & name () const
void shutdown ()
bool isShutdown () const

Static Public Member Functions

static std::unique_ptr< AttachmentReaderSourcecreate (PipelineInterface *pipeline, std::shared_ptr< avsCommon::avs::attachment::AttachmentReader > attachmentReader, const avsCommon::utils::AudioFormat *audioFormat, bool repeat)

Additional Inherited Members

- Protected Member Functions inherited from alexaClientSDK::mediaPlayer::BaseStreamSource
bool init (const avsCommon::utils::AudioFormat *audioFormat=nullptr)
GstAppSrc * getAppSrc () const
void signalEndOfData ()
void installOnReadDataHandler ()
void updateOnReadDataHandler ()
void uninstallOnReadDataHandler ()
void clearOnReadDataHandler ()
void notifyObserversOnReadData ()

Constructor & Destructor Documentation

◆ ~AttachmentReaderSource()

alexaClientSDK::mediaPlayer::AttachmentReaderSource::~AttachmentReaderSource ( )

Member Function Documentation

◆ create()

std::unique_ptr< AttachmentReaderSource > alexaClientSDK::mediaPlayer::AttachmentReaderSource::create ( PipelineInterface pipeline,
std::shared_ptr< avsCommon::avs::attachment::AttachmentReader attachmentReader,
const avsCommon::utils::AudioFormat audioFormat,
bool  repeat 

Creates an instance of the AttachmentReaderSource and installs the source within the GStreamer pipeline.

pipelineThe PipelineInterface through which the source of the AudioPipeline may be set.
attachmentReaderThe AttachmentReader from which to create the pipeline source from.
audioFormatThe audioFormat to be used when playing raw PCM data.
repeatA parameter indicating whether to play from the source in a loop.
An instance of the AttachmentReaderSource if successful else a nullptr.

◆ isPlaybackRemote()

bool alexaClientSDK::mediaPlayer::AttachmentReaderSource::isPlaybackRemote ( ) const

Indicates whether a source is local or remote from the perspective of the MediaPlayer (e.g. playing out of the SDS is local, playing a URL is remote).

A boolean indicating whether the source is from a remote or local source

Implements alexaClientSDK::mediaPlayer::SourceInterface.

The documentation for this class was generated from the following files:

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