TracktionEngine
Public Member Functions | List of all members
tracktion::engine::TracktionEngineNode Class Reference

Base class for Nodes that provides information about the current process call. More...

Inheritance diagram for tracktion::engine::TracktionEngineNode:

Public Member Functions

 TracktionEngineNode (ProcessState &)
 Creates a TracktionEngineNode. More...
 
virtual ~TracktionEngineNode ()=default
 Destructor. More...
 
int getNumSamples () const
 Returns the number of samples in the current process block. More...
 
double getSampleRate () const
 Returns the sample rate of the current process block. More...
 
juce::Range< int64_t > getTimelineSampleRange () const
 Returns the timeline sample range of the current process block. More...
 
TimeRange getEditTimeRange () const
 Returns the edit time range of the current process block. More...
 
BeatRange getEditBeatRange () const
 Returns the edit beat range of the current process block. More...
 
juce::Range< int64_t > getReferenceSampleRange () const
 Returns the reference sample range (from the DeviceManager) of the current process block. More...
 
tempo::Key getKey () const
 Returns the key of the current process block. More...
 
double getPlaybackSpeedRatio () const
 Returns the playback speed ratio of the current process block. More...
 
std::optional< TimePosition > getTimeOfNextChange () const
 May return the time of the next tempo or time sig change. More...
 
std::optional< BeatPosition > getBeatOfNextChange () const
 May return the time of the next tempo or time sig change. More...
 
tracktion::graph::PlayHeadStategetPlayHeadState ()
 Returns the PlayHeadState in use. More...
 
tracktion::graph::PlayHeadgetPlayHead ()
 Returns the PlayHead in use. More...
 
ProcessStategetProcessState ()
 Returns the ProcessState in use. More...
 
void setProcessState (ProcessState &)
 

Detailed Description

Base class for Nodes that provides information about the current process call.

Constructor & Destructor Documentation

◆ TracktionEngineNode()

tracktion::engine::TracktionEngineNode::TracktionEngineNode ( ProcessState )

Creates a TracktionEngineNode.

◆ ~TracktionEngineNode()

virtual tracktion::engine::TracktionEngineNode::~TracktionEngineNode ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getNumSamples()

int tracktion::engine::TracktionEngineNode::getNumSamples ( ) const

Returns the number of samples in the current process block.

References tracktion::engine::ProcessState::numSamples.

◆ getSampleRate()

double tracktion::engine::TracktionEngineNode::getSampleRate ( ) const

Returns the sample rate of the current process block.

References tracktion::engine::ProcessState::sampleRate.

◆ getTimelineSampleRange()

juce::Range<int64_t> tracktion::engine::TracktionEngineNode::getTimelineSampleRange ( ) const

Returns the timeline sample range of the current process block.

References tracktion::engine::ProcessState::timelineSampleRange.

◆ getEditTimeRange()

TimeRange tracktion::engine::TracktionEngineNode::getEditTimeRange ( ) const

Returns the edit time range of the current process block.

References tracktion::engine::ProcessState::editTimeRange.

◆ getEditBeatRange()

BeatRange tracktion::engine::TracktionEngineNode::getEditBeatRange ( ) const

Returns the edit beat range of the current process block.

References tracktion::engine::ProcessState::editBeatRange.

◆ getReferenceSampleRange()

juce::Range<int64_t> tracktion::engine::TracktionEngineNode::getReferenceSampleRange ( ) const

Returns the reference sample range (from the DeviceManager) of the current process block.

References tracktion::engine::ProcessState::referenceSampleRange.

◆ getKey()

tempo::Key tracktion::engine::TracktionEngineNode::getKey ( ) const

Returns the key of the current process block.

◆ getPlaybackSpeedRatio()

double tracktion::engine::TracktionEngineNode::getPlaybackSpeedRatio ( ) const

Returns the playback speed ratio of the current process block.

◆ getTimeOfNextChange()

std::optional<TimePosition> tracktion::engine::TracktionEngineNode::getTimeOfNextChange ( ) const

May return the time of the next tempo or time sig change.

◆ getBeatOfNextChange()

std::optional<BeatPosition> tracktion::engine::TracktionEngineNode::getBeatOfNextChange ( ) const

May return the time of the next tempo or time sig change.

◆ getPlayHeadState()

tracktion::graph::PlayHeadState& tracktion::engine::TracktionEngineNode::getPlayHeadState ( )

Returns the PlayHeadState in use.

References tracktion::engine::ProcessState::playHeadState.

Referenced by getPlayHead().

◆ getPlayHead()

tracktion::graph::PlayHead& tracktion::engine::TracktionEngineNode::getPlayHead ( )

◆ getProcessState()

ProcessState& tracktion::engine::TracktionEngineNode::getProcessState ( )

Returns the ProcessState in use.

◆ setProcessState()

void tracktion::engine::TracktionEngineNode::setProcessState ( ProcessState )

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