shaka::media::Renderer Class Reference

#include <renderer.h>

Inheritance diagram for shaka::media::Renderer:

Public Member Functions
	Renderer ()
virtual	~ Renderer ()
	Renderer (const Renderer &)=delete
Renderer &	operator= (const Renderer &)=delete
	Renderer (Renderer &&)=delete
Renderer &	operator= (Renderer &&)=delete
virtual void	SetPlayer (const MediaPlayer *player)=0
virtual void	Attach (const DecodedStream *stream)=0
virtual void	Detach ()=0

Detailed Description

Defines an interface for rendering. This type will handle pulling frames from a DecodedStream object and rendering them to their destination. This is expected to periodically pull frames as needed to render, which may require spawning background threads.

Methods on this object should not be called by the app; these will be handled by the DefaultMediaPlayer. Methods on this object can be called from any thread.

Definition at line 37 of file renderer.h.

Constructor & Destructor Documentation

Renderer() [1/3]

shaka::media::Renderer::Renderer

(

)

~ Renderer()

virtual shaka::media::Renderer::~ Renderer ( )

virtual

Renderer() [2/3]

shaka::media::Renderer::Renderer ( const Renderer &  )

delete

Renderer() [3/3]

shaka::media::Renderer::Renderer ( Renderer &&  )

delete

Member Function Documentation

Attach()

virtual void shaka::media::Renderer::Attach ( const DecodedStream *  stream )

pure virtual

Attaches to the given stream. This object will now pull full-frames from the given stream to play content. The stream will live as long as this object, or until a call to Detach.

Parameters

stream

The stream to pull frames from.

Implemented in shaka::media::SdlManualVideoRenderer, shaka::media::AudioRendererCommon, shaka::media::AppleVideoRenderer, shaka::media::SdlAudioRenderer, shaka::media::VideoRendererCommon, and shaka::media::AppleAudioRenderer.

Detach()

virtual void shaka::media::Renderer::Detach ( )

pure virtual

Detaches playback from the current stream. The current stream will no longer be used to play content.

Implemented in shaka::media::SdlAudioRenderer::Impl, shaka::media::SdlManualVideoRenderer, shaka::media::AudioRendererCommon, shaka::media::AppleVideoRenderer, shaka::media::SdlAudioRenderer, shaka::media::VideoRendererCommon, and shaka::media::AppleAudioRenderer.

operator=() [1/2]

Renderer& shaka::media::Renderer::operator= ( Renderer &&  )

delete

operator=() [2/2]

Renderer& shaka::media::Renderer::operator= ( const Renderer &  )

delete

SetPlayer()

virtual void shaka::media::Renderer::SetPlayer ( const MediaPlayer *  player )

pure virtual

Sets the MediaPlayer that is controlling this renderer. This will be used by the Renderer to query the current time and playback state.

Parameters

player

The MediaPlayer instance controlling this object.

Implemented in shaka::media::SdlManualVideoRenderer, shaka::media::AudioRendererCommon, shaka::media::AppleVideoRenderer, shaka::media::SdlAudioRenderer, shaka::media::VideoRendererCommon, and shaka::media::AppleAudioRenderer.

---

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

• shaka/include/shaka/media/renderer.h