A mock MediaPlayer for unit tests. More...

#include <MockMediaPlayer.h>

Inheritance diagram for alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer:

[legend]

Collaboration diagram for alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer:

Public Types
using	observer = avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface

using	MediaPlayerState = avsCommon::utils::mediaPlayer::MediaPlayerState

Public Types inherited from alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface
using	SourceId = uint64_t
	A type that identifies which source is currently being operated on. This must be unique across all instances. More...

Public Member Functions
	MockMediaPlayer ()

	MOCK_METHOD1 (play, bool(SourceId))

	MOCK_METHOD1 (pause, bool(SourceId))

	MOCK_METHOD1 (resume, bool(SourceId))

	MOCK_METHOD3 (seekTo, bool(SourceId, std::chrono::milliseconds location, bool fromStart))

	MOCK_METHOD1 (stop, bool(SourceId))

	MOCK_METHOD2 (stop, bool(SourceId, std::chrono::seconds))

	MOCK_METHOD1 (getOffset, std::chrono::milliseconds(SourceId))

	MOCK_METHOD0 (getNumBytesBuffered, uint64_t())

	MOCK_METHOD1 (getMediaPlayerState, avsCommon::utils::Optional< avsCommon::utils::mediaPlayer::MediaPlayerState >(SourceId))

	MOCK_METHOD0 (getPlaybackAttributes, avsCommon::utils::Optional< PlaybackAttributes >())

	MOCK_METHOD0 (getPlaybackReports, std::vector< PlaybackReport >())

	MOCK_METHOD0 (getFingerprint, Optional< Fingerprint >())

	MOCK_METHOD2 (attachmentSetSource, SourceId(std::shared_ptr< avsCommon::avs::attachment::AttachmentReader > attachmentReader, const avsCommon::utils::AudioFormat *audioFormat))

	MOCK_METHOD2 (streamSetSource, SourceId(std::shared_ptr< std::istream > stream, bool repeat))

	MOCK_METHOD1 (urlSetSource, SourceId(const std::string &url))

SourceId	mockSetSource ()

bool	mockPlay (SourceId sourceId)

bool	mockPause (SourceId sourceId)

bool	mockResume (SourceId sourceId)

bool	mockStop (SourceId sourceId)

bool	mockStop2 (SourceId sourceId, std::chrono::seconds closePipleineTime)

bool	mockFinished (SourceId sourceId)

bool	mockError (SourceId sourceId)

bool	mockSetOffset (SourceId sourceId, std::chrono::milliseconds offset)

std::chrono::milliseconds	mockGetOffset (SourceId id)

avsCommon::utils::Optional< avsCommon::utils::mediaPlayer::MediaPlayerState >	mockGetState (SourceId id)

bool	mockSeek (SourceId sourceId, std::chrono::milliseconds location, bool fromStart)

void	resetWaitTimer ()

bool	waitUntilNextSetSource (const std::chrono::milliseconds timeout=std::chrono::milliseconds(DEFAULT_TIME))

bool	waitUntilPlaybackStarted (const std::chrono::milliseconds timeout=std::chrono::milliseconds(DEFAULT_TIME))

bool	waitUntilPlaybackStarted (SourceId id, const std::chrono::milliseconds timeout=std::chrono::milliseconds(DEFAULT_TIME))

bool	waitUntilPlaybackPaused (const std::chrono::milliseconds timeout=std::chrono::milliseconds(DEFAULT_TIME))

bool	waitUntilPlaybackResumed (const std::chrono::milliseconds timeout=std::chrono::milliseconds(DEFAULT_TIME))

bool	waitUntilPlaybackStopped (const std::chrono::milliseconds timeout=std::chrono::milliseconds(DEFAULT_TIME))

bool	waitUntilPlaybackFinished (const std::chrono::milliseconds timeout=std::chrono::milliseconds(DEFAULT_TIME))

bool	waitUntilPlaybackError (const std::chrono::milliseconds timeout=std::chrono::milliseconds(DEFAULT_TIME))

bool	waitUntilSeeked (const std::chrono::milliseconds timeout=std::chrono::milliseconds(DEFAULT_TIME))

