AEAudioUnitOutput.h
Go to the documentation of this file.
1 //
2 // AEAudioUnitOutput.h
3 // TheAmazingAudioEngine
4 //
5 // Created by Michael Tyson on 23/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 <Foundation/Foundation.h>
32 #import <AudioToolbox/AudioToolbox.h>
33 #import "AETime.h"
34 
35 @class AERenderer;
37 
39 extern NSString * const _Nonnull AEAudioUnitOutputDidChangeSampleRateNotification;
40 
43 
49 @interface AEAudioUnitOutput : NSObject
50 
56 - (instancetype _Nullable)initWithRenderer:(AERenderer * _Nonnull)renderer;
57 
68 - (BOOL)setup:(NSError * __autoreleasing _Nullable * _Nullable)error;
69 
76 - (BOOL)start:(NSError * __autoreleasing _Nullable * _Nullable)error;
77 
81 - (void)stop;
82 
91 AudioUnit _Nullable AEAudioUnitOutputGetAudioUnit(__unsafe_unretained AEAudioUnitOutput * _Nonnull output);
92 
93 #if TARGET_OS_IPHONE
94 
104 AESeconds AEAudioUnitOutputGetOutputLatency(__unsafe_unretained AEAudioUnitOutput * _Nonnull output);
105 
106 #endif
107 
109 @property (nonatomic, strong) AERenderer * _Nullable renderer;
110 
112 @property (nonatomic, readonly) AudioUnit _Nullable audioUnit;
113 
115 @property (nonatomic) double sampleRate;
116 
118 @property (nonatomic, readonly) double currentSampleRate;
119 
121 @property (nonatomic, readonly) BOOL running;
122 
124 @property (nonatomic, readonly) int numberOfOutputChannels;
125 
126 #if TARGET_OS_IPHONE
127 
128 @property (nonatomic) BOOL latencyCompensation;
129 #endif
130 
144 @property (nonatomic, strong, readonly) AEAudioUnitInputModule * _Nonnull inputModule;
145 
146 @end
147 
148 #ifdef __cplusplus
149 }
150 #endif