AAX SDK  2.1.1
Avid Audio Extensions Development Kit
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
AAX_VTransport.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2013 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 
19 /*================================================================================================*/
20 
21 #ifndef AAX_VTRANSPORT_H
22 #define AAX_VTRANSPORT_H
23 
24 #include "AAX_ITransport.h"
25 #include "AAX_IACFTransport.h"
26 #include "ACFPtr.h"
27 
33 {
34 public:
35  AAX_VTransport( IACFUnknown* pUnknown );
36  virtual ~AAX_VTransport();
37 
38  // Transport Information Getters
39  // AAX_IACFTransport
40  virtual AAX_Result GetCurrentTempo ( double* TempoBPM ) const;
41  virtual AAX_Result GetCurrentMeter ( int32_t* MeterNumerator, int32_t* MeterDenominator ) const;
42  virtual AAX_Result IsTransportPlaying ( bool* isPlaying ) const;
43  virtual AAX_Result GetCurrentTickPosition ( int64_t* TickPosition ) const;
44  virtual AAX_Result GetCurrentLoopPosition ( bool* bLooping, int64_t* LoopStartTick, int64_t* LoopEndTick ) const;
45  virtual AAX_Result GetCurrentNativeSampleLocation ( int64_t* SampleLocation ) const;
46  virtual AAX_Result GetCustomTickPosition( int64_t* oTickPosition, int64_t iSampleLocation) const;
47  virtual AAX_Result GetBarBeatPosition(int32_t* Bars, int32_t* Beats, int64_t* DisplayTicks, int64_t SampleLocation) const;
48  virtual AAX_Result GetTicksPerQuarter ( uint32_t* ticks ) const;
49  virtual AAX_Result GetCurrentTicksPerBeat ( uint32_t* ticks ) const;
50 
51  // AAX_IACFTransport_V2
52  virtual AAX_Result GetTimelineSelectionStartPosition ( int64_t* oSampleLocation ) const;
53  virtual AAX_Result GetTimeCodeInfo( AAX_EFrameRate* oFrameRate, int32_t* oOffset ) const;
54  virtual AAX_Result GetFeetFramesInfo( AAX_EFeetFramesRate* oFeetFramesRate, int64_t* oOffset ) const;
55  virtual AAX_Result IsMetronomeEnabled ( int32_t* isEnabled ) const;
56 
57 private:
58  ACFPtr<AAX_IACFTransport> mITransport;
59  ACFPtr<AAX_IACFTransport_V2> mITransportV2;
60 };
61 
62 #endif // AAX_VTRANSPORT_H
63 
AAX_EFrameRate
FrameRate types.
Definition: AAX_Enums.h:705
virtual AAX_Result GetCurrentTickPosition(int64_t *TickPosition) const
CALL: Gets the current tick position.
AAX_EFeetFramesRate
FeetFramesRate types.
Definition: AAX_Enums.h:722
virtual AAX_Result GetCurrentLoopPosition(bool *bLooping, int64_t *LoopStartTick, int64_t *LoopEndTick) const
CALL: Gets current information on loop playback.
virtual AAX_Result GetTicksPerQuarter(uint32_t *ticks) const
CALL: Retrieves the number of ticks per quarter note.
virtual AAX_Result GetCurrentMeter(int32_t *MeterNumerator, int32_t *MeterDenominator) const
CALL: Gets the current meter.
virtual AAX_Result IsMetronomeEnabled(int32_t *isEnabled) const
Sets isEnabled to true if the metronome is enabled.
virtual AAX_Result GetTimeCodeInfo(AAX_EFrameRate *oFrameRate, int32_t *oOffset) const
CALL: Retrieves the current time code frame rate and offset.
virtual AAX_Result GetTimelineSelectionStartPosition(int64_t *oSampleLocation) const
CALL: Retrieves the current absolute sample position of the beginning of the current transport select...
virtual AAX_Result GetFeetFramesInfo(AAX_EFeetFramesRate *oFeetFramesRate, int64_t *oOffset) const
CALL: Retrieves the current timecode feet/frames rate and offset.
virtual AAX_Result IsTransportPlaying(bool *isPlaying) const
CALL: Indicates whether or not the transport is playing back.
virtual AAX_Result GetCurrentTicksPerBeat(uint32_t *ticks) const
CALL: Retrieves the number of ticks per beat.
Version-managed concrete AAX_ITransport class.
Definition: AAX_VTransport.h:32
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.dox:231
virtual ~AAX_VTransport()
int32_t AAX_Result
Definition: AAX.h:118
virtual AAX_Result GetCurrentNativeSampleLocation(int64_t *SampleLocation) const
CALL: Gets the current playback location of the native audio engine.
virtual AAX_Result GetBarBeatPosition(int32_t *Bars, int32_t *Beats, int64_t *DisplayTicks, int64_t SampleLocation) const
CALL: Given an absolute sample position, gets the corresponding bar and beat position.
Interface to information about the host&#39;s transport state.
Definition: AAX_ITransport.h:43
AAX_VTransport(IACFUnknown *pUnknown)
Interface for the AAX Transport data access functionality.
virtual AAX_Result GetCurrentTempo(double *TempoBPM) const
CALL: Gets the current tempo.
virtual AAX_Result GetCustomTickPosition(int64_t *oTickPosition, int64_t iSampleLocation) const
CALL: Given an absolute sample position, gets the corresponding tick position.
The interface for query ProTools transport information.