TracktionEngine
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | List of all members
tracktion::engine::LauncherClipPlaybackHandle Class Reference

#include <tracktion_LauncherClipPlaybackHandle.h>

Classes

struct  SplitBeatRange
 Represents two beat ranges that can be split. More...
 

Public Member Functions

void start (BeatPosition)
 Signifies that the clip has started at a given position.
 
void stop ()
 Signifies that the clip should stop.
 
std::optional< BeatPosition > getStart () const
 If the clip has been started, this will return that position.
 
SplitBeatRange timelineRangeToClipSourceRange (BeatRange) const
 Converts a timeline range (e.g.
 
std::optional< float > getProgress (BeatPosition) const
 Returns the progress through a clip's source.
 

Static Public Member Functions

static LauncherClipPlaybackHandle forLooping (BeatRange loopRange, BeatDuration offset)
 
static LauncherClipPlaybackHandle forOneShot (BeatRange clipRange)
 

Member Function Documentation

◆ forLooping()

static LauncherClipPlaybackHandle tracktion::engine::LauncherClipPlaybackHandle::forLooping ( BeatRange  loopRange,
BeatDuration  offset 
)
static

◆ forOneShot()

static LauncherClipPlaybackHandle tracktion::engine::LauncherClipPlaybackHandle::forOneShot ( BeatRange  clipRange)
static

◆ start()

void tracktion::engine::LauncherClipPlaybackHandle::start ( BeatPosition  )

Signifies that the clip has started at a given position.

This allows the source range and progress functions to calculate their results.

◆ stop()

void tracktion::engine::LauncherClipPlaybackHandle::stop ( )

Signifies that the clip should stop.

◆ getStart()

std::optional< BeatPosition > tracktion::engine::LauncherClipPlaybackHandle::getStart ( ) const

If the clip has been started, this will return that position.

◆ timelineRangeToClipSourceRange()

SplitBeatRange tracktion::engine::LauncherClipPlaybackHandle::timelineRangeToClipSourceRange ( BeatRange  ) const

Converts a timeline range (e.g.

returned from LaunchHandle)

Returns
A SplitBeatRange representing one or two (if split) clip source ranges.
See also
LaunchHandle

◆ getProgress()

std::optional< float > tracktion::engine::LauncherClipPlaybackHandle::getProgress ( BeatPosition  ) const

Returns the progress through a clip's source.

If the clip position is before the clip has started or after it has stopped, this will return nullopt.


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