SourceId	getCurrentSourceId ()

SourceId	getSourceId ()

SourceId	getLatestSourceId ()

std::unordered_set< std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface > >	getObservers () const

MediaPlayerInterface overrides
SourceId	setSource (std::shared_ptr< avsCommon::avs::attachment::AttachmentReader > attachmentReader, const avsCommon::utils::AudioFormat *audioFormat=nullptr, const SourceConfig &config=emptySourceConfig())

SourceId	setSource (std::shared_ptr< avsCommon::avs::attachment::AttachmentReader > attachmentReader, std::chrono::milliseconds offsetAdjustment, const avsCommon::utils::AudioFormat *audioFormat=nullptr, const SourceConfig &config=emptySourceConfig())

SourceId	setSource (const std::string &url, std::chrono::milliseconds offset=std::chrono::milliseconds::zero(), const SourceConfig &config=emptySourceConfig(), bool repeat=false, const PlaybackContext &playbackContext=PlaybackContext())

SourceId	setSource (std::shared_ptr< std::istream > stream, bool repeat=false, const SourceConfig &config=emptySourceConfig(), avsCommon::utils::MediaType format=avsCommon::utils::MediaType::UNKNOWN)

void	addObserver (std::shared_ptr< observer > playerObserver)

void	removeObserver (std::shared_ptr< observer > playerObserver)

RequiresShutdown overrides
void	doShutdown ()

Public Member Functions inherited from alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayerHelper
virtual SourceId	attachmentSetSource (std::shared_ptr< avsCommon::avs::attachment::AttachmentReader > attachmentReader, const avsCommon::utils::AudioFormat *audioFormat)=0

virtual SourceId	streamSetSource (std::shared_ptr< std::istream > stream, bool repeat)=0

virtual SourceId	urlSetSource (const std::string &url)=0

Public Member Functions inherited from alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface
virtual	~MediaPlayerInterface ()=default

virtual bool	play (SourceId id)=0

virtual bool	stop (SourceId id)=0

virtual bool	stop (SourceId id, std::chrono::seconds timeToPipelineShutdown)

virtual bool	pause (SourceId id)=0

virtual bool	resume (SourceId id)=0

virtual bool	seekTo (SourceId id, std::chrono::milliseconds location, bool fromStart)

virtual std::chrono::milliseconds	getOffset (SourceId id)=0

virtual uint64_t	getNumBytesBuffered ()=0

virtual utils::Optional< avsCommon::utils::mediaPlayer::MediaPlayerState >	getMediaPlayerState (SourceId id)=0

virtual void	addObserver (std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface > playerObserver)=0

virtual void	removeObserver (std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface > playerObserver)=0

virtual utils::Optional< PlaybackAttributes >	getPlaybackAttributes ()

virtual std::vector< PlaybackReport >	getPlaybackReports ()

virtual utils::Optional< Fingerprint >	getFingerprint ()

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::shared_ptr< testing::NiceMock< MockMediaPlayer > >	create ()

static void	enableConcurrentMediaPlayers ()

Additional Inherited Members
Static Public Attributes inherited from alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface
static const SourceId	ERROR = 0
	An `SourceId` used to represent an error from calls to `setSource()`. More...

Detailed Description

A mock MediaPlayer for unit tests.

Member Typedef Documentation

◆ MediaPlayerState

using alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MediaPlayerState = avsCommon::utils::mediaPlayer::MediaPlayerState

◆ observer

using alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::observer = avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface

Constructor & Destructor Documentation

◆ MockMediaPlayer()

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MockMediaPlayer ( )

Member Function Documentation

◆ addObserver()

void alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::addObserver ( std::shared_ptr< observer > playerObserver )

◆ create()

std::shared_ptr< NiceMock< MockMediaPlayer > > alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::create ( )

static

Creates an instance of the MockMediaPlayer.

Returns: An instance of the MockMediaPlayer.

◆ doShutdown()

void alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::doShutdown ( )

virtual

Prepares/enables this object to be deleted. This should be the last function called on this object prior to deleting (or resetting) its shared_ptr.

Warning

