| 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_VPageTable.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 * Copyright 2016-2017, 2019, 2023-2024 Avid Technology, Inc.
4 * All rights reserved.
5 *
6 * This file is part of the Avid AAX SDK.
7 *
8 * The AAX SDK is subject to commercial or open-source licensing.
9 *
10 * By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
11 * Agreement and Avid Privacy Policy.
12 *
13 * AAX SDK License: https://developer.avid.com/aax
14 * Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
15 *
16 * Or: You may also use this code under the terms of the GPL v3 (see
17 * www.gnu.org/licenses).
18 *
19 * THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
20 * EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
21 * DISCLAIMED.
22 */
23
24#ifndef AAXLibrary_AAX_VPageTable_h
25#define AAXLibrary_AAX_VPageTable_h
26
27#include "AAX_IPageTable.h"
28#include "AAX_IACFPageTable.h"
29#include "ACFPtr.h"
30
35 class AAX_VPageTable : public AAX_IPageTable
36{
37 public:
38 AAX_VPageTable( IACFUnknown* pUnknown );
39 ~AAX_VPageTable() AAX_OVERRIDE;
40
41 // AAX_IACFPageTable
42 AAX_Result Clear() AAX_OVERRIDE;
43 AAX_Result Empty(AAX_CBoolean& oEmpty) const AAX_OVERRIDE;
44 AAX_Result GetNumPages(int32_t& oNumPages) const AAX_OVERRIDE;
45 AAX_Result InsertPage(int32_t iPage) AAX_OVERRIDE;
46 AAX_Result RemovePage(int32_t iPage) AAX_OVERRIDE;
47 AAX_Result GetNumMappedParameterIDs(int32_t iPage, int32_t& oNumParameterIdentifiers) const AAX_OVERRIDE;
48 AAX_Result ClearMappedParameter(int32_t iPage, int32_t iIndex) AAX_OVERRIDE;
49 AAX_Result GetMappedParameterID(int32_t iPage, int32_t iIndex, AAX_IString& oParameterIdentifier) const AAX_OVERRIDE;
50 AAX_Result MapParameterID(AAX_CParamID iParameterIdentifier, int32_t iPage, int32_t iIndex) AAX_OVERRIDE;
51
52 // AAX_IACFPageTable_V2
53 AAX_Result GetNumParametersWithNameVariations(int32_t& oNumParameterIdentifiers) const AAX_OVERRIDE;
54 AAX_Result GetNameVariationParameterIDAtIndex(int32_t iIndex, AAX_IString& oParameterIdentifier) const AAX_OVERRIDE;
55 AAX_Result GetNumNameVariationsForParameter(AAX_CPageTableParamID iParameterIdentifier, int32_t& oNumVariations) const AAX_OVERRIDE;
56 AAX_Result GetParameterNameVariationAtIndex(AAX_CPageTableParamID iParameterIdentifier, int32_t iIndex, AAX_IString& oNameVariation, int32_t& oLength) const AAX_OVERRIDE;
57 AAX_Result GetParameterNameVariationOfLength(AAX_CPageTableParamID iParameterIdentifier, int32_t iLength, AAX_IString& oNameVariation) const AAX_OVERRIDE;
58 AAX_Result ClearParameterNameVariations() AAX_OVERRIDE;
59 AAX_Result ClearNameVariationsForParameter(AAX_CPageTableParamID iParameterIdentifier) AAX_OVERRIDE;
60 AAX_Result SetParameterNameVariation(AAX_CPageTableParamID iParameterIdentifier, const AAX_IString& iNameVariation, int32_t iLength) AAX_OVERRIDE;
61
62 // AAX_VPageTable
63
67 const IACFUnknown* AsUnknown() const
68 {
69 return mIPageTable.inArg();
70 }
71
74 IACFUnknown* AsUnknown()
75 {
76 return mIPageTable.inArg();
77 }
78
79 bool IsSupported() const { return !mIPageTable.isNull(); }
80
81 private:
82 ACFPtr<AAX_IACFPageTable> mIPageTable;
83 ACFPtr<AAX_IACFPageTable_V2> mIPageTable2;
84};
85
86#endif
AAX_CParamID
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:362
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_CBoolean
uint8_t AAX_CBoolean
Cross-compiler boolean type used by AAX interfaces.
Definition: AAX.h:339
AAX_CPageTableParamID
AAX_CParamID AAX_CPageTableParamID
Parameter identifier used in a page table.
Definition: AAX.h:363
AAX_OVERRIDE
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:164
AAX_IPageTable.h
AAX_IACFPageTable.h
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:265
AAX_IPageTable
Interface to the host's representation of a plug-in instance's page table.
Definition: AAX_IPageTable.h:38
AAX_IString
A simple string container that can be passed across a binary boundary. This class,...
Definition: AAX_IString.h:51
AAX_VPageTable
Version-managed concrete AAX_IPageTable class.
Definition: AAX_VPageTable.h:36
AAX_VPageTable::GetNumParametersWithNameVariations
AAX_Result GetNumParametersWithNameVariations(int32_t &oNumParameterIdentifiers) const AAX_OVERRIDE
AAX_VPageTable::GetNumNameVariationsForParameter
AAX_Result GetNumNameVariationsForParameter(AAX_CPageTableParamID iParameterIdentifier, int32_t &oNumVariations) const AAX_OVERRIDE
AAX_VPageTable::GetParameterNameVariationAtIndex
AAX_Result GetParameterNameVariationAtIndex(AAX_CPageTableParamID iParameterIdentifier, int32_t iIndex, AAX_IString &oNameVariation, int32_t &oLength) const AAX_OVERRIDE
AAX_VPageTable::GetNumMappedParameterIDs
AAX_Result GetNumMappedParameterIDs(int32_t iPage, int32_t &oNumParameterIdentifiers) const AAX_OVERRIDE
Returns the total number of parameter IDs which are mapped to a page.
AAX_VPageTable::RemovePage
AAX_Result RemovePage(int32_t iPage) AAX_OVERRIDE
Remove the page at index iPage.
AAX_VPageTable::GetNameVariationParameterIDAtIndex
AAX_Result GetNameVariationParameterIDAtIndex(int32_t iIndex, AAX_IString &oParameterIdentifier) const AAX_OVERRIDE
AAX_VPageTable::GetParameterNameVariationOfLength
AAX_Result GetParameterNameVariationOfLength(AAX_CPageTableParamID iParameterIdentifier, int32_t iLength, AAX_IString &oNameVariation) const AAX_OVERRIDE
AAX_VPageTable::ClearParameterNameVariations
AAX_Result ClearParameterNameVariations() AAX_OVERRIDE
AAX_VPageTable::MapParameterID
AAX_Result MapParameterID(AAX_CParamID iParameterIdentifier, int32_t iPage, int32_t iIndex) AAX_OVERRIDE
Map a parameter to this table.
AAX_VPageTable::InsertPage
AAX_Result InsertPage(int32_t iPage) AAX_OVERRIDE
Insert a new empty page before the page at index iPage.
AAX_VPageTable::SetParameterNameVariation
AAX_Result SetParameterNameVariation(AAX_CPageTableParamID iParameterIdentifier, const AAX_IString &iNameVariation, int32_t iLength) AAX_OVERRIDE
AAX_VPageTable::ClearMappedParameter
AAX_Result ClearMappedParameter(int32_t iPage, int32_t iIndex) AAX_OVERRIDE
Clear the parameter at a particular index in this table.
AAX_VPageTable::ClearNameVariationsForParameter
AAX_Result ClearNameVariationsForParameter(AAX_CPageTableParamID iParameterIdentifier) AAX_OVERRIDE
AAX_VPageTable::AAX_VPageTable
AAX_VPageTable(IACFUnknown *pUnknown)
AAX_VPageTable::AsUnknown
IACFUnknown * AsUnknown()
Definition: AAX_VPageTable.h:74
AAX_VPageTable::~AAX_VPageTable
~AAX_VPageTable() AAX_OVERRIDE
AAX_VPageTable::Clear
AAX_Result Clear() AAX_OVERRIDE
Clears all parameter mappings from the table.
AAX_VPageTable::GetMappedParameterID
AAX_Result GetMappedParameterID(int32_t iPage, int32_t iIndex, AAX_IString &oParameterIdentifier) const AAX_OVERRIDE
Get the parameter identifier which is currently mapped to an index in this table.
AAX_VPageTable::AsUnknown
const IACFUnknown * AsUnknown() const
Definition: AAX_VPageTable.h:67
AAX_VPageTable::GetNumPages
AAX_Result GetNumPages(int32_t &oNumPages) const AAX_OVERRIDE
Get the number of pages currently in this table.
AAX_VPageTable::IsSupported
bool IsSupported() const
Definition: AAX_VPageTable.h:79
AAX_VPageTable::Empty
AAX_Result Empty(AAX_CBoolean &oEmpty) const AAX_OVERRIDE
Indicates whether the table is empty.