AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_IACFTransport.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2013-2015, 2020-2021 by Avid Technology, Inc.
5  * All rights reserved.
6  *
7  * CONFIDENTIAL: This document contains confidential information. Do not
8  * read or examine this document unless you are an Avid Technology employee
9  * or have signed a non-disclosure agreement with Avid Technology which protects
10  * the confidentiality of this document. DO NOT DISCLOSE ANY INFORMATION
11  * CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT
12  * OF Avid Technology, INC.
13  *
14  */
15 
21 /*================================================================================================*/
22 
23 #ifndef AAX_IACFTRANSPORT_H
24 #define AAX_IACFTRANSPORT_H
25 
26 #include "AAX.h"
27 #include "AAX_Enums.h"
28 
29 #ifdef __clang__
30 #pragma clang diagnostic push
31 #pragma clang diagnostic ignored "-Wnon-virtual-dtor"
32 #endif
33 
34 #include "acfunknown.h"
35 
39 {
40 public:
41 
42  virtual AAX_Result GetCurrentTempo ( double* TempoBPM ) const = 0;
43  virtual AAX_Result GetCurrentMeter ( int32_t* MeterNumerator, int32_t* MeterDenominator ) const = 0;
44  virtual AAX_Result IsTransportPlaying ( bool* isPlaying ) const = 0;
45  virtual AAX_Result GetCurrentTickPosition ( int64_t* TickPosition ) const = 0;
46  virtual AAX_Result GetCurrentLoopPosition ( bool* bLooping, int64_t* LoopStartTick, int64_t* LoopEndTick ) const = 0;
47  virtual AAX_Result GetCurrentNativeSampleLocation ( int64_t* SampleLocation ) const = 0;
48  virtual AAX_Result GetCustomTickPosition ( int64_t* oTickPosition, int64_t iSampleLocation ) const = 0;
49  virtual AAX_Result GetBarBeatPosition ( int32_t* Bars, int32_t* Beats, int64_t* DisplayTicks, int64_t SampleLocation ) const = 0;
50  virtual AAX_Result GetTicksPerQuarter ( uint32_t* ticks ) const = 0;
51  virtual AAX_Result GetCurrentTicksPerBeat ( uint32_t* ticks ) const = 0;
52 
53 };
54 
58 {
59 public:
60 
61  virtual AAX_Result GetTimelineSelectionStartPosition( int64_t* oSampleLocation ) const = 0;
62  virtual AAX_Result GetTimeCodeInfo( AAX_EFrameRate* oFrameRate, int32_t* oOffset ) const = 0;
63  virtual AAX_Result GetFeetFramesInfo( AAX_EFeetFramesRate* oFeetFramesRate, int64_t* oOffset ) const = 0;
64  virtual AAX_Result IsMetronomeEnabled ( int32_t* isEnabled ) const = 0;
65 };
66 
70 {
71 public:
72 
73  virtual AAX_Result GetHDTimeCodeInfo( AAX_EFrameRate* oHDFrameRate, int64_t* oHDOffset ) const = 0;
74 };
75 
76 #ifdef __clang__
77 #pragma clang diagnostic pop
78 #endif
79 
80 #endif // AAX_IACFTRANSPORT_H
81 
Various utility definitions for AAX.
int32_t AAX_Result
Definition: AAX.h:337
Utility functions for byte-swapping. Used by AAX_CChunkDataParser.
AAX_EFrameRate
FrameRate types.
Definition: AAX_Enums.h:1075
AAX_EFeetFramesRate
FeetFramesRate types.
Definition: AAX_Enums.h:1104
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:248
Versioned interface to information about the host's transport state.
Definition: AAX_IACFTransport.h:39
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.
virtual AAX_Result GetCurrentTickPosition(int64_t *TickPosition) const =0
CALL: Gets the current tick position.
virtual AAX_Result GetCurrentMeter(int32_t *MeterNumerator, int32_t *MeterDenominator) const =0
CALL: Gets the current meter.
virtual AAX_Result GetCurrentLoopPosition(bool *bLooping, int64_t *LoopStartTick, int64_t *LoopEndTick) const =0
CALL: Gets current information on loop playback.
virtual AAX_Result GetCurrentTempo(double *TempoBPM) const =0
CALL: Gets the current tempo.
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 GetCurrentNativeSampleLocation(int64_t *SampleLocation) const =0
CALL: Gets the current playback location of the native audio engine.
virtual AAX_Result IsTransportPlaying(bool *isPlaying) const =0
CALL: Indicates whether or not the transport is playing back.
Versioned interface to information about the host's transport state.
Definition: AAX_IACFTransport.h:58
virtual AAX_Result GetTimelineSelectionStartPosition(int64_t *oSampleLocation) const =0
CALL: Retrieves the current absolute sample position of the beginning of the current transport select...
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 IsMetronomeEnabled(int32_t *isEnabled) const =0
Sets isEnabled to true if the metronome is enabled.
virtual AAX_Result GetFeetFramesInfo(AAX_EFeetFramesRate *oFeetFramesRate, int64_t *oOffset) const =0
CALL: Retrieves the current timecode feet/frames rate and offset.
Versioned interface to information about the host's transport state.
Definition: AAX_IACFTransport.h:70
virtual AAX_Result GetHDTimeCodeInfo(AAX_EFrameRate *oHDFrameRate, int64_t *oHDOffset) const =0
CALL: Retrieves the current HD time code frame rate and offset.