| AAX SDK 2.6.1 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- File List
- File Members

Loading...
Searching...
No Matches
AAX_IACFTask.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2023 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * CONFIDENTIAL: this document contains confidential information of Avid. Do
8 * not disclose to any third party. Use of the information contained in this
9 * document is subject to an Avid SDK license.
10 *
11 */
12
19/*================================================================================================*/
20
21#pragma once
22
23#ifndef AAX_IACFTask_H
24#define AAX_IACFTask_H
25
26#include "AAX.h"
27
28#ifdef __clang__
29#pragma clang diagnostic push
30#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
31#endif
32
33#include "acfunknown.h"
34
35 class AAX_IACFDataBuffer;
36
42 enum class AAX_TaskCompletionStatus : int32_t {
43 None = 0
44 ,Done = 1
45 ,Canceled = 2
46 ,Error = 3
47};
48
56 class AAX_IACFTask : public IACFUnknown
57{
58 public:
59 virtual AAX_Result GetType(AAX_CTypeID * oType) const = 0;
60 virtual AAX_IACFDataBuffer const * GetArgumentOfType(AAX_CTypeID iType) const = 0;
61
62 virtual AAX_Result SetProgress(float iProgress) = 0;
63 virtual float GetProgress() const = 0;
64
65 virtual AAX_Result AddResult(AAX_IACFDataBuffer const * iResult) = 0;
66
78 virtual AAX_Result SetDone(AAX_TaskCompletionStatus iStatus) = 0;
79};
80
81#ifdef __clang__
82#pragma clang diagnostic pop
83#endif
84
85#endif //AAX_IACFTask_H
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
AAX_CTypeID
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:333
AAX_TaskCompletionStatus
AAX_TaskCompletionStatus
Definition: AAX_IACFTask.h:42
AAX_TaskCompletionStatus::Canceled
@ Canceled
AAX_TaskCompletionStatus::None
@ None
AAX_TaskCompletionStatus::Error
@ Error
AAX_TaskCompletionStatus::Done
@ Done
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:252
AAX_IACFDataBuffer
Versioned interface for reference counted data buffers.
Definition: AAX_IACFDataBuffer.h:41
AAX_IACFTask
Versioned interface for an asynchronous task.
Definition: AAX_IACFTask.h:57
AAX_IACFTask::GetArgumentOfType
virtual AAX_IACFDataBuffer const * GetArgumentOfType(AAX_CTypeID iType) const =0
AAX_IACFTask::GetProgress
virtual float GetProgress() const =0
AAX_IACFTask::AddResult
virtual AAX_Result AddResult(AAX_IACFDataBuffer const *iResult)=0
Attach result data to this task.
AAX_IACFTask::SetDone
virtual AAX_Result SetDone(AAX_TaskCompletionStatus iStatus)=0
Inform the host that the task is completed.
AAX_IACFTask::GetType
virtual AAX_Result GetType(AAX_CTypeID *oType) const =0
AAX_IACFTask::SetProgress
virtual AAX_Result SetProgress(float iProgress)=0