Shaka Player Embedded
Classes | Public Member Functions | List of all members
shaka::media::AppleVideoRenderer Class Referencefinal

#include <apple_video_renderer.h>

Inheritance diagram for shaka::media::AppleVideoRenderer:
shaka::media::VideoRenderer shaka::media::Renderer

Classes

class  Impl
 

Public Member Functions

 AppleVideoRenderer ()
 
 ~AppleVideoRenderer () override
 
VideoFillMode fill_mode () const
 
CGImageRef Render (double *delay=nullptr, Rational< uint32_t > *sample_aspect_ratio=nullptr)
 
void SetPlayer (const MediaPlayer *player) override
 
void Attach (const DecodedStream *stream) override
 
void Detach () override
 
struct VideoPlaybackQuality VideoPlaybackQuality () const override
 
bool SetVideoFillMode (VideoFillMode mode) override
 
- Public Member Functions inherited from shaka::media::Renderer
 Renderer ()
 
virtual ~ Renderer ()
 
 Renderer (const Renderer &)=delete
 
Rendereroperator= (const Renderer &)=delete
 
 Renderer (Renderer &&)=delete
 
Rendereroperator= (Renderer &&)=delete
 

Detailed Description

Defines a video renderer that renders to a CGImageRef.

Definition at line 34 of file apple_video_renderer.h.

Constructor & Destructor Documentation

§ AppleVideoRenderer()

shaka::media::AppleVideoRenderer::AppleVideoRenderer ( )

Definition at line 172 of file apple_video_renderer.cc.

§ ~AppleVideoRenderer()

shaka::media::AppleVideoRenderer::~AppleVideoRenderer ( )
override

Definition at line 173 of file apple_video_renderer.cc.

Member Function Documentation

§ Attach()

void shaka::media::AppleVideoRenderer::Attach ( const DecodedStream stream)
overridevirtual

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
streamThe stream to pull frames from.

Implements shaka::media::Renderer.

Definition at line 188 of file apple_video_renderer.cc.

§ Detach()

void shaka::media::AppleVideoRenderer::Detach ( )
overridevirtual

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

Implements shaka::media::Renderer.

Definition at line 192 of file apple_video_renderer.cc.

§ fill_mode()

VideoFillMode shaka::media::AppleVideoRenderer::fill_mode ( ) const
Returns
The current video fill mode.

Definition at line 175 of file apple_video_renderer.cc.

§ Render()

CGImageRef shaka::media::AppleVideoRenderer::Render ( double *  delay = nullptr,
Rational< uint32_t > *  sample_aspect_ratio = nullptr 
)

Renders the current video frame to a new image. This will return nullptr while seeking or if the current frame is the same as the previous call. In these cases, the previous drawn frame should be kept.

This follows the CREATE rule.

Parameters
delay[OUT] Optional, if given, will be filled with the delay, in seconds, until the next call to Render should be made.
sample_aspect_ratio[OUT] Optional, if given, will be filled with the sample aspect ratio of the image.

Definition at line 179 of file apple_video_renderer.cc.

§ SetPlayer()

void shaka::media::AppleVideoRenderer::SetPlayer ( const MediaPlayer player)
overridevirtual

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

Parameters
playerThe MediaPlayer instance controlling this object.

Implements shaka::media::Renderer.

Definition at line 184 of file apple_video_renderer.cc.

§ SetVideoFillMode()

bool shaka::media::AppleVideoRenderer::SetVideoFillMode ( VideoFillMode  mode)
overridevirtual

§ VideoPlaybackQuality()

VideoPlaybackQuality shaka::media::AppleVideoRenderer::VideoPlaybackQuality ( ) const
overridevirtual

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