AAX SDK 2.8.0
Avid Audio Extensions Development Kit
Loading...
Searching...
No Matches
List of all members | Public Member Functions
AAX_IACFTransport_V5 Class Referenceabstract

#include <AAX_IACFTransport.h>

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

Description

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

Public Member Functions

virtual AAX_Result GetKeySignature (int64_t iSampleLocation, uint32_t *oKeySignature) const =0
 CALL: Retrieves the key signature at a sample location.
 
- Public Member Functions inherited from AAX_IACFTransport_V4
virtual AAX_Result GetTimelineSelectionEndPosition (int64_t *oSampleLocation) const =0
 CALL: Retrieves the absolute sample position of the end of the current transport selection.
 
- Public Member Functions inherited from AAX_IACFTransport_V3
virtual AAX_Result GetHDTimeCodeInfo (AAX_EFrameRate *oHDFrameRate, int64_t *oHDOffset) const =0
 CALL: Retrieves the current HD time code frame rate and offset.
 
- Public Member Functions inherited from AAX_IACFTransport_V2
virtual AAX_Result GetTimelineSelectionStartPosition (int64_t *oSampleLocation) const =0
 CALL: Retrieves the absolute sample position of the beginning of the current transport selection.
 
virtual AAX_Result GetTimeCodeInfo (AAX_EFrameRate *oFrameRate, int32_t *oOffset) const =0
 CALL: Retrieves the current time code frame rate and offset.
 
virtual AAX_Result GetFeetFramesInfo (AAX_EFeetFramesRate *oFeetFramesRate, int64_t *oOffset) const =0
 CALL: Retrieves the current timecode feet/frames rate and offset.
 
virtual AAX_Result IsMetronomeEnabled (int32_t *isEnabled) const =0
 Sets isEnabled to true if the metronome is enabled.
 
- Public Member Functions inherited from AAX_IACFTransport
virtual AAX_Result GetCurrentTempo (double *TempoBPM) const =0
 CALL: Gets the current tempo.
 
virtual AAX_Result GetCurrentMeter (int32_t *MeterNumerator, int32_t *MeterDenominator) const =0
 CALL: Gets the current meter.
 
virtual AAX_Result IsTransportPlaying (bool *isPlaying) const =0
 CALL: Indicates whether or not the transport is playing back.
 
virtual AAX_Result GetCurrentTickPosition (int64_t *TickPosition) const =0
 CALL: Gets the current tick position.
 
virtual AAX_Result GetCurrentLoopPosition (bool *bLooping, int64_t *LoopStartTick, int64_t *LoopEndTick) const =0
 CALL: Gets current information on loop playback.
 
virtual AAX_Result GetCurrentNativeSampleLocation (int64_t *SampleLocation) const =0
 CALL: Gets the current playback location of the native audio engine.
 
virtual AAX_Result GetCustomTickPosition (int64_t *oTickPosition, int64_t iSampleLocation) const =0
 CALL: Given an absolute sample position, gets the corresponding tick position.
 
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.
 
virtual AAX_Result GetTicksPerQuarter (uint32_t *ticks) const =0
 CALL: Retrieves the number of ticks per quarter note.
 
virtual AAX_Result GetCurrentTicksPerBeat (uint32_t *ticks) const =0
 CALL: Retrieves the number of ticks per beat.
 
- Public Member Functions inherited from IACFUnknown
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE QueryInterface (const acfIID &iid, void **ppOut)=0
 Returns pointers to supported interfaces.
 
virtual acfUInt32 ACFMETHODCALLTYPE AddRef (void)=0
 Increments reference count.
 
virtual acfUInt32 ACFMETHODCALLTYPE Release (void)=0
 Decrements reference count.
 

Member Function Documentation

◆ GetKeySignature()

virtual AAX_Result AAX_IACFTransport_V5::GetKeySignature ( int64_t  iSampleLocation,
uint32_t *  oKeySignature 
) const
pure virtual

CALL: Retrieves the key signature at a sample location.

The signature is provided as a bitfield:

  • 31-20: Chromatic scale elements, ordered MSB (root) to LSB
  • 19-4: (Reserved)
  • 3-0: Root note (C natural = 0)

For example

*	  D# Major
*	     Ionian                          D#
*	  0b 101011010101 0000 00000000 0000 0011
*	
*	  E Phrygian
*	     Phrygian                        E
*	  0b 110101011010 0000 00000000 0000 0100
*	
*	  Chromatic
*	     Chromatic                       C
*	  0b 111111111111 0000 00000000 0000 0000
*	

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