Attempting to call functions on this object after calling shutdown() can result in undefined behavior.
Neglecting to call shutdown() on this object can result in resource leaks or other undefined behavior.

Implements alexaClientSDK::avsCommon::utils::RequiresShutdown.

◆ enableConcurrentMediaPlayers()

void alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::enableConcurrentMediaPlayers ( )

static

Configures the MockMediaPlayer to support concurrent MediaPlayers. Concurrent players differ in that they don't assume that the last Player with 'setSource' called is the 'current' player. Instead, the last player on which 'play' was called is the current player. This is used in tests involving pre-buffering, where multiple players may have had 'setSource' called. The enabled state will persist until 'doShutdown' is called

◆ getCurrentSourceId()

MediaPlayerInterface::SourceId alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::getCurrentSourceId ( )

Get the SourceId for the media MockMediaPlayer is currently playing.

Returns: The SourceId for the media MockMediaPlayer is currently playing.

◆ getLatestSourceId()

MediaPlayerInterface::SourceId alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::getLatestSourceId ( )

Get the SourceId for the most recent MediaPlayer.setSource()

Returns: the SourceId for the MediaPlayer instance

◆ getObservers()

std::unordered_set< std::shared_ptr< MediaPlayerObserverInterface > > alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::getObservers ( ) const

Get the list of current observers.

Returns: List of current observers to this.

◆ getSourceId()

MediaPlayerInterface::SourceId alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::getSourceId ( )

Get the SourceId for this MediaPlayer instance

Returns: the SourceId for this MediaPlayer instance

◆ MOCK_METHOD0() [1/4]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD0	(	getNumBytesBuffered	,
		uint64_t()
	)

◆ MOCK_METHOD0() [2/4]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD0	(	getPlaybackAttributes	,
		avsCommon::utils::Optional< PlaybackAttributes >	()
	)

◆ MOCK_METHOD0() [3/4]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD0	(	getPlaybackReports	,
		std::vector< PlaybackReport >	()
	)

◆ MOCK_METHOD0() [4/4]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD0	(	getFingerprint	,
		Optional< Fingerprint >	()
	)

◆ MOCK_METHOD1() [1/7]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD1	(	play	,
		bool(SourceId)
	)

◆ MOCK_METHOD1() [2/7]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD1	(	pause	,
		bool(SourceId)
	)

◆ MOCK_METHOD1() [3/7]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD1	(	resume	,
		bool(SourceId)
	)

◆ MOCK_METHOD1() [4/7]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD1	(	stop	,
		bool(SourceId)
	)

◆ MOCK_METHOD1() [5/7]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD1	(	getOffset	,
		std::chrono::milliseconds(SourceId)
	)

◆ MOCK_METHOD1() [6/7]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD1	(	getMediaPlayerState	,
		avsCommon::utils::Optional< avsCommon::utils::mediaPlayer::MediaPlayerState >	SourceId
	)

◆ MOCK_METHOD1() [7/7]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD1	(	urlSetSource	,
		SourceId(const std::string &url)
	)

◆ MOCK_METHOD2() [1/3]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD2	(	stop	,
		bool(SourceId, std::chrono::seconds)
	)

◆ MOCK_METHOD2() [2/3]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD2	(	attachmentSetSource	,
		SourceId(std::shared_ptr< avsCommon::avs::attachment::AttachmentReader > attachmentReader, const avsCommon::utils::AudioFormat *audioFormat)
	)

◆ MOCK_METHOD2() [3/3]

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD2	(	streamSetSource	,
		SourceId(std::shared_ptr< std::istream > stream, bool repeat)
	)

◆ MOCK_METHOD3()

alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::MOCK_METHOD3	(	seekTo	,
		bool(SourceId, std::chrono::milliseconds location, bool fromStart)
	)

◆ mockError()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockError ( SourceId sourceId )

This is a mock method which will send the onPlaybackError() notification to the observer.

Returns: Whether the operation was successful.

◆ mockFinished()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockFinished ( SourceId sourceId )

This is a mock method which will send the onPlaybackFinished() notification to the observer.

Returns: Whether the operation was successful.

◆ mockGetOffset()

std::chrono::milliseconds alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockGetOffset ( SourceId id )

