AEAudioFilePlayerModule.h

Go to the documentation of this file.

//
//  AEAudioFilePlayerModule.m
//  The Amazing Audio Engine
//
//  Created by Michael Tyson on 30/03/2016.
//
//  Contributions by Ryan King and Jeremy Huff of Hello World Engineering, Inc on 7/15/15.
//      Copyright (c) 2015 Hello World Engineering, Inc. All rights reserved.
//  Contributions by Ryan Holmes
//
//  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 "AEAudioUnitModule.h"
#import "AETime.h"

typedef void (^AEAudioFilePlayerModuleBlock)();

@interface AEAudioFilePlayerModule : AEAudioUnitModule

- (instancetype _Nullable)initWithRenderer:(AERenderer * _Nullable)renderer
                                       URL:(NSURL * _Nonnull)url
                                     error:(NSError * _Nullable * _Nullable)error;

- (void)playAtTime:(AudioTimeStamp)time;

- (void)playAtTime:(AudioTimeStamp)time beginBlock:(AEAudioFilePlayerModuleBlock _Nullable)block;

- (void)stop;

AESeconds AEAudioFilePlayerModuleGetPlayhead(__unsafe_unretained AEAudioFilePlayerModule * _Nonnull filePlayer,
                                             AEHostTicks time);

BOOL AEAudioFilePlayerModuleGetPlaying(__unsafe_unretained AEAudioFilePlayerModule * _Nonnull filePlayer);

@property (nonatomic, strong, readonly) NSURL * _Nullable url;

@property (nonatomic, readonly) AESeconds duration;

@property (nonatomic, assign) AESeconds regionStartTime;

@property (nonatomic, assign) AESeconds regionDuration;

@property (nonatomic, assign) AESeconds currentTime;

@property (nonatomic, readonly) BOOL playing;

@property (nonatomic, readwrite) BOOL loop;

@property (nonatomic) UInt32 microfadeFrames;

@property (nonatomic, copy) AEAudioFilePlayerModuleBlock _Nullable completionBlock;

@end
    
#ifdef __cplusplus
}
#endif