Sayonara Player
Public Types | Public Member Functions | Protected Member Functions | List of all members
Pipeline::CrossFader Class Referenceabstract

#include <Crossfader.h>

Detailed Description

The CrossFader class.

Public Types

enum  FadeMode : unsigned char {
  NoFading =0,
  FadeIn,
  FadeOut
}
 

Public Member Functions

virtual double get_current_volume () const =0
 get current volume of pipeline More...
 
virtual void set_current_volume (double vol)=0
 set current volume of pipeline More...
 
uint64_t get_fading_time_ms () const
 get fading time in ms More...
 
void fade_in ()
 start to fade in
 
void fade_out ()
 start to fade out
 
bool is_fading_out () const
 
bool is_fading_int () const
 
void fader_timed_out ()
 function is called periodically. This function should not be used from outside TODO
 

Protected Member Functions

void abort_fader ()
 
virtual void stop ()=0
 
virtual void play ()=0
 

Member Function Documentation

◆ get_current_volume()

virtual double Pipeline::CrossFader::get_current_volume ( ) const
pure virtual

get current volume of pipeline

Returns
value between 0 and 1.0

Implemented in Pipeline::Playback.

◆ get_fading_time_ms()

uint64_t Pipeline::CrossFader::get_fading_time_ms ( ) const

get fading time in ms

Returns
fading time in ms

◆ set_current_volume()

virtual void Pipeline::CrossFader::set_current_volume ( double  vol)
pure virtual

set current volume of pipeline

Parameters
volvalue between 0 and 1.0

Implemented in Pipeline::Playback.

Inheritance diagram for Pipeline::CrossFader:
Pipeline::Playback