| 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_ISessionDocument.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 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
29/*================================================================================================*/
30
31#pragma once
32#ifndef AAX_ISessionDocument_H
33#define AAX_ISessionDocument_H
34
35#include "AAX_SessionDocumentTypes.h"
36#include "AAX_UIDs.h"
37#include "AAX.h"
38#include <memory>
39
40 class IACFUnknown;
41
51 class AAX_ISessionDocument
52{
53 public:
54 virtual ~AAX_ISessionDocument() = default;
55
56 class TempoMap
57 {
58 public:
59 virtual ~TempoMap() = default;
60 virtual int32_t Size() const = 0;
61 virtual AAX_CTempoBreakpoint const * Data() const = 0;
62 };
63
67 virtual bool Valid() const = 0;
68
77 virtual std::unique_ptr<TempoMap const> GetTempoMap() = 0;
78
108 virtual AAX_Result GetDocumentData(AAX_DocumentData_UID const & inDataType, IACFUnknown ** outData) = 0;
109};
110
111#endif // AAX_ISessionDocument_H
AAX_SessionDocumentTypes.h
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_UIDs.h
Unique identifiers for AAX/ACF interfaces.
_acfUID
Definition: AAX_ACFInterface.doxygen:229
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:265
AAX_ISessionDocument
Interface representing information in a host session document.
Definition: AAX_ISessionDocument.h:52
AAX_ISessionDocument::GetDocumentData
virtual AAX_Result GetDocumentData(AAX_DocumentData_UID const &inDataType, IACFUnknown **outData)=0
AAX_ISessionDocument::~AAX_ISessionDocument
virtual ~AAX_ISessionDocument()=default
AAX_ISessionDocument::Valid
virtual bool Valid() const =0
Check whether this session document is valid.
AAX_ISessionDocument::GetTempoMap
virtual std::unique_ptr< TempoMap const > GetTempoMap()=0
Get a copy of the document's tempo map.
AAX_ISessionDocument::TempoMap
Definition: AAX_ISessionDocument.h:57
AAX_ISessionDocument::TempoMap::Size
virtual int32_t Size() const =0
AAX_ISessionDocument::TempoMap::Data
virtual AAX_CTempoBreakpoint const * Data() const =0
AAX_ISessionDocument::TempoMap::~TempoMap
virtual ~TempoMap()=default
AAX_CTempoBreakpoint
Definition: AAX_SessionDocumentTypes.h:45