Interface to information about the host's transport state.
- :Implemented by the AAX Host:
Plug-ins that use this interface should describe AAX_eProperty_UsesTransport as 1
Acquire this interface using AAX_IMIDINode::GetTransport(). Classes that inherit from AAX_CEffectParameters or AAX_CEffectGUI can also use AAX_CEffectParameters::Transport() / AAX_CEffectGUI::Transport().
|
virtual | ~AAX_ITransport () |
| Virtual destructor. More...
|
|
virtual AAX_Result | GetCurrentTempo (double *TempoBPM) const =0 |
| CALL: Gets the current tempo. More...
|
|
virtual AAX_Result | GetCurrentMeter (int32_t *MeterNumerator, int32_t *MeterDenominator) const =0 |
| CALL: Gets the current meter. More...
|
|
virtual AAX_Result | IsTransportPlaying (bool *isPlaying) const =0 |
| CALL: Indicates whether or not the transport is playing back. More...
|
|
virtual AAX_Result | GetCurrentTickPosition (int64_t *TickPosition) const =0 |
| CALL: Gets the current tick position. More...
|
|
virtual AAX_Result | GetCurrentLoopPosition (bool *bLooping, int64_t *LoopStartTick, int64_t *LoopEndTick) const =0 |
| CALL: Gets current information on loop playback. More...
|
|
virtual AAX_Result | GetCurrentNativeSampleLocation (int64_t *SampleLocation) const =0 |
| CALL: Gets the current playback location of the native audio engine. More...
|
|
virtual AAX_Result | GetCustomTickPosition (int64_t *oTickPosition, int64_t iSampleLocation) const =0 |
| CALL: Given an absolute sample position, gets the corresponding tick position. More...
|
|
virtual AAX_Result | GetBarBeatPosition (int32_t *Bars, int32_t *Beats, int64_t *DisplayTicks, int64_t SampleLocation) const =0 |
| CALL: Given an absolute sample position, gets the corresponding bar and beat position. More...
|
|
virtual AAX_Result | GetTicksPerQuarter (uint32_t *ticks) const =0 |
| CALL: Retrieves the number of ticks per quarter note. More...
|
|
virtual AAX_Result | GetCurrentTicksPerBeat (uint32_t *ticks) const =0 |
| CALL: Retrieves the number of ticks per beat. More...
|
|
virtual AAX_Result | GetTimelineSelectionStartPosition (int64_t *oSampleLocation) const =0 |
| CALL: Retrieves the current absolute sample position of the beginning of the current transport selection. More...
|
|
virtual AAX_Result | GetTimeCodeInfo (AAX_EFrameRate *oFrameRate, int32_t *oOffset) const =0 |
| CALL: Retrieves the current time code frame rate and offset. More...
|
|
virtual AAX_Result | GetFeetFramesInfo (AAX_EFeetFramesRate *oFeetFramesRate, int64_t *oOffset) const =0 |
| CALL: Retrieves the current timecode feet/frames rate and offset. More...
|
|
virtual AAX_Result | IsMetronomeEnabled (int32_t *isEnabled) const =0 |
| Sets isEnabled to true if the metronome is enabled. More...
|
|
virtual AAX_Result | GetHDTimeCodeInfo (AAX_EFrameRate *oHDFrameRate, int64_t *oHDOffset) const =0 |
| CALL: Retrieves the current HD time code frame rate and offset. More...
|
|
virtual AAX_Result AAX_ITransport::GetCurrentNativeSampleLocation |
( |
int64_t * |
SampleLocation | ) |
const |
|
pure virtual |
CALL: Gets the current playback location of the native audio engine.
When called from a ProcessProc render callback, this method will provide the absolute sample location at the beginning of the callback's audio buffers.
When called from AAX_IEffectParameters::RenderAudio_Hybrid(), this method will provide the absolute sample location for the samples in the method's output audio buffers. To calculate the absolute sample location for the sampels in the method's input buffers (i.e. the timelin location where the samples originated) subtract the value provided by AAX_IController::GetHybridSignalLatency() from this value.
When called from a non-real-time thread, this method will provide the current location of the samples being processed by the plug-in's ProcessProc on its real-time processing thread.
- Note
- This method only returns a value during playback. It cannot be used to determine, e.g., the location of the timeline selector while the host is not in playback.
- Parameters
-
[out] | SampleLocation | Absolute sample location of the first sample in the current native processing buffer |
Implemented in AAX_VTransport.