tracktion::engine::LauncherClipPlaybackHandle Class Reference

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)

Detailed Description

Definition at line 17 of file tracktion_LauncherClipPlaybackHandle.h.

---

Class Documentation

tracktion::engine::LauncherClipPlaybackHandle::SplitBeatRange

struct tracktion::engine::LauncherClipPlaybackHandle::SplitBeatRange

Represents two beat ranges that can be split.

Definition at line 39 of file tracktion_LauncherClipPlaybackHandle.h.

Class Members
bool	playing1
bool	playing2
BeatRange	range1
BeatRange	range2

Member Function Documentation

forLooping()

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

static

Definition at line 15 of file tracktion_LauncherClipPlaybackHandle.cpp.

forOneShot()

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

static

Definition at line 28 of file tracktion_LauncherClipPlaybackHandle.cpp.

getProgress()

std::optional< float > tracktion::engine::LauncherClipPlaybackHandle::getProgress

(

BeatPosition

p

)

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.

Definition at line 178 of file tracktion_LauncherClipPlaybackHandle.cpp.

getStart()

std::optional< BeatPosition > tracktion::engine::LauncherClipPlaybackHandle::getStart

(

)

const

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

Definition at line 49 of file tracktion_LauncherClipPlaybackHandle.cpp.

start()

void tracktion::engine::LauncherClipPlaybackHandle::start

(

BeatPosition

p

)

Signifies that the clip has started at a given position.

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

Definition at line 39 of file tracktion_LauncherClipPlaybackHandle.cpp.

stop()

void tracktion::engine::LauncherClipPlaybackHandle::stop

(

)

Signifies that the clip should stop.

Definition at line 44 of file tracktion_LauncherClipPlaybackHandle.cpp.

timelineRangeToClipSourceRange()

LauncherClipPlaybackHandle::SplitBeatRange tracktion::engine::LauncherClipPlaybackHandle::timelineRangeToClipSourceRange

(

BeatRange

r

)

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

Definition at line 54 of file tracktion_LauncherClipPlaybackHandle.cpp.

---

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

• tracktion_engine/model/clips/tracktion_LauncherClipPlaybackHandle.h
• tracktion_engine/model/clips/tracktion_LauncherClipPlaybackHandle.cpp