This is a mock method which validates the id in a getOffset() call.

◆ mockGetState()

Optional< avsCommon::utils::mediaPlayer::MediaPlayerState > alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockGetState ( SourceId id )

This is a mock method which gives the sourceId and the offset through getOffset()

◆ mockPause()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockPause ( SourceId sourceId )

This is a mock method which will send the onPlaybackPaused() notification to the observer.

Returns: Whether the operation was successful.

◆ mockPlay()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockPlay ( SourceId sourceId )

This is a mock method which will send the onPlaybackStarted() notification to the observer.

Returns: Whether the operation was successful.

◆ mockResume()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockResume ( SourceId sourceId )

This is a mock method which will send the onPlaybackResumed() notification to the observer.

Returns: Whether the operation was successful.

◆ mockSeek()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockSeek	(	SourceId	sourceId,
		std::chrono::milliseconds	location,
		bool	fromStart
	)

This is a mock method which will send a onPlaybackStarted() notification to the observer, with updated offset

Returns: Whether the operation was successful.

◆ mockSetOffset()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockSetOffset	(	SourceId	sourceId,
		std::chrono::milliseconds	offset
	)

This is a mock method which validates sourceId and if valid, sets the offset.

◆ mockSetSource()

MediaPlayerInterface::SourceId alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockSetSource ( )

This is a mock method which will generate a new SourceId.

Returns: SUCCESS.

◆ mockStop()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockStop ( SourceId sourceId )

This is a mock method which will send the onPlaybackStopped() notification to the observer.

Returns: Whether the operation was successful.

◆ mockStop2()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::mockStop2	(	SourceId	sourceId,
		std::chrono::seconds	closePipleineTime
	)

This is a mock method which will send the onPlaybackStopped() notification to the observer.

Returns: Whether the operation was successful.

◆ removeObserver()

void alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::removeObserver ( std::shared_ptr< observer > playerObserver )

◆ resetWaitTimer()

void alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::resetWaitTimer ( )

Reset the timer used in the following waitXXX methods. Used to test resuming

◆ setSource() [1/4]

MediaPlayerInterface::SourceId alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::setSource	(	std::shared_ptr< avsCommon::avs::attachment::AttachmentReader >	attachmentReader,
		const avsCommon::utils::AudioFormat *	format = `nullptr`,
		const SourceConfig &	config = `emptySourceConfig()`
	)

virtual

Set an AttachmentReader source to play. The source should be set before making calls to any of the playback control APIs. If any source was set prior to this call, that source will be discarded.

Note: A MediaPlayerInterface implementation must handle only one source at a time. An implementation must call MediaPlayerObserverInterface::onPlaybackStopped() with the previous source's id if there was a source set. Also, an implementation must call MediaPlayerObserverInterface::onBufferingComplete() when this source has been fully buffered

Parameters

attachmentReader	Object with which to read an incoming audio attachment.
format	The audioFormat to be used to interpret raw audio data.
config	Media configuration of source.

Returns: The SourceId that represents the source being handled as a result of this call. ERROR will be returned if the source failed to be set. Must be unique across all instances.

Implements alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface.

◆ setSource() [2/4]

MediaPlayerInterface::SourceId alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::setSource	(	std::shared_ptr< avsCommon::avs::attachment::AttachmentReader >	attachmentReader,
		std::chrono::milliseconds	offsetAdjustment,
		const avsCommon::utils::AudioFormat *	format = `nullptr`,
		const SourceConfig &	config = `emptySourceConfig()`
	)

virtual

Set an AttachmentReader source to play. The source should be set before making calls to any of the playback control APIs. If any source was set prior to this call, that source will be discarded.

Note: A MediaPlayerInterface implementation must handle only one source at a time. An implementation must call MediaPlayerObserverInterface::onPlaybackStopped() with the previous source's id if there was a source set. Also, an implementation must call MediaPlayerObserverInterface::onBufferingComplete() when this source has been fully buffered

Parameters

attachmentReader	Object with which to read an incoming audio attachment.
format	The audioFormat to be used to interpret raw audio data.
offsetAdjustment	Offset adjustment required for the offset reported
config	Media configuration of source.

