AEAudioFileOutput.h

Go to the documentation of this file.

//
//  AEAudioFileOutput.h
//  TheAmazingAudioEngine
//
//  Created by Michael Tyson on 7/04/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"
#import "AETypes.h"

@class AERenderer;

typedef void (^AEAudioFileOutputCompletionBlock)(NSError * _Nullable error);

/*
 * Condition block
 *
 *  For use with @link AEAudioFileOutput::runUntilCondition:completionBlock: runUntilCondition:completionBlock: @endlink
 *
 * @returns Whether to stop (YES) or continue (NO)
 */
typedef BOOL (^AEAudioFileOutputConditionBlock)();

@interface AEAudioFileOutput : NSObject

- (instancetype _Nullable)initWithRenderer:(AERenderer * _Nonnull)renderer
                                       URL:(NSURL * _Nonnull)url
                                      type:(AEAudioFileType)type
                                sampleRate:(double)sampleRate
                              channelCount:(int)channelCount
                                     error:(NSError * _Nullable * _Nullable)error;

- (void)runForDuration:(AESeconds)duration completionBlock:(AEAudioFileOutputCompletionBlock _Nonnull)completionBlock;

- (void)runUntilCondition:(AEAudioFileOutputConditionBlock _Nonnull)conditionBlock
          completionBlock:(AEAudioFileOutputCompletionBlock _Nonnull)completionBlock;

- (void)finishWriting;

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

@property (nonatomic, readonly) double sampleRate;

@property (nonatomic, readonly) int numberOfChannels;

@property (nonatomic, strong, readonly) NSURL * _Nonnull fileURL;

@property (nonatomic, readonly) UInt64 numberOfFramesRecorded;

@end

    
#ifdef __cplusplus
}
#endif