AAX SDK  2.4.1
Avid Audio Extensions Development Kit
List of all members | Public Member Functions
AAX_IACFTransport_V2 Class Referenceabstract

#include <AAX_IACFTransport.h>

Inheritance diagram for AAX_IACFTransport_V2:
[legend]
Collaboration diagram for AAX_IACFTransport_V2:
[legend]

Description

Versioned interface to information about the host's transport state.

Public Member Functions

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...
 
- Public Member Functions inherited from AAX_IACFTransport
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...
 
- Public Member Functions inherited from IACFUnknown
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE QueryInterface (const acfIID &iid, void **ppOut)=0
 Returns pointers to supported interfaces. More...
 
virtual acfUInt32 ACFMETHODCALLTYPE AddRef (void)=0
 Increments reference count. More...
 
virtual acfUInt32 ACFMETHODCALLTYPE Release (void)=0
 Decrements reference count. More...
 

Member Function Documentation

◆ GetTimelineSelectionStartPosition()

virtual AAX_Result AAX_IACFTransport_V2::GetTimelineSelectionStartPosition ( int64_t *  oSampleLocation) const
pure virtual

CALL: Retrieves the current absolute sample position of the beginning of the current transport selection.

Note
This method is part of the version 2 transport interface
Parameters
[out]oSampleLocation

◆ GetTimeCodeInfo()

virtual AAX_Result AAX_IACFTransport_V2::GetTimeCodeInfo ( AAX_EFrameRate oFrameRate,
int32_t *  oOffset 
) const
pure virtual

CALL: Retrieves the current time code frame rate and offset.

Note
This method is part of the version 2 transport interface
Parameters
[out]oFrameRate
[out]oOffset

◆ GetFeetFramesInfo()

virtual AAX_Result AAX_IACFTransport_V2::GetFeetFramesInfo ( AAX_EFeetFramesRate oFeetFramesRate,
int64_t *  oOffset 
) const
pure virtual

CALL: Retrieves the current timecode feet/frames rate and offset.

Note
This method is part of the version 2 transport interface
Parameters
[out]oFeetFramesRate
[out]oOffset

◆ IsMetronomeEnabled()

virtual AAX_Result AAX_IACFTransport_V2::IsMetronomeEnabled ( int32_t *  isEnabled) const
pure virtual

Sets isEnabled to true if the metronome is enabled.

Note
This method is part of the version 2 transport interface
Parameters
[out]isEnabled

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