| 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_IACFTransport.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2015, 2019-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
18/*================================================================================================*/
19
20#ifndef AAX_IACFTRANSPORT_H
21#define AAX_IACFTRANSPORT_H
22
23#pragma once
24
25#include "AAX.h"
26#include "AAX_Enums.h"
27
28#ifdef __clang__
29#pragma clang diagnostic push
30#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
31#endif
32
33#include "acfunknown.h"
34
37 class AAX_IACFTransport : public IACFUnknown
38{
39 public:
40
41 virtual AAX_Result GetCurrentTempo ( double* TempoBPM ) const = 0;
42 virtual AAX_Result GetCurrentMeter ( int32_t* MeterNumerator, int32_t* MeterDenominator ) const = 0;
43 virtual AAX_Result IsTransportPlaying ( bool* isPlaying ) const = 0;
44 virtual AAX_Result GetCurrentTickPosition ( int64_t* TickPosition ) const = 0;
45 virtual AAX_Result GetCurrentLoopPosition ( bool* bLooping, int64_t* LoopStartTick, int64_t* LoopEndTick ) const = 0;
46 virtual AAX_Result GetCurrentNativeSampleLocation ( int64_t* SampleLocation ) const = 0;
47 virtual AAX_Result GetCustomTickPosition ( int64_t* oTickPosition, int64_t iSampleLocation ) const = 0;
48 virtual AAX_Result GetBarBeatPosition ( int32_t* Bars, int32_t* Beats, int64_t* DisplayTicks, int64_t SampleLocation ) const = 0;
49 virtual AAX_Result GetTicksPerQuarter ( uint32_t* ticks ) const = 0;
50 virtual AAX_Result GetCurrentTicksPerBeat ( uint32_t* ticks ) const = 0;
51
52};
53
56 class AAX_IACFTransport_V2 : public AAX_IACFTransport
57{
58 public:
59
60 virtual AAX_Result GetTimelineSelectionStartPosition( int64_t* oSampleLocation ) const = 0;
61 virtual AAX_Result GetTimeCodeInfo( AAX_EFrameRate* oFrameRate, int32_t* oOffset ) const = 0;
62 virtual AAX_Result GetFeetFramesInfo( AAX_EFeetFramesRate* oFeetFramesRate, int64_t* oOffset ) const = 0;
63 virtual AAX_Result IsMetronomeEnabled ( int32_t* isEnabled ) const = 0;
64};
65
68 class AAX_IACFTransport_V3 : public AAX_IACFTransport_V2
69{
70 public:
71
72 virtual AAX_Result GetHDTimeCodeInfo( AAX_EFrameRate* oHDFrameRate, int64_t* oHDOffset ) const = 0;
73};
74
77 class AAX_IACFTransport_V4 : public AAX_IACFTransport_V3
78{
79 public:
80
81 virtual AAX_Result GetTimelineSelectionEndPosition( int64_t* oSampleLocation ) const = 0;
82};
83
84#ifdef __clang__
85#pragma clang diagnostic pop
86#endif
87
88#endif // AAX_IACFTRANSPORT_H
89
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
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:252
AAX_IACFTransport
Versioned interface to get information about the host's transport state.
Definition: AAX_IACFTransport.h:38
AAX_IACFTransport::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_IACFTransport::GetTicksPerQuarter
virtual AAX_Result GetTicksPerQuarter(uint32_t *ticks) const =0
CALL: Retrieves the number of ticks per quarter note.
AAX_IACFTransport::GetCurrentTicksPerBeat
virtual AAX_Result GetCurrentTicksPerBeat(uint32_t *ticks) const =0
CALL: Retrieves the number of ticks per beat.
AAX_IACFTransport::GetCurrentTickPosition
virtual AAX_Result GetCurrentTickPosition(int64_t *TickPosition) const =0
CALL: Gets the current tick position.
AAX_IACFTransport::GetCurrentMeter
virtual AAX_Result GetCurrentMeter(int32_t *MeterNumerator, int32_t *MeterDenominator) const =0
CALL: Gets the current meter.
AAX_IACFTransport::GetCurrentLoopPosition
virtual AAX_Result GetCurrentLoopPosition(bool *bLooping, int64_t *LoopStartTick, int64_t *LoopEndTick) const =0
CALL: Gets current information on loop playback.
AAX_IACFTransport::GetCurrentTempo
virtual AAX_Result GetCurrentTempo(double *TempoBPM) const =0
CALL: Gets the current tempo.
AAX_IACFTransport::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_IACFTransport::GetCurrentNativeSampleLocation
virtual AAX_Result GetCurrentNativeSampleLocation(int64_t *SampleLocation) const =0
CALL: Gets the current playback location of the native audio engine.
AAX_IACFTransport::IsTransportPlaying
virtual AAX_Result IsTransportPlaying(bool *isPlaying) const =0
CALL: Indicates whether or not the transport is playing back.
AAX_IACFTransport_V2
Versioned interface to get information about the host's transport state.
Definition: AAX_IACFTransport.h:57
AAX_IACFTransport_V2::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_IACFTransport_V2::GetTimeCodeInfo
virtual AAX_Result GetTimeCodeInfo(AAX_EFrameRate *oFrameRate, int32_t *oOffset) const =0
CALL: Retrieves the current time code frame rate and offset.
AAX_IACFTransport_V2::IsMetronomeEnabled
virtual AAX_Result IsMetronomeEnabled(int32_t *isEnabled) const =0
Sets isEnabled to true if the metronome is enabled.
AAX_IACFTransport_V2::GetFeetFramesInfo
virtual AAX_Result GetFeetFramesInfo(AAX_EFeetFramesRate *oFeetFramesRate, int64_t *oOffset) const =0
CALL: Retrieves the current timecode feet/frames rate and offset.
AAX_IACFTransport_V3
Versioned interface to get information about the host's transport state.
Definition: AAX_IACFTransport.h:69
AAX_IACFTransport_V3::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_IACFTransport_V4
Versioned interface to get information about the host's transport state.
Definition: AAX_IACFTransport.h:78
AAX_IACFTransport_V4::GetTimelineSelectionEndPosition
virtual AAX_Result GetTimelineSelectionEndPosition(int64_t *oSampleLocation) const =0
CALL: Retrieves the absolute sample position of the end of the current transport selection.