MixerOptions::Warp Struct Reference

Immutable structure is an argument to Mixer's constructor. More...

#include <MixerOptions.h>

Collaboration diagram for MixerOptions::Warp:

Classes
struct	DefaultWarp
	Hook function for default time warp. More...

Public Member Functions
	Warp (const AudacityProject *pProject)
	Construct using the default warp function. More...
	Warp (const BoundedEnvelope *e)
	Construct with an explicit warp. More...
	Warp (double min, double max, double initial=1.0)
	Construct with no time warp. More...

Public Attributes
const BoundedEnvelope *const	envelope = nullptr
const double	minSpeed
const double	maxSpeed
const double	initialSpeed { 1.0 }

Detailed Description

Immutable structure is an argument to Mixer's constructor.

Definition at line 56 of file MixerOptions.h.

Constructor & Destructor Documentation

Warp() [1/3]

MixerOptions::Warp::Warp ( const AudacityProject *  pProject )

explicit

Construct using the default warp function.

Definition at line 18 of file MixerOptions.cpp.

: envelope(DefaultWarp::Call(pProject)), minSpeed(0.0), maxSpeed(0.0)
{
}

Warp() [2/3]

MixerOptions::Warp::Warp ( const BoundedEnvelope *  e )

explicit

Construct with an explicit warp.

Definition at line 23 of file MixerOptions.cpp.

    : envelope(e), minSpeed(0.0), maxSpeed(0.0)
 {}

Warp() [3/3]

MixerOptions::Warp::Warp	(	double	min,
		double	max,
		double	initial = 1.0
	)

Construct with no time warp.

Precondition

min >= 0

max >= 0

min <= max

Definition at line 27 of file MixerOptions.cpp.

   : minSpeed{ std::max(0.0, std::min(min, max)) }
   , maxSpeed{ std::max(0.0, std::max(min, max)) }
   , initialSpeed{initial}
{
   assert(min >= 0);
   assert(max >= 0);
   assert(min <= max);
}

References min().

Here is the call graph for this function:

Member Data Documentation

envelope

const BoundedEnvelope* const MixerOptions::Warp::envelope = nullptr

Definition at line 76 of file MixerOptions.h.

Referenced by MixerOptions::ResampleParameters::ResampleParameters().

initialSpeed

const double MixerOptions::Warp::initialSpeed { 1.0 }

Definition at line 78 of file MixerOptions.h.

maxSpeed

const double MixerOptions::Warp::maxSpeed

Definition at line 77 of file MixerOptions.h.

Referenced by MixerOptions::ResampleParameters::ResampleParameters().

minSpeed

const double MixerOptions::Warp::minSpeed

Definition at line 77 of file MixerOptions.h.

Referenced by MixerOptions::ResampleParameters::ResampleParameters().

---

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

• MixerOptions.h
• MixerOptions.cpp