TransportPosition Struct Reference

TransportPosition. More...

#include <ivsttransportcontrol.h>

Static Public Member Functions
static TransportPosition	fromSamples (TSamples s)
	Create from absolute samples.
static TransportPosition	fromQuarterNotes (TQuarterNotes q)
	Create from quarter notes (PPQ).

Public Attributes
TransportPositionType	type {TransportPositionType::Samples}
union {
TSamples   samples
	Absolute sample position. More...
TQuarterNotes   quarterNotes
	PPQ position (musical time) More...
};

Detailed Description

TransportPosition.

A tagged union representing a transport position in either:

• absolute samples (TSamples), or
• musical quarter notes (TQuarterNotes, a.k.a. PPQ).

Hosts may choose which representation they honor. Plug-ins should use ::Type to indicate which field is valid.

Note

TransportPosition is only meaningful for actions requiring a position (Locate, SetCycleStart, SetCycleEnd, etc).

Member Function Documentation

fromSamples()

static TransportPosition fromSamples ( TSamples s )

inlinestatic

Create from absolute samples.

fromQuarterNotes()

static TransportPosition fromQuarterNotes ( TQuarterNotes q )

inlinestatic

Create from quarter notes (PPQ).

Member Data Documentation

type

TransportPositionType type {TransportPositionType::Samples}

samples

TSamples samples

Absolute sample position.

quarterNotes

TQuarterNotes quarterNotes

PPQ position (musical time)

[union]

union { ... }