| AAX SDK 2.6.1 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- File List
- File Members

Loading...
Searching...
No Matches
AAX_ITransport.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2015, 2018-2021, 2023 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * CONFIDENTIAL: this document contains confidential information of Avid. Do
8 * not disclose to any third party. Use of the information contained in this
9 * document is subject to an Avid SDK license.
10 *
11 */
12
20/*================================================================================================*/
21
22
23#ifndef AAX_ITRANSPORT_H
24#define AAX_ITRANSPORT_H
25
26#pragma once
27
28#include "AAX.h"
29#include "AAX_Enums.h"
30
52 class AAX_ITransport
53{
54 public:
55
60 virtual ~AAX_ITransport() { }
61
72 virtual AAX_Result GetCurrentTempo ( double* TempoBPM ) const = 0;
73
82 virtual AAX_Result GetCurrentMeter ( int32_t* MeterNumerator, int32_t* MeterDenominator ) const = 0;
83
89 virtual AAX_Result IsTransportPlaying ( bool* isPlaying ) const = 0;
90
103 virtual AAX_Result GetCurrentTickPosition ( int64_t* TickPosition ) const = 0;
104
116 virtual AAX_Result GetCurrentLoopPosition ( bool* bLooping, int64_t* LoopStartTick, int64_t* LoopEndTick ) const = 0;
136 virtual AAX_Result GetCurrentNativeSampleLocation ( int64_t* SampleLocation ) const = 0;
137
147 virtual AAX_Result GetCustomTickPosition( int64_t* oTickPosition, int64_t iSampleLocation) const = 0;
148
160 virtual AAX_Result GetBarBeatPosition(int32_t* Bars, int32_t* Beats, int64_t* DisplayTicks, int64_t SampleLocation) const = 0;
161
167 virtual AAX_Result GetTicksPerQuarter ( uint32_t* ticks ) const = 0;
168
174 virtual AAX_Result GetCurrentTicksPerBeat ( uint32_t* ticks ) const = 0;
175
183 virtual AAX_Result GetTimelineSelectionStartPosition ( int64_t* oSampleLocation ) const = 0;
184
193 virtual AAX_Result GetTimeCodeInfo( AAX_EFrameRate* oFrameRate, int32_t* oOffset ) const = 0;
194
203 virtual AAX_Result GetFeetFramesInfo( AAX_EFeetFramesRate* oFeetFramesRate, int64_t* oOffset ) const = 0;
204
212 virtual AAX_Result IsMetronomeEnabled ( int32_t* isEnabled ) const = 0;
213
222 virtual AAX_Result GetHDTimeCodeInfo( AAX_EFrameRate* oHDFrameRate, int64_t* oHDOffset ) const = 0;
223
229 virtual AAX_Result RequestTransportStart() = 0;
230
236 virtual AAX_Result RequestTransportStop() = 0;
237
245 virtual AAX_Result GetTimelineSelectionEndPosition ( int64_t* oSampleLocation ) const = 0;
246};
247
248#endif // AAX_ITRANSPORT_H
249
AAX_Enums.h
Utility functions for byte-swapping. Used by AAX_CChunkDataParser.
AAX_EFrameRate
AAX_EFrameRate
FrameRate types.
Definition: AAX_Enums.h:1096
AAX_EFeetFramesRate
AAX_EFeetFramesRate
FeetFramesRate types.
Definition: AAX_Enums.h:1125
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
AAX_ITransport
Interface to information about the host's transport state.
Definition: AAX_ITransport.h:53
AAX_ITransport::GetCurrentTempo
virtual AAX_Result GetCurrentTempo(double *TempoBPM) const =0
CALL: Gets the current tempo.
AAX_ITransport::GetFeetFramesInfo
virtual AAX_Result GetFeetFramesInfo(AAX_EFeetFramesRate *oFeetFramesRate, int64_t *oOffset) const =0
CALL: Retrieves the current timecode feet/frames rate and offset.
AAX_ITransport::~AAX_ITransport
virtual ~AAX_ITransport()
Virtual destructor.
Definition: AAX_ITransport.h:60
AAX_ITransport::GetCurrentMeter
virtual AAX_Result GetCurrentMeter(int32_t *MeterNumerator, int32_t *MeterDenominator) const =0
CALL: Gets the current meter.
AAX_ITransport::GetCurrentTickPosition
virtual AAX_Result GetCurrentTickPosition(int64_t *TickPosition) const =0
CALL: Gets the current tick position.
AAX_ITransport::GetCurrentLoopPosition
virtual AAX_Result GetCurrentLoopPosition(bool *bLooping, int64_t *LoopStartTick, int64_t *LoopEndTick) const =0
CALL: Gets current information on loop playback.
AAX_ITransport::GetTimeCodeInfo
virtual AAX_Result GetTimeCodeInfo(AAX_EFrameRate *oFrameRate, int32_t *oOffset) const =0
CALL: Retrieves the current time code frame rate and offset.
AAX_ITransport::GetHDTimeCodeInfo
virtual AAX_Result GetHDTimeCodeInfo(AAX_EFrameRate *oHDFrameRate, int64_t *oHDOffset) const =0
CALL: Retrieves the current HD time code frame rate and offset.
AAX_ITransport::GetBarBeatPosition
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.
AAX_ITransport::GetTimelineSelectionStartPosition
virtual AAX_Result GetTimelineSelectionStartPosition(int64_t *oSampleLocation) const =0
CALL: Retrieves the absolute sample position of the beginning of the current transport selection.
AAX_ITransport::GetCurrentNativeSampleLocation
virtual AAX_Result GetCurrentNativeSampleLocation(int64_t *SampleLocation) const =0
CALL: Gets the current playback location of the native audio engine.
AAX_ITransport::GetCustomTickPosition
virtual AAX_Result GetCustomTickPosition(int64_t *oTickPosition, int64_t iSampleLocation) const =0
CALL: Given an absolute sample position, gets the corresponding tick position.
AAX_ITransport::IsTransportPlaying
virtual AAX_Result IsTransportPlaying(bool *isPlaying) const =0
CALL: Indicates whether or not the transport is playing back.
AAX_ITransport::GetTicksPerQuarter
virtual AAX_Result GetTicksPerQuarter(uint32_t *ticks) const =0
CALL: Retrieves the number of ticks per quarter note.
AAX_ITransport::GetCurrentTicksPerBeat
virtual AAX_Result GetCurrentTicksPerBeat(uint32_t *ticks) const =0
CALL: Retrieves the number of ticks per beat.
AAX_ITransport::RequestTransportStart
virtual AAX_Result RequestTransportStart()=0
CALL: Request that the host transport start playback.
AAX_ITransport::RequestTransportStop
virtual AAX_Result RequestTransportStop()=0
CALL: Request that the host transport stop playback.
AAX_ITransport::IsMetronomeEnabled
virtual AAX_Result IsMetronomeEnabled(int32_t *isEnabled) const =0
Sets isEnabled to true if the metronome is enabled.
AAX_ITransport::GetTimelineSelectionEndPosition
virtual AAX_Result GetTimelineSelectionEndPosition(int64_t *oSampleLocation) const =0
CALL: Retrieves the absolute sample position of the end of the current transport selection.