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

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
tracktion::engine::EditTime Struct Reference

Represents a time point in an Edit stored as either time or beats. More...

#include "tracktion_EditTime.h"

Public Member Functions

 EditTime ()
 Creates an empty EditTime, starting at 0.
 
 EditTime (TimePosition)
 Creates an EditTime from a TimePosition.
 
 EditTime (BeatPosition)
 Creates an EditTime from a BeatPosition.
 
bool isBeats () const
 Returns true if the time is stored as beats, false if stored as a TimePosition.
 

Friends

TimePosition toTime (EditTime, const TempoSequence &)
 Converts an EditTime to a TimePosition.
 
BeatPosition toBeats (EditTime, const TempoSequence &)
 Converts an EditTime to a BeatPosition.
 

Detailed Description

Represents a time point in an Edit stored as either time or beats.

This is basically a variant to simplify APIs that can accept either time base.

Definition at line 35 of file tracktion_EditTime.h.

Constructor & Destructor Documentation

◆ EditTime() [1/3]

tracktion::engine::EditTime::EditTime ( )

Creates an empty EditTime, starting at 0.

Definition at line 205 of file tracktion_EditTime.h.

◆ EditTime() [2/3]

tracktion::engine::EditTime::EditTime ( TimePosition  tp)

Creates an EditTime from a TimePosition.

Definition at line 210 of file tracktion_EditTime.h.

◆ EditTime() [3/3]

tracktion::engine::EditTime::EditTime ( BeatPosition  bp)

Creates an EditTime from a BeatPosition.

Definition at line 215 of file tracktion_EditTime.h.

Member Function Documentation

◆ isBeats()

bool tracktion::engine::EditTime::isBeats ( ) const

Returns true if the time is stored as beats, false if stored as a TimePosition.

Definition at line 220 of file tracktion_EditTime.h.

Friends And Related Symbol Documentation

◆ toBeats

BeatPosition toBeats ( EditTime  et,
const TempoSequence ts 
)
friend

Converts an EditTime to a BeatPosition.

N.B. This may be a slow operation if this was created using a TimePosition.

Definition at line 235 of file tracktion_EditTime.h.

◆ toTime

TimePosition toTime ( EditTime  et,
const TempoSequence ts 
)
friend

Converts an EditTime to a TimePosition.

N.B. This may be a slow operation if this was created using a BeatPosition.

Definition at line 226 of file tracktion_EditTime.h.


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