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::engine::ClipPosition Struct Reference

Represents the position of a clip on a timeline. More...

#include "tracktion_EditTime.h"

Public Member Functions

TimePosition getStart () const
 Returns the start time.
 
TimePosition getEnd () const
 Returns the end time.
 
TimeDuration getLength () const
 Returns the length.
 
TimeDuration getOffset () const
 Returns the offset.
 
TimePosition getStartOfSource () const
 Returns what would be the the start of the source material in the timeline.
 
bool operator== (const ClipPosition &other) const
 Compares two ClipPositions.
 
bool operator!= (const ClipPosition &other) const
 Compares two ClipPositions.
 
ClipPosition rescaled (TimePosition anchorTime, double factor) const
 Returns a ClipPosition scaled around an anchor point.
 

Public Attributes

TimeRange time
 The TimeRange this ClipPosition occupies.
 
TimeDuration offset
 The offset this ClipPosition has.
 

Detailed Description

Represents the position of a clip on a timeline.

Definition at line 118 of file tracktion_EditTime.h.

Member Function Documentation

◆ getEnd()

TimePosition tracktion::engine::ClipPosition::getEnd ( ) const

Returns the end time.

Definition at line 133 of file tracktion_EditTime.h.

◆ getLength()

TimeDuration tracktion::engine::ClipPosition::getLength ( ) const

Returns the length.

Definition at line 135 of file tracktion_EditTime.h.

◆ getOffset()

TimeDuration tracktion::engine::ClipPosition::getOffset ( ) const

Returns the offset.

Definition at line 137 of file tracktion_EditTime.h.

◆ getStart()

TimePosition tracktion::engine::ClipPosition::getStart ( ) const

Returns the start time.

Definition at line 131 of file tracktion_EditTime.h.

◆ getStartOfSource()

TimePosition tracktion::engine::ClipPosition::getStartOfSource ( ) const

Returns what would be the the start of the source material in the timeline.

Definition at line 139 of file tracktion_EditTime.h.

◆ operator!=()

bool tracktion::engine::ClipPosition::operator!= ( const ClipPosition other) const

Compares two ClipPositions.

Definition at line 144 of file tracktion_EditTime.h.

◆ operator==()

bool tracktion::engine::ClipPosition::operator== ( const ClipPosition other) const

Compares two ClipPositions.

Definition at line 142 of file tracktion_EditTime.h.

◆ rescaled()

ClipPosition tracktion::engine::ClipPosition::rescaled ( TimePosition  anchorTime,
double  factor 
) const

Returns a ClipPosition scaled around an anchor point.

Useful for stretching a clip.

Definition at line 298 of file tracktion_EditTime.h.

Member Data Documentation

◆ offset

TimeDuration tracktion::engine::ClipPosition::offset

The offset this ClipPosition has.

Offset is a bit unintuitive as the position this relates to in the source material will depend on lots of factors including looping and any time-stretching. It can generally be thought of as an offset from either the start of the file or the loop start position, scaled by any time-stretching.

Definition at line 121 of file tracktion_EditTime.h.

◆ time

TimeRange tracktion::engine::ClipPosition::time

The TimeRange this ClipPosition occupies.

Definition at line 120 of file tracktion_EditTime.h.


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