| 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_ITask.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
33#ifndef AAX_ITask_H
34#define AAX_ITask_H
35
36#include "AAX_IACFTask.h"
37#include "AAX.h"
38
39 class AAX_IACFDataBuffer;
40
41
60 class AAX_ITask
61{
62 public:
63 virtual ~AAX_ITask() = default;
64
71 virtual AAX_Result GetType(AAX_CTypeID * oType) const = 0;
72
86 virtual AAX_IACFDataBuffer const * GetArgumentOfType(AAX_CTypeID iType) const = 0;
87
94 virtual AAX_Result SetProgress(float iProgress) = 0;
95
99 virtual float GetProgress() const = 0;
100
119 virtual AAX_Result AddResult(AAX_IACFDataBuffer const * iResult) = 0;
120
138 virtual AAX_ITask * SetDone(AAX_TaskCompletionStatus iStatus) = 0;
139};
140
141
142#endif
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_CTypeID
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:346
AAX_IACFTask.h
Defines the interface representing an asynchronous task.
AAX_TaskCompletionStatus
AAX_TaskCompletionStatus
Definition: AAX_IACFTask.h:55
AAX_IACFDataBuffer
Versioned interface for reference counted data buffers.
Definition: AAX_IACFDataBuffer.h:54
AAX_ITask
Interface representing a request to perform a task.
Definition: AAX_ITask.h:61
AAX_ITask::SetProgress
virtual AAX_Result SetProgress(float iProgress)=0
AAX_ITask::SetDone
virtual AAX_ITask * SetDone(AAX_TaskCompletionStatus iStatus)=0
Inform the host that the task is completed.
AAX_ITask::~AAX_ITask
virtual ~AAX_ITask()=default
AAX_ITask::GetProgress
virtual float GetProgress() const =0
AAX_ITask::GetType
virtual AAX_Result GetType(AAX_CTypeID *oType) const =0
AAX_ITask::GetArgumentOfType
virtual AAX_IACFDataBuffer const * GetArgumentOfType(AAX_CTypeID iType) const =0
AAX_ITask::AddResult
virtual AAX_Result AddResult(AAX_IACFDataBuffer const *iResult)=0
Attach result data to this task.