AEAudioUnitInputModule.h
Go to the documentation of this file.
1 //
2 // AEAudioUnitInputModule.h
3 // TheAmazingAudioEngine
4 //
5 // Created by Michael Tyson on 25/03/2016.
6 // Copyright © 2016 A Tasty Pixel. All rights reserved.
7 //
8 // This software is provided 'as-is', without any express or implied
9 // warranty. In no event will the authors be held liable for any damages
10 // arising from the use of this software.
11 //
12 // Permission is granted to anyone to use this software for any purpose,
13 // including commercial applications, and to alter it and redistribute it
14 // freely, subject to the following restrictions:
15 //
16 // 1. The origin of this software must not be misrepresented; you must not
17 // claim that you wrote the original software. If you use this software
18 // in a product, an acknowledgment in the product documentation would be
19 // appreciated but is not required.
20 //
21 // 2. Altered source versions must be plainly marked as such, and must not be
22 // misrepresented as being the original software.
23 //
24 // 3. This notice may not be removed or altered from any source distribution.
25 //
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 #import "AEModule.h"
32 #import "AETime.h"
33 
48 
61 - (BOOL)setup:(NSError * __autoreleasing _Nullable * _Nullable)error;
62 
71 - (BOOL)start:(NSError * __autoreleasing _Nullable * _Nullable)error;
72 
76 - (void)stop;
77 
86 AudioUnit _Nullable AEAudioUnitInputModuleGetAudioUnit(__unsafe_unretained AEAudioUnitInputModule * _Nonnull module);
87 
96 AudioTimeStamp AEAudioUnitInputModuleGetInputTimestamp(__unsafe_unretained AEAudioUnitInputModule * _Nonnull module);
97 
98 #if TARGET_OS_IPHONE
99 
109 AESeconds AEAudioUnitInputModuleGetInputLatency(__unsafe_unretained AEAudioUnitInputModule * _Nonnull module);
110 
111 #endif
112 
113 @property (nonatomic, readonly) AudioUnit _Nullable audioUnit;
114 @property (nonatomic, readonly) BOOL running;
115 @property (nonatomic, readonly) int numberOfInputChannels;
116 @property (nonatomic) double inputGain;
117 
118 #if TARGET_OS_IPHONE
119 @property (nonatomic) BOOL latencyCompensation;
120 #endif
121 
122 @end
123 
124 
125 #ifdef __cplusplus
126 }
127 #endif