Returns: The SourceId that represents the source being handled as a result of this call. ERROR will be returned if the source failed to be set. Must be unique across all instances.

Implements alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface.

◆ setSource() [3/4]

MediaPlayerInterface::SourceId alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::setSource	(	const std::string &	url,
		std::chrono::milliseconds	offset = `std::chrono::milliseconds::zero()`,
		const SourceConfig &	config = `emptySourceConfig()`,
		bool	repeat = `false`,
		const PlaybackContext &	playbackContext = `PlaybackContext()`
	)

virtual

Set a url source to play. The source should be set before making calls to any of the playback control APIs. If any source was set prior to this call, that source will be discarded.

Note: A MediaPlayerInterface implementation must handle only one source at a time. An implementation must call MediaPlayerObserverInterface::onPlaybackStopped() with the previous source's id if there was a source set. Also, an implementation must call MediaPlayerObserverInterface::onBufferingComplete() when this source has been fully buffered

Parameters

url	The url to set as the source.
offset	An optional offset parameter to start playing from when a `play()` call is made.
config	Media configuration of source.
repeat	An optional parameter to play the url source in a loop.
playbackContext	An optional parameter used for sending headers needed for data requests.

Returns: The SourceId that represents the source being handled as a result of this call. ERROR will be returned if the source failed to be set. Must be unique across all instances.

Implements alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface.

Reimplemented in alexaClientSDK::acsdkAlerts::renderer::test::TestMediaPlayer.

◆ setSource() [4/4]

MediaPlayerInterface::SourceId alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::setSource	(	std::shared_ptr< std::istream >	stream,
		bool	repeat = `false`,
		const SourceConfig &	config = `emptySourceConfig()`,
		avsCommon::utils::MediaType	format = `avsCommon::utils::MediaType::UNKNOWN`
	)

virtual

Set an istream source to play. The source should be set before making calls to any of the playback control APIs. If any source was set prior to this call, that source will be discarded.

Note: A MediaPlayerInterface implementation must handle only one source at a time. An implementation must call MediaPlayerObserverInterface::onPlaybackStopped() with the previous source's id if there was a source set. Also, an implementation must call MediaPlayerObserverInterface::onBufferingComplete() when this source has been fully buffered

Parameters

stream	Object from which to read an incoming audio stream.
repeat	Whether the audio stream should be played in a loop until stopped.
config	Media configuration of source.
format	The `MediaType` audio encoding format of the incoming audio stream.

Returns: The SourceId that represents the source being handled as a result of this call. ERROR will be returned if the source failed to be set. Must be unique across all instances.

Implements alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface.

Reimplemented in alexaClientSDK::acsdkAlerts::renderer::test::TestMediaPlayer.

◆ waitUntilNextSetSource()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::waitUntilNextSetSource ( const std::chrono::milliseconds timeout = std::chrono::milliseconds(DEFAULT_TIME) )

Waits for the next call to setSource(). When concurrentMediaPlayers are enabled, this function will wait for the next call to any instance's setSource()

Parameters

timeout The maximum time to wait.

Returns: true if setSource was called within timeout milliseconds else false.

◆ waitUntilPlaybackError()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::waitUntilPlaybackError ( const std::chrono::milliseconds timeout = std::chrono::milliseconds(DEFAULT_TIME) )

Waits for the current source to reach the playback error state.

Parameters

timeout The maximum time to wait.

Returns: true if the state was reached within timeout milliseconds else false.

◆ waitUntilPlaybackFinished()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::waitUntilPlaybackFinished ( const std::chrono::milliseconds timeout = std::chrono::milliseconds(DEFAULT_TIME) )

Waits for the current source to reach the playback finished state.

Parameters

timeout The maximum time to wait.

Returns: true if the state was reached within timeout milliseconds else false.

◆ waitUntilPlaybackPaused()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::waitUntilPlaybackPaused ( const std::chrono::milliseconds timeout = std::chrono::milliseconds(DEFAULT_TIME) )

Waits for the current source to reach the playback paused state.

Parameters

timeout The maximum time to wait.

Returns: true if the state was reached within timeout milliseconds else false.

