| AAX SDK 2.8.0 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-2024 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * This file is part of the Avid AAX SDK.
8 *
9 * The AAX SDK is subject to commercial or open-source licensing.
10 *
11 * By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
12 * Agreement and Avid Privacy Policy.
13 *
14 * AAX SDK License: https://developer.avid.com/aax
15 * Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
16 *
17 * Or: You may also use this code under the terms of the GPL v3 (see
18 * www.gnu.org/licenses).
19 *
20 * THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
21 * EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
22 * DISCLAIMED.
23 *
24 */
25
33/*================================================================================================*/
34
35
36#ifndef AAX_ITRANSPORT_H
37#define AAX_ITRANSPORT_H
38
39#pragma once
40
41#include "AAX.h"
42#include "AAX_Enums.h"
43
65 class AAX_ITransport
66{
67 public:
68
73 virtual ~AAX_ITransport() { }
74
85 virtual AAX_Result GetCurrentTempo ( double* TempoBPM ) const = 0;
86
95 virtual AAX_Result GetCurrentMeter ( int32_t* MeterNumerator, int32_t* MeterDenominator ) const = 0;
96
102 virtual AAX_Result IsTransportPlaying ( bool* isPlaying ) const = 0;
103
116 virtual AAX_Result GetCurrentTickPosition ( int64_t* TickPosition ) const = 0;
117
129 virtual AAX_Result GetCurrentLoopPosition ( bool* bLooping, int64_t* LoopStartTick, int64_t* LoopEndTick ) const = 0;
149 virtual AAX_Result GetCurrentNativeSampleLocation ( int64_t* SampleLocation ) const = 0;
150
160 virtual AAX_Result GetCustomTickPosition( int64_t* oTickPosition, int64_t iSampleLocation) const = 0;
161
173 virtual AAX_Result GetBarBeatPosition(int32_t* Bars, int32_t* Beats, int64_t* DisplayTicks, int64_t SampleLocation) const = 0;
174
180 virtual AAX_Result GetTicksPerQuarter ( uint32_t* ticks ) const = 0;
181
187 virtual AAX_Result GetCurrentTicksPerBeat ( uint32_t* ticks ) const = 0;
188
196 virtual AAX_Result GetTimelineSelectionStartPosition ( int64_t* oSampleLocation ) const = 0;
197
206 virtual AAX_Result GetTimeCodeInfo( AAX_EFrameRate* oFrameRate, int32_t* oOffset ) const = 0;
207
216 virtual AAX_Result GetFeetFramesInfo( AAX_EFeetFramesRate* oFeetFramesRate, int64_t* oOffset ) const = 0;
217
225 virtual AAX_Result IsMetronomeEnabled ( int32_t* isEnabled ) const = 0;
226
235 virtual AAX_Result GetHDTimeCodeInfo( AAX_EFrameRate* oHDFrameRate, int64_t* oHDOffset ) const = 0;
236
242 virtual AAX_Result RequestTransportStart() = 0;
243
249 virtual AAX_Result RequestTransportStop() = 0;
250
258 virtual AAX_Result GetTimelineSelectionEndPosition ( int64_t* oSampleLocation ) const = 0;
259
284 virtual AAX_Result GetKeySignature( int64_t iSampleLocation, uint32_t* oKeySignature ) const = 0;
285};
286
287#endif // AAX_ITRANSPORT_H
288
AAX_Enums.h
Utility functions for byte-swapping. Used by AAX_CChunkDataParser.
AAX_EFrameRate
AAX_EFrameRate
FrameRate types.
Definition: AAX_Enums.h:1142
AAX_EFeetFramesRate
AAX_EFeetFramesRate
FeetFramesRate types.
Definition: AAX_Enums.h:1171
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_ITransport
Interface to information about the host's transport state.
Definition: AAX_ITransport.h:66
AAX_ITransport::GetCurrentTempo
virtual AAX_Result GetCurrentTempo(double *TempoBPM) const =0
CALL: Gets the current tempo.
AAX_ITransport::GetKeySignature
virtual AAX_Result GetKeySignature(int64_t iSampleLocation, uint32_t *oKeySignature) const =0
CALL: Retrieves the key signature at a sample location.
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:73
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.