| 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_VSessionDocument.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_VSessionDocument_H
33#define AAX_VSessionDocument_H
34
35#include "AAX_ISessionDocument.h"
36#include "ACFPtr.h"
37
38 class AAX_IACFSessionDocument;
39 class AAX_IDataBufferWrapper;
40
41 class AAX_VSessionDocument : public AAX_ISessionDocument
42{
43 public:
44 explicit AAX_VSessionDocument(IACFUnknown * iUnknown);
45 ~AAX_VSessionDocument() AAX_OVERRIDE;
46
47 class VTempoMap : public AAX_ISessionDocument::TempoMap
48 {
49 public:
50 ~VTempoMap() AAX_OVERRIDE;
51 explicit VTempoMap(IACFUnknown & inDataBuffer);
52 int32_t Size() const AAX_OVERRIDE;
53 AAX_CTempoBreakpoint const * Data() const AAX_OVERRIDE;
54 private:
55 std::unique_ptr<AAX_IDataBufferWrapper const> mDataBuffer;
56 };
57
61 void Clear();
62
63 bool Valid() const AAX_OVERRIDE;
64 std::unique_ptr<AAX_ISessionDocument::TempoMap const> GetTempoMap() AAX_OVERRIDE;
65 AAX_Result GetDocumentData(AAX_DocumentData_UID const & inDataType, IACFUnknown ** outData) AAX_OVERRIDE;
66
67private:
68 ACFPtr<AAX_IACFSessionDocument> mSessionDocumentV1;
69};
70
71#endif // AAX_VSessionDocument_H
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_OVERRIDE
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:164
AAX_ISessionDocument.h
_acfUID
Definition: AAX_ACFInterface.doxygen:229
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:265
AAX_IACFSessionDocument
Interface representing information in a host session document.
Definition: AAX_IACFSessionDocument.h:51
AAX_IDataBufferWrapper
Wrapper for an AAX_IDataBuffer.
Definition: AAX_IDataBufferWrapper.h:49
AAX_ISessionDocument
Interface representing information in a host session document.
Definition: AAX_ISessionDocument.h:52
AAX_ISessionDocument::TempoMap
Definition: AAX_ISessionDocument.h:57
AAX_CTempoBreakpoint
Definition: AAX_SessionDocumentTypes.h:45
AAX_VSessionDocument
Definition: AAX_VSessionDocument.h:42
AAX_VSessionDocument::GetDocumentData
AAX_Result GetDocumentData(AAX_DocumentData_UID const &inDataType, IACFUnknown **outData) AAX_OVERRIDE
AAX_VSessionDocument::Clear
void Clear()
Release all interface references.
AAX_VSessionDocument::Valid
bool Valid() const AAX_OVERRIDE
Check whether this session document is valid.
AAX_VSessionDocument::~AAX_VSessionDocument
~AAX_VSessionDocument() AAX_OVERRIDE
AAX_VSessionDocument::AAX_VSessionDocument
AAX_VSessionDocument(IACFUnknown *iUnknown)
AAX_VSessionDocument::GetTempoMap
std::unique_ptr< AAX_ISessionDocument::TempoMap const > GetTempoMap() AAX_OVERRIDE
Get a copy of the document's tempo map.
AAX_VSessionDocument::VTempoMap
Definition: AAX_VSessionDocument.h:48
AAX_VSessionDocument::VTempoMap::~VTempoMap
~VTempoMap() AAX_OVERRIDE