AEAudioUnitOutput.h

Go to the documentation of this file.

//
//  AEAudioUnitOutput.h
//  TheAmazingAudioEngine
//
//  Created by Michael Tyson on 23/03/2016.
//  Copyright © 2016 A Tasty Pixel. All rights reserved.
//
//  This software is provided 'as-is', without any express or implied
//  warranty.  In no event will the authors be held liable for any damages
//  arising from the use of this software.
//
//  Permission is granted to anyone to use this software for any purpose,
//  including commercial applications, and to alter it and redistribute it
//  freely, subject to the following restrictions:
//
//  1. The origin of this software must not be misrepresented; you must not
//     claim that you wrote the original software. If you use this software
//     in a product, an acknowledgment in the product documentation would be
//     appreciated but is not required.
//
//  2. Altered source versions must be plainly marked as such, and must not be
//     misrepresented as being the original software.
//
//  3. This notice may not be removed or altered from any source distribution.
//

#ifdef __cplusplus
extern "C" {
#endif

#import <Foundation/Foundation.h>
#import <AudioToolbox/AudioToolbox.h>
#import "AETime.h"

@class AERenderer;
@class AEAudioUnitInputModule;
    
extern NSString * const _Nonnull AEAudioUnitOutputDidChangeSampleRateNotification;

extern NSString * const _Nonnull AEAudioUnitOutputDidChangeNumberOfOutputChannelsNotification;

@interface AEAudioUnitOutput : NSObject

- (instancetype _Nullable)initWithRenderer:(AERenderer * _Nonnull)renderer;

- (BOOL)setup:(NSError * __autoreleasing _Nullable * _Nullable)error;

- (BOOL)start:(NSError * __autoreleasing _Nullable * _Nullable)error;

- (void)stop;

AudioUnit _Nullable AEAudioUnitOutputGetAudioUnit(__unsafe_unretained AEAudioUnitOutput * _Nonnull output);

#if TARGET_OS_IPHONE

AESeconds AEAudioUnitOutputGetOutputLatency(__unsafe_unretained AEAudioUnitOutput * _Nonnull output);

#endif

@property (nonatomic, strong) AERenderer * _Nullable renderer;

@property (nonatomic, readonly) AudioUnit _Nullable audioUnit;

@property (nonatomic) double sampleRate;

@property (nonatomic, readonly) double currentSampleRate;

@property (nonatomic, readonly) BOOL running;

@property (nonatomic, readonly) int numberOfOutputChannels;

#if TARGET_OS_IPHONE

@property (nonatomic) BOOL latencyCompensation;
#endif

@property (nonatomic, strong, readonly) AEAudioUnitInputModule * _Nonnull inputModule;

@end

#ifdef __cplusplus
}
#endif