tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
tracktion::graph::PlayHeadState Class Reference

Determines how this block releates to other previous render blocks and if the play head has jumped in time. More...

#include "tracktion_PlayHeadState.h"

Public Member Functions

 PlayHeadState (PlayHead &ph)
 
void update (juce::Range< int64_t > referenceSampleRange)
 Call once per block to update the jumped state.
 
bool isContiguousWithPreviousBlock () noexcept
 Returns true if the play head did not jump and this block is contiguous with the previous block.
 
bool didPlayheadJump () noexcept
 Returns true if the play head jumped.
 
bool isFirstBlockOfLoop () noexcept
 Returns true if this is the first block of a loop.
 
bool isLastBlockOfLoop () noexcept
 Returns true if this is the last block of a loop.
 

Public Attributes

PlayHeadplayHead
 
bool isPlayHeadRunning
 
bool playheadJumped
 
bool lastBlockOfLoop
 
bool firstBlockOfLoop
 

Detailed Description

Determines how this block releates to other previous render blocks and if the play head has jumped in time.

Definition at line 23 of file tracktion_PlayHeadState.h.

Constructor & Destructor Documentation

◆ PlayHeadState()

tracktion::graph::PlayHeadState::PlayHeadState ( PlayHead ph)

Definition at line 26 of file tracktion_PlayHeadState.h.

Member Function Documentation

◆ didPlayheadJump()

bool tracktion::graph::PlayHeadState::didPlayheadJump ( )
noexcept

Returns true if the play head jumped.

Definition at line 40 of file tracktion_PlayHeadState.h.

◆ isContiguousWithPreviousBlock()

bool tracktion::graph::PlayHeadState::isContiguousWithPreviousBlock ( )
noexcept

Returns true if the play head did not jump and this block is contiguous with the previous block.

Definition at line 37 of file tracktion_PlayHeadState.h.

◆ isFirstBlockOfLoop()

bool tracktion::graph::PlayHeadState::isFirstBlockOfLoop ( )
noexcept

Returns true if this is the first block of a loop.

Definition at line 43 of file tracktion_PlayHeadState.h.

◆ isLastBlockOfLoop()

bool tracktion::graph::PlayHeadState::isLastBlockOfLoop ( )
noexcept

Returns true if this is the last block of a loop.

Definition at line 46 of file tracktion_PlayHeadState.h.

◆ update()

void tracktion::graph::PlayHeadState::update ( juce::Range< int64_t referenceSampleRange)

Call once per block to update the jumped state.

Usually called at the same time as the PlayHead::incrementReferenceSampleCount method.

Definition at line 59 of file tracktion_PlayHeadState.h.

Member Data Documentation

◆ firstBlockOfLoop

bool tracktion::graph::PlayHeadState::firstBlockOfLoop

Definition at line 51 of file tracktion_PlayHeadState.h.

◆ isPlayHeadRunning

bool tracktion::graph::PlayHeadState::isPlayHeadRunning

Definition at line 51 of file tracktion_PlayHeadState.h.

◆ lastBlockOfLoop

bool tracktion::graph::PlayHeadState::lastBlockOfLoop

Definition at line 51 of file tracktion_PlayHeadState.h.

◆ playHead

PlayHead& tracktion::graph::PlayHeadState::playHead

Definition at line 48 of file tracktion_PlayHeadState.h.

◆ playheadJumped

bool tracktion::graph::PlayHeadState::playheadJumped

Definition at line 51 of file tracktion_PlayHeadState.h.


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