◆ waitUntilPlaybackResumed()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::waitUntilPlaybackResumed ( const std::chrono::milliseconds timeout = std::chrono::milliseconds(DEFAULT_TIME) )

Waits for the current source to reach the playback resumed state.

Parameters

timeout The maximum time to wait.

Returns: true if the state was reached within timeout milliseconds else false.

◆ waitUntilPlaybackStarted() [1/2]

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::waitUntilPlaybackStarted ( const std::chrono::milliseconds timeout = std::chrono::milliseconds(DEFAULT_TIME) )

Waits for the current source to reach the playback started state. This is only valid when concurrentMediaPlayers are not enabled.

Parameters

timeout The maximum time to wait.

Returns: true if the state was reached within timeout milliseconds else false.

◆ waitUntilPlaybackStarted() [2/2]

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::waitUntilPlaybackStarted	(	SourceId	id,
		const std::chrono::milliseconds	timeout = `std::chrono::milliseconds(DEFAULT_TIME)`
	)

Waits for a source to reach the playback started state.

Parameters

timeout	The maximum time to wait.
is	The SourceId of the track waiting to Play

Returns: true if the state was reached within timeout milliseconds else false.

◆ waitUntilPlaybackStopped()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::waitUntilPlaybackStopped ( const std::chrono::milliseconds timeout = std::chrono::milliseconds(DEFAULT_TIME) )

Waits for the current source to reach the playback stopped state.

Parameters

timeout The maximum time to wait.

Returns: true if the state was reached within timeout milliseconds else false.

◆ waitUntilSeeked()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::test::MockMediaPlayer::waitUntilSeeked ( const std::chrono::milliseconds timeout = std::chrono::milliseconds(DEFAULT_TIME) )

Waits for the current source to reach the seek complete state.

Parameters

timeout The maximum time to wait.

Returns: true if the state was reached within timeout milliseconds else false.

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

/workplace/avs-device-sdk/AVSCommon/Utils/test/AVSCommon/Utils/MediaPlayer/MockMediaPlayer.h
/workplace/avs-device-sdk/AVSCommon/Utils/test/Common/MockMediaPlayer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MediaPlayerState

◆ observer

Constructor & Destructor Documentation

◆ MockMediaPlayer()

Member Function Documentation

◆ addObserver()

◆ create()

◆ doShutdown()

◆ enableConcurrentMediaPlayers()

◆ getCurrentSourceId()

◆ getLatestSourceId()

◆ getObservers()

◆ getSourceId()

◆ MOCK_METHOD0() [1/4]

◆ MOCK_METHOD0() [2/4]

◆ MOCK_METHOD0() [3/4]

◆ MOCK_METHOD0() [4/4]

◆ MOCK_METHOD1() [1/7]

◆ MOCK_METHOD1() [2/7]

◆ MOCK_METHOD1() [3/7]

◆ MOCK_METHOD1() [4/7]

◆ MOCK_METHOD1() [5/7]

◆ MOCK_METHOD1() [6/7]

◆ MOCK_METHOD1() [7/7]

◆ MOCK_METHOD2() [1/3]

◆ MOCK_METHOD2() [2/3]

◆ MOCK_METHOD2() [3/3]

◆ MOCK_METHOD3()

◆ mockError()

◆ mockFinished()

◆ mockGetOffset()

◆ mockGetState()

◆ mockPause()

◆ mockPlay()

◆ mockResume()

◆ mockSeek()

◆ mockSetOffset()

◆ mockSetSource()

◆ mockStop()

◆ mockStop2()

◆ removeObserver()

◆ resetWaitTimer()

◆ setSource() [1/4]

◆ setSource() [2/4]

◆ setSource() [3/4]

◆ setSource() [4/4]

◆ waitUntilNextSetSource()

◆ waitUntilPlaybackError()

◆ waitUntilPlaybackFinished()

◆ waitUntilPlaybackPaused()

◆ waitUntilPlaybackResumed()

◆ waitUntilPlaybackStarted() [1/2]

◆ waitUntilPlaybackStarted() [2/2]

◆ waitUntilPlaybackStopped()

◆ waitUntilSeeked()