| 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_VTransport.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 2019-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
32/*================================================================================================*/
33
34#ifndef AAX_VTRANSPORT_H
35#define AAX_VTRANSPORT_H
36
37#pragma once
38
39#include "AAX_ITransport.h"
40#include "AAX_IACFTransport.h"
41#include "AAX_IACFTransportControl.h"
42#include "ACFPtr.h"
43
48 class AAX_VTransport : public AAX_ITransport
49{
50 public:
51 AAX_VTransport( IACFUnknown* pUnknown );
52 ~AAX_VTransport() AAX_OVERRIDE;
53
54 // Transport Information Getters
55 // AAX_IACFTransport
56 AAX_Result GetCurrentTempo ( double* TempoBPM ) const AAX_OVERRIDE;
57 AAX_Result GetCurrentMeter ( int32_t* MeterNumerator, int32_t* MeterDenominator ) const AAX_OVERRIDE;
58 AAX_Result IsTransportPlaying ( bool* isPlaying ) const AAX_OVERRIDE;
59 AAX_Result GetCurrentTickPosition ( int64_t* TickPosition ) const AAX_OVERRIDE;
60 AAX_Result GetCurrentLoopPosition ( bool* bLooping, int64_t* LoopStartTick, int64_t* LoopEndTick ) const AAX_OVERRIDE;
61 AAX_Result GetCurrentNativeSampleLocation ( int64_t* SampleLocation ) const AAX_OVERRIDE;
62 AAX_Result GetCustomTickPosition( int64_t* oTickPosition, int64_t iSampleLocation) const AAX_OVERRIDE;
63 AAX_Result GetBarBeatPosition(int32_t* Bars, int32_t* Beats, int64_t* DisplayTicks, int64_t SampleLocation) const AAX_OVERRIDE;
64 AAX_Result GetTicksPerQuarter ( uint32_t* ticks ) const AAX_OVERRIDE;
65 AAX_Result GetCurrentTicksPerBeat ( uint32_t* ticks ) const AAX_OVERRIDE;
66
67 // AAX_IACFTransport_V2
68 AAX_Result GetTimelineSelectionStartPosition ( int64_t* oSampleLocation ) const AAX_OVERRIDE;
69 AAX_Result GetTimeCodeInfo( AAX_EFrameRate* oFrameRate, int32_t* oOffset ) const AAX_OVERRIDE;
70 AAX_Result GetFeetFramesInfo( AAX_EFeetFramesRate* oFeetFramesRate, int64_t* oOffset ) const AAX_OVERRIDE;
71 AAX_Result IsMetronomeEnabled ( int32_t* isEnabled ) const AAX_OVERRIDE;
72
73 // AAX_IACFTransport_V3
74 AAX_Result GetHDTimeCodeInfo( AAX_EFrameRate* oHDFrameRate, int64_t* oHDOffset ) const AAX_OVERRIDE;
75
76 // AAX_IACFTransport_V4
77 AAX_Result GetTimelineSelectionEndPosition( int64_t* oSampleLocation ) const AAX_OVERRIDE;
78
79 // AAX_IACFTransport_V5
80 AAX_Result GetKeySignature( int64_t iSampleLocation, uint32_t* oKeySignature ) const AAX_OVERRIDE;
81
82 // AAX_IACFTransportControl
83 AAX_Result RequestTransportStart() AAX_OVERRIDE;
84 AAX_Result RequestTransportStop() AAX_OVERRIDE;
85
86private:
87 ACFPtr<AAX_IACFTransport> mITransport;
88 ACFPtr<AAX_IACFTransport_V2> mITransportV2;
89 ACFPtr<AAX_IACFTransport_V3> mITransportV3;
90 ACFPtr<AAX_IACFTransport_V4> mITransportV4;
91 ACFPtr<AAX_IACFTransport_V5> mITransportV5;
92 ACFPtr<AAX_IACFTransportControl> mITransportControl;
93};
94
95#endif // AAX_VTRANSPORT_H
96
AAX_EFrameRate
AAX_EFrameRate
FrameRate types.
Definition: AAX_Enums.h:1142
AAX_EFeetFramesRate
AAX_EFeetFramesRate
FeetFramesRate types.
Definition: AAX_Enums.h:1171
AAX_IACFTransportControl.h
Interface for control over the host's transport state.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_OVERRIDE
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:164
AAX_IACFTransport.h
Interface for accessing the host's transport state.
AAX_ITransport.h
The interface for query ProTools transport information.
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:265
AAX_IACFTransport
Versioned interface to get information about the host's transport state.
Definition: AAX_IACFTransport.h:51
AAX_IACFTransport_V2
Versioned interface to get information about the host's transport state.
Definition: AAX_IACFTransport.h:70
AAX_IACFTransport_V3
Versioned interface to get information about the host's transport state.
Definition: AAX_IACFTransport.h:82
AAX_IACFTransport_V4
Versioned interface to get information about the host's transport state.
Definition: AAX_IACFTransport.h:91
AAX_IACFTransport_V5
Versioned interface to get information about the host's transport state.
Definition: AAX_IACFTransport.h:100
AAX_IACFTransportControl
Versioned interface to control the host's transport state.
Definition: AAX_IACFTransportControl.h:51
AAX_ITransport
Interface to information about the host's transport state.
Definition: AAX_ITransport.h:66
AAX_VTransport
Version-managed concrete AAX_ITransport class.
Definition: AAX_VTransport.h:49
AAX_VTransport::GetTimelineSelectionStartPosition
AAX_Result GetTimelineSelectionStartPosition(int64_t *oSampleLocation) const AAX_OVERRIDE
CALL: Retrieves the absolute sample position of the beginning of the current transport selection.
AAX_VTransport::GetCurrentTickPosition
AAX_Result GetCurrentTickPosition(int64_t *TickPosition) const AAX_OVERRIDE
CALL: Gets the current tick position.
AAX_VTransport::~AAX_VTransport
~AAX_VTransport() AAX_OVERRIDE
AAX_VTransport::GetKeySignature
AAX_Result GetKeySignature(int64_t iSampleLocation, uint32_t *oKeySignature) const AAX_OVERRIDE
CALL: Retrieves the key signature at a sample location.
AAX_VTransport::GetCurrentTempo
AAX_Result GetCurrentTempo(double *TempoBPM) const AAX_OVERRIDE
CALL: Gets the current tempo.
AAX_VTransport::IsTransportPlaying
AAX_Result IsTransportPlaying(bool *isPlaying) const AAX_OVERRIDE
CALL: Indicates whether or not the transport is playing back.
AAX_VTransport::GetBarBeatPosition
AAX_Result GetBarBeatPosition(int32_t *Bars, int32_t *Beats, int64_t *DisplayTicks, int64_t SampleLocation) const AAX_OVERRIDE
CALL: Given an absolute sample position, gets the corresponding bar and beat position.
AAX_VTransport::AAX_VTransport
AAX_VTransport(IACFUnknown *pUnknown)
AAX_VTransport::GetCurrentTicksPerBeat
AAX_Result GetCurrentTicksPerBeat(uint32_t *ticks) const AAX_OVERRIDE
CALL: Retrieves the number of ticks per beat.
AAX_VTransport::GetCurrentMeter
AAX_Result GetCurrentMeter(int32_t *MeterNumerator, int32_t *MeterDenominator) const AAX_OVERRIDE
CALL: Gets the current meter.
AAX_VTransport::RequestTransportStop
AAX_Result RequestTransportStop() AAX_OVERRIDE
CALL: Request that the host transport stop playback.
AAX_VTransport::GetCurrentLoopPosition
AAX_Result GetCurrentLoopPosition(bool *bLooping, int64_t *LoopStartTick, int64_t *LoopEndTick) const AAX_OVERRIDE
CALL: Gets current information on loop playback.
AAX_VTransport::RequestTransportStart
AAX_Result RequestTransportStart() AAX_OVERRIDE
CALL: Request that the host transport start playback.
AAX_VTransport::GetTimelineSelectionEndPosition
AAX_Result GetTimelineSelectionEndPosition(int64_t *oSampleLocation) const AAX_OVERRIDE
CALL: Retrieves the absolute sample position of the end of the current transport selection.
AAX_VTransport::GetHDTimeCodeInfo
AAX_Result GetHDTimeCodeInfo(AAX_EFrameRate *oHDFrameRate, int64_t *oHDOffset) const AAX_OVERRIDE
CALL: Retrieves the current HD time code frame rate and offset.
AAX_VTransport::GetTicksPerQuarter
AAX_Result GetTicksPerQuarter(uint32_t *ticks) const AAX_OVERRIDE
CALL: Retrieves the number of ticks per quarter note.
AAX_VTransport::GetCurrentNativeSampleLocation
AAX_Result GetCurrentNativeSampleLocation(int64_t *SampleLocation) const AAX_OVERRIDE
CALL: Gets the current playback location of the native audio engine.
AAX_VTransport::GetCustomTickPosition
AAX_Result GetCustomTickPosition(int64_t *oTickPosition, int64_t iSampleLocation) const AAX_OVERRIDE
CALL: Given an absolute sample position, gets the corresponding tick position.
AAX_VTransport::GetFeetFramesInfo
AAX_Result GetFeetFramesInfo(AAX_EFeetFramesRate *oFeetFramesRate, int64_t *oOffset) const AAX_OVERRIDE
CALL: Retrieves the current timecode feet/frames rate and offset.
AAX_VTransport::GetTimeCodeInfo
AAX_Result GetTimeCodeInfo(AAX_EFrameRate *oFrameRate, int32_t *oOffset) const AAX_OVERRIDE
CALL: Retrieves the current time code frame rate and offset.
AAX_VTransport::IsMetronomeEnabled
AAX_Result IsMetronomeEnabled(int32_t *isEnabled) const AAX_OVERRIDE
Sets isEnabled to true if the metronome is enabled.