AudioIOStartStreamOptions Class Reference

struct holding stream options, including a pointer to the time warp info and AudioIOListener and whether the playback is looped. More...

#include <AudioIOBase.h>

Collaboration diagram for AudioIOStartStreamOptions:

Public Types
using	PolicyFactory = std::function< std::unique_ptr< PlaybackPolicy >(const AudioIOStartStreamOptions &) >

Public Member Functions
	AudioIOStartStreamOptions (const std::shared_ptr< AudacityProject > &pProject={}, double rate_=44100.0)

Public Attributes
std::shared_ptr< AudacityProject >	pProject
std::weak_ptr< Meter >	captureMeter
std::weak_ptr< Meter >	playbackMeter
const BoundedEnvelope *	envelope {}
std::shared_ptr< AudioIOListener >	listener
double	rate
std::optional< double >	pStartTime
double	preRoll { 0.0 }
bool	playNonWaveTracks { true }
PRCrossfadeData *	pCrossfadeData {}
std::function< std::chrono::milliseconds() >	playbackStreamPrimer
PolicyFactory	policyFactory
bool	loopEnabled { false }
bool	variableSpeed { false }

Detailed Description

struct holding stream options, including a pointer to the time warp info and AudioIOListener and whether the playback is looped.

Definition at line 45 of file AudioIOBase.h.

Member Typedef Documentation

PolicyFactory

using AudioIOStartStreamOptions::PolicyFactory = std::function< std::unique_ptr<PlaybackPolicy>(const AudioIOStartStreamOptions&) >

Definition at line 73 of file AudioIOBase.h.

Constructor & Destructor Documentation

AudioIOStartStreamOptions()

AudioIOStartStreamOptions::AudioIOStartStreamOptions ( const std::shared_ptr< AudacityProject > &  pProject = {}, double  rate_ = 44100.0  )

inlineexplicit

Definition at line 48 of file AudioIOBase.h.

                                                       {},
      double rate_ = 44100.0
   )  : pProject{ pProject }
      , rate(rate_)
   {}

Member Data Documentation

captureMeter

std::weak_ptr<Meter> AudioIOStartStreamOptions::captureMeter

Definition at line 56 of file AudioIOBase.h.

Referenced by AudioIO::StartPortAudioStream().

envelope

const BoundedEnvelope* AudioIOStartStreamOptions::envelope {}

Definition at line 57 of file AudioIOBase.h.

Referenced by PlaybackSchedule::Init().

listener

std::shared_ptr< AudioIOListener > AudioIOStartStreamOptions::listener

Definition at line 58 of file AudioIOBase.h.

Referenced by AudioIO::StartStream().

loopEnabled

bool AudioIOStartStreamOptions::loopEnabled { false }

Definition at line 77 of file AudioIOBase.h.

pCrossfadeData

PRCrossfadeData* AudioIOStartStreamOptions::pCrossfadeData {}

Definition at line 66 of file AudioIOBase.h.

Referenced by AudioIO::StartStream().

playbackMeter

std::weak_ptr<Meter> AudioIOStartStreamOptions::playbackMeter

Definition at line 56 of file AudioIOBase.h.

Referenced by AudioIO::StartPortAudioStream().

playbackStreamPrimer

std::function< std::chrono::milliseconds() > AudioIOStartStreamOptions::playbackStreamPrimer

Definition at line 71 of file AudioIOBase.h.

Referenced by AudioIO::StartStream().

playNonWaveTracks

bool AudioIOStartStreamOptions::playNonWaveTracks { true }

Definition at line 63 of file AudioIOBase.h.

Referenced by ProjectAudioManager::PlayPlayRegion().

policyFactory

PolicyFactory AudioIOStartStreamOptions::policyFactory

Definition at line 75 of file AudioIOBase.h.

Referenced by PlaybackSchedule::Init(), and ProjectAudioManager::PlayPlayRegion().

pProject

std::shared_ptr<AudacityProject> AudioIOStartStreamOptions::pProject

Definition at line 55 of file AudioIOBase.h.

Referenced by AudioIO::StartPortAudioStream().

preRoll

double AudioIOStartStreamOptions::preRoll { 0.0 }

Definition at line 61 of file AudioIOBase.h.

Referenced by AudioIO::StartStream().

pStartTime

std::optional<double> AudioIOStartStreamOptions::pStartTime

mutable

Definition at line 60 of file AudioIOBase.h.

Referenced by ProjectAudioManager::PlayPlayRegion(), and AudioIO::StartStream().

rate

double AudioIOStartStreamOptions::rate

Definition at line 59 of file AudioIOBase.h.

Referenced by AudioIO::StartPortAudioStream(), and AudioIO::StartStream().

variableSpeed

bool AudioIOStartStreamOptions::variableSpeed { false }

Definition at line 78 of file AudioIOBase.h.

---

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

• AudioIOBase.h