SkAudioPlayer Class Reference

#include <SkAudioPlayer.h>

Public Types
enum class	State { kPlaying , kStopped , kPaused }

Public Member Functions
virtual	~SkAudioPlayer ()
double	duration () const
double	time () const
double	setTime (double)
double	normalizedTime () const
double	setNormalizedTime (double t)
State	state () const
float	volume () const
float	rate () const
State	setState (State)
float	setRate (float)
float	setVolume (float)
void	play ()
void	pause ()
void	stop ()
bool	isPlaying () const
bool	isPaused () const
bool	isStopped () const

Static Public Member Functions
static std::unique_ptr< SkAudioPlayer >	Make (sk_sp< SkData >)

Protected Member Functions
	SkAudioPlayer ()
virtual double	onGetDuration () const =0
virtual double	onGetTime () const =0
virtual double	onSetTime (double)=0
virtual State	onSetState (State)=0
virtual float	onSetRate (float)=0
virtual float	onSetVolume (float)=0

Detailed Description

Definition at line 12 of file SkAudioPlayer.h.

Member Enumeration Documentation

State

enum class SkAudioPlayer::State

strong

Enumerator
kPlaying
kStopped
kPaused

Definition at line 27 of file SkAudioPlayer.h.

                     {
        kPlaying,
        kStopped,
        kPaused,
    };

Constructor & Destructor Documentation

~SkAudioPlayer()

SkAudioPlayer::~SkAudioPlayer ( )

virtual

Definition at line 12 of file SkAudioPlayer.cpp.

{}

SkAudioPlayer()

SkAudioPlayer::SkAudioPlayer ( )

inlineprotected

Definition at line 49 of file SkAudioPlayer.h.

{}    // only called by subclasses

Member Function Documentation

duration()

double SkAudioPlayer::duration ( ) const

inline

Definition at line 20 of file SkAudioPlayer.h.

{ return this->onGetDuration(); }

isPaused()

bool SkAudioPlayer::isPaused ( ) const

inline

Definition at line 45 of file SkAudioPlayer.h.

{ return this->state() == State::kPaused; }

isPlaying()

bool SkAudioPlayer::isPlaying ( ) const

inline

Definition at line 44 of file SkAudioPlayer.h.

{ return this->state() == State::kPlaying; }

isStopped()

bool SkAudioPlayer::isStopped ( ) const

inline

Definition at line 46 of file SkAudioPlayer.h.

{ return this->state() == State::kStopped; }

Make()

std::unique_ptr< SkAudioPlayer > SkAudioPlayer::Make ( sk_sp< SkData >  src )

static

Definition at line 11 of file SkAudioPlayer_none.cpp.

                                                                  {
    return nullptr;
}

normalizedTime()

double SkAudioPlayer::normalizedTime ( ) const

inline

Definition at line 24 of file SkAudioPlayer.h.

{ return this->time() / this->duration(); }

onGetDuration()

virtual double SkAudioPlayer::onGetDuration ( ) const

protectedpure virtual

onGetTime()

virtual double SkAudioPlayer::onGetTime ( ) const

protectedpure virtual

onSetRate()

virtual float SkAudioPlayer::onSetRate ( float  )

protectedpure virtual

onSetState()

virtual State SkAudioPlayer::onSetState ( State  )

protectedpure virtual

onSetTime()

virtual double SkAudioPlayer::onSetTime ( double  )

protectedpure virtual

onSetVolume()

virtual float SkAudioPlayer::onSetVolume ( float  )

protectedpure virtual

pause()

void SkAudioPlayer::pause ( )

inline

Definition at line 41 of file SkAudioPlayer.h.

{ this->setState(State::kPaused); }

play()

void SkAudioPlayer::play ( )

inline

Definition at line 40 of file SkAudioPlayer.h.

{ this->setState(State::kPlaying); }

rate()

float SkAudioPlayer::rate ( ) const

inline

Definition at line 34 of file SkAudioPlayer.h.

{ return fRate; }      // multiplier (e.g. 1.0 is default)

setNormalizedTime()

double SkAudioPlayer::setNormalizedTime

(

double

t

)

Definition at line 25 of file SkAudioPlayer.cpp.

                                                {
    this->setTime(t * this->duration());
    return this->normalizedTime();
}

setRate()

float SkAudioPlayer::setRate

(

float

r

)

Definition at line 37 of file SkAudioPlayer.cpp.

                                    {
    r = std::min(std::max(r, 0.f), 1.f);
    if (!std::isfinite(r)) {
        r = fRate;
    }
    if (r != fRate) {
        fRate = this->onSetRate(r);
    }
    return fRate;
}

setState()

SkAudioPlayer::State SkAudioPlayer::setState

(

State

s

)

Definition at line 30 of file SkAudioPlayer.cpp.

                                                  {
    if (s != fState) {
        fState = this->onSetState(s);
    }
    return fState;
}

setTime()

double SkAudioPlayer::setTime

(

double

t

)

Definition at line 14 of file SkAudioPlayer.cpp.

                                      {
    t = std::min(std::max(t, 0.0), this->duration());
    if (!std::isfinite(t)) {
        t = this->time();
    }
    if (t != this->time()) {
        t = this->onSetTime(t);
    }
    return t;
}

setVolume()

float SkAudioPlayer::setVolume

(

float

v

)

Definition at line 48 of file SkAudioPlayer.cpp.

                                      {
    v = std::min(std::max(v, 0.f), 1.f);
    if (!std::isfinite(v)) {
        v = fVolume;
    }
    if (v != fVolume) {
        fVolume = this->onSetVolume(v);
    }
    return fVolume;
}

state()

State SkAudioPlayer::state ( ) const

inline

Definition at line 32 of file SkAudioPlayer.h.

{ return fState; }

stop()

void SkAudioPlayer::stop ( )

inline

Definition at line 42 of file SkAudioPlayer.h.

{ this->setState(State::kStopped); }

time()

double SkAudioPlayer::time ( ) const

inline

Definition at line 21 of file SkAudioPlayer.h.

{ return this->onGetTime(); }   // 0...duration()

volume()

float SkAudioPlayer::volume ( ) const

inline

Definition at line 33 of file SkAudioPlayer.h.

{ return fVolume; }    // 0...1

---

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

• third_party/skia/modules/audioplayer/SkAudioPlayer.h
• third_party/skia/modules/audioplayer/SkAudioPlayer.cpp
• third_party/skia/modules/audioplayer/SkAudioPlayer_none.cpp
• third_party/skia/modules/audioplayer/SkAudioPlayer_oboe.cpp
• third_party/skia/modules/audioplayer/SkAudioPlayer_sfml.cpp