shaka::media::SdlAudioRenderer Class Reference

#include <sdl_audio_renderer.h>

Inheritance diagram for shaka::media::SdlAudioRenderer:

Classes
class	Impl

Public Member Functions
	SdlAudioRenderer (const std::string &device_name)
	~SdlAudioRenderer () override
void	SetPlayer (const MediaPlayer *player) override
void	Attach (const DecodedStream *stream) override
void	Detach () override
double	Volume () const override
void	SetVolume (double volume) override
bool	Muted () const override
void	SetMuted (bool muted) override
Public Member Functions inherited from shaka::media::Renderer
	Renderer ()
virtual	~ Renderer ()
	Renderer (const Renderer &)=delete
Renderer &	operator= (const Renderer &)=delete
	Renderer (Renderer &&)=delete
Renderer &	operator= (Renderer &&)=delete

Static Public Member Functions
static std::vector< std::string >	ListDevices ()

Detailed Description

Defines an audio renderer that renders frames to the given SDL audio device.

Definition at line 33 of file sdl_audio_renderer.h.

Constructor & Destructor Documentation

SdlAudioRenderer()

shaka::media::SdlAudioRenderer::SdlAudioRenderer

(

const std::string &

device_name

)

Creates a new audio renderer that plays using the given SDL audio device. Can pass the empty string to use the default device.

Definition at line 173 of file sdl_audio_renderer.cc.

~SdlAudioRenderer()

shaka::media::SdlAudioRenderer::~SdlAudioRenderer ( )

override

Definition at line 175 of file sdl_audio_renderer.cc.

Member Function Documentation

Attach()

void shaka::media::SdlAudioRenderer::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

stream

The stream to pull frames from.

Implements shaka::media::Renderer.

Definition at line 190 of file sdl_audio_renderer.cc.

Detach()

void shaka::media::SdlAudioRenderer::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 193 of file sdl_audio_renderer.cc.

ListDevices()

std::vector< std::string > shaka::media::SdlAudioRenderer::ListDevices ( )

static

Returns a vector containing all possible audio devices. Other values may be valid based on the system. See SDL documentation for more info.

Definition at line 177 of file sdl_audio_renderer.cc.

Muted()

bool shaka::media::SdlAudioRenderer::Muted ( ) const

overridevirtual

Returns

Whether the audio is muted.

Implements shaka::media::AudioRenderer.

Definition at line 203 of file sdl_audio_renderer.cc.

SetMuted()

void shaka::media::SdlAudioRenderer::SetMuted ( bool  muted )

overridevirtual

Sets whether the audio is muted.

Implements shaka::media::AudioRenderer.

Definition at line 206 of file sdl_audio_renderer.cc.

SetPlayer()

void shaka::media::SdlAudioRenderer::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

player

The MediaPlayer instance controlling this object.

Implements shaka::media::Renderer.

Definition at line 187 of file sdl_audio_renderer.cc.

SetVolume()

void shaka::media::SdlAudioRenderer::SetVolume ( double  volume )

overridevirtual

Sets the volume [0, 1] to render audio at.

Implements shaka::media::AudioRenderer.

Definition at line 200 of file sdl_audio_renderer.cc.

Volume()

double shaka::media::SdlAudioRenderer::Volume ( ) const

overridevirtual

Returns

The current volume [0, 1].

Implements shaka::media::AudioRenderer.

Definition at line 197 of file sdl_audio_renderer.cc.

---

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

• shaka/include/shaka/media/sdl_audio_renderer.h
• shaka/src/media/sdl_audio_renderer.cc