AEBlockChannel.h
Go to the documentation of this file.
1 //
2 // AEBlockChannel.h
3 // TheAmazingAudioEngine
4 //
5 // Created by Michael Tyson on 20/12/2012.
6 //
7 // This software is provided 'as-is', without any express or implied
8 // warranty. In no event will the authors be held liable for any damages
9 // arising from the use of this software.
10 //
11 // Permission is granted to anyone to use this software for any purpose,
12 // including commercial applications, and to alter it and redistribute it
13 // freely, subject to the following restrictions:
14 //
15 // 1. The origin of this software must not be misrepresented; you must not
16 // claim that you wrote the original software. If you use this software
17 // in a product, an acknowledgment in the product documentation would be
18 // appreciated but is not required.
19 //
20 // 2. Altered source versions must be plainly marked as such, and must not be
21 // misrepresented as being the original software.
22 //
23 // 3. This notice may not be removed or altered from any source distribution.
24 //
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 #import <Foundation/Foundation.h>
32 
33 typedef void (^AEBlockChannelBlock)(const AudioTimeStamp *time,
34  UInt32 frames,
35  AudioBufferList *audio);
36 
40 @interface AEBlockChannel : NSObject <AEAudioPlayable>
41 
47 + (AEBlockChannel*)channelWithBlock:(AEBlockChannelBlock)block;
48 
54 @property (nonatomic, assign) float volume;
55 
61 @property (nonatomic, assign) float pan;
62 
63 /*
64  * Whether channel is currently playing
65  *
66  * If this is NO, then the track will be silenced and no further render callbacks
67  * will be performed until set to YES again.
68  */
69 @property (nonatomic, assign) BOOL channelIsPlaying;
70 
71 /*
72  * Whether channel is muted
73  *
74  * If YES, track will be silenced, but render callbacks will continue to be performed.
75  */
76 @property (nonatomic, assign) BOOL channelIsMuted;
77 
78 /*
79  * The audio format for this channel
80  */
81 @property (nonatomic, assign) AudioStreamBasicDescription audioDescription;
82 
83 @end
84 
85 #ifdef __cplusplus
86 }
87 #endif