-
Notifications
You must be signed in to change notification settings - Fork 1
/
AudioKit-Swift.h
5929 lines (5260 loc) · 184 KB
/
AudioKit-Swift.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Generated by Apple Swift version 3.0.2 (swiftlang-800.0.63 clang-800.0.42.1)
#pragma clang diagnostic push
#if defined(__has_include) && __has_include(<swift/objc-prologue.h>)
# include <swift/objc-prologue.h>
#endif
#pragma clang diagnostic ignored "-Wauto-import"
#include <objc/NSObject.h>
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#if !defined(SWIFT_TYPEDEFS)
# define SWIFT_TYPEDEFS 1
# if defined(__has_include) && __has_include(<uchar.h>)
# include <uchar.h>
# elif !defined(__cplusplus) || __cplusplus < 201103L
typedef uint_least16_t char16_t;
typedef uint_least32_t char32_t;
# endif
typedef float swift_float2 __attribute__((__ext_vector_type__(2)));
typedef float swift_float3 __attribute__((__ext_vector_type__(3)));
typedef float swift_float4 __attribute__((__ext_vector_type__(4)));
typedef double swift_double2 __attribute__((__ext_vector_type__(2)));
typedef double swift_double3 __attribute__((__ext_vector_type__(3)));
typedef double swift_double4 __attribute__((__ext_vector_type__(4)));
typedef int swift_int2 __attribute__((__ext_vector_type__(2)));
typedef int swift_int3 __attribute__((__ext_vector_type__(3)));
typedef int swift_int4 __attribute__((__ext_vector_type__(4)));
typedef unsigned int swift_uint2 __attribute__((__ext_vector_type__(2)));
typedef unsigned int swift_uint3 __attribute__((__ext_vector_type__(3)));
typedef unsigned int swift_uint4 __attribute__((__ext_vector_type__(4)));
#endif
#if !defined(SWIFT_PASTE)
# define SWIFT_PASTE_HELPER(x, y) x##y
# define SWIFT_PASTE(x, y) SWIFT_PASTE_HELPER(x, y)
#endif
#if !defined(SWIFT_METATYPE)
# define SWIFT_METATYPE(X) Class
#endif
#if !defined(SWIFT_CLASS_PROPERTY)
# if __has_feature(objc_class_property)
# define SWIFT_CLASS_PROPERTY(...) __VA_ARGS__
# else
# define SWIFT_CLASS_PROPERTY(...)
# endif
#endif
#if defined(__has_attribute) && __has_attribute(objc_runtime_name)
# define SWIFT_RUNTIME_NAME(X) __attribute__((objc_runtime_name(X)))
#else
# define SWIFT_RUNTIME_NAME(X)
#endif
#if defined(__has_attribute) && __has_attribute(swift_name)
# define SWIFT_COMPILE_NAME(X) __attribute__((swift_name(X)))
#else
# define SWIFT_COMPILE_NAME(X)
#endif
#if defined(__has_attribute) && __has_attribute(objc_method_family)
# define SWIFT_METHOD_FAMILY(X) __attribute__((objc_method_family(X)))
#else
# define SWIFT_METHOD_FAMILY(X)
#endif
#if defined(__has_attribute) && __has_attribute(noescape)
# define SWIFT_NOESCAPE __attribute__((noescape))
#else
# define SWIFT_NOESCAPE
#endif
#if !defined(SWIFT_CLASS_EXTRA)
# define SWIFT_CLASS_EXTRA
#endif
#if !defined(SWIFT_PROTOCOL_EXTRA)
# define SWIFT_PROTOCOL_EXTRA
#endif
#if !defined(SWIFT_ENUM_EXTRA)
# define SWIFT_ENUM_EXTRA
#endif
#if !defined(SWIFT_CLASS)
# if defined(__has_attribute) && __has_attribute(objc_subclassing_restricted)
# define SWIFT_CLASS(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) __attribute__((objc_subclassing_restricted)) SWIFT_CLASS_EXTRA
# define SWIFT_CLASS_NAMED(SWIFT_NAME) __attribute__((objc_subclassing_restricted)) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
# else
# define SWIFT_CLASS(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
# define SWIFT_CLASS_NAMED(SWIFT_NAME) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_CLASS_EXTRA
# endif
#endif
#if !defined(SWIFT_PROTOCOL)
# define SWIFT_PROTOCOL(SWIFT_NAME) SWIFT_RUNTIME_NAME(SWIFT_NAME) SWIFT_PROTOCOL_EXTRA
# define SWIFT_PROTOCOL_NAMED(SWIFT_NAME) SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_PROTOCOL_EXTRA
#endif
#if !defined(SWIFT_EXTENSION)
# define SWIFT_EXTENSION(M) SWIFT_PASTE(M##_Swift_, __LINE__)
#endif
#if !defined(OBJC_DESIGNATED_INITIALIZER)
# if defined(__has_attribute) && __has_attribute(objc_designated_initializer)
# define OBJC_DESIGNATED_INITIALIZER __attribute__((objc_designated_initializer))
# else
# define OBJC_DESIGNATED_INITIALIZER
# endif
#endif
#if !defined(SWIFT_ENUM)
# define SWIFT_ENUM(_type, _name) enum _name : _type _name; enum SWIFT_ENUM_EXTRA _name : _type
# if defined(__has_feature) && __has_feature(generalized_swift_name)
# define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME) enum _name : _type _name SWIFT_COMPILE_NAME(SWIFT_NAME); enum SWIFT_COMPILE_NAME(SWIFT_NAME) SWIFT_ENUM_EXTRA _name : _type
# else
# define SWIFT_ENUM_NAMED(_type, _name, SWIFT_NAME) SWIFT_ENUM(_type, _name)
# endif
#endif
#if !defined(SWIFT_UNAVAILABLE)
# define SWIFT_UNAVAILABLE __attribute__((unavailable))
#endif
#if defined(__has_feature) && __has_feature(modules)
@import ObjectiveC;
@import UIKit;
@import CoreGraphics;
@import AudioToolbox;
@import AVFoundation;
@import Foundation;
@import CoreMIDI;
@import Accelerate;
#endif
#import <AudioKit/AudioKit.h>
#pragma clang diagnostic ignored "-Wproperty-attribute-mismatch"
#pragma clang diagnostic ignored "-Wduplicate-method-arg"
@class AVAudioNode;
/**
Parent class for all nodes in AudioKit
*/
SWIFT_CLASS("_TtC8AudioKit6AKNode")
@interface AKNode : NSObject
/**
The internal AVAudioEngine AVAudioNode
*/
@property (nonatomic, strong) AVAudioNode * _Nonnull avAudioNode;
/**
Create the node
*/
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach OBJC_DESIGNATED_INITIALIZER;
/**
Connect this node to another
*/
- (void)addConnectionPoint:(AKNode * _Nonnull)node bus:(NSInteger)bus;
@end
/**
3-D Spatialization of the input
*/
SWIFT_CLASS("_TtC8AudioKit10AK3DPanner")
@interface AK3DPanner : AKNode
/**
Position of sound source along x-axis
*/
@property (nonatomic) double x;
/**
Position of sound source along y-axis
*/
@property (nonatomic) double y;
/**
Position of sound source along z-axis
*/
@property (nonatomic) double z;
/**
Initialize the panner node
\param input Node to pan in 3D Space
\param x x-axis location in meters
\param y y-axis location in meters
\param z z-axis location in meters
*/
- (nonnull instancetype)init:(AKNode * _Nonnull)input x:(double)x y:(double)y z:(double)z OBJC_DESIGNATED_INITIALIZER;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach SWIFT_UNAVAILABLE;
@end
@class UIColor;
@class NSCoder;
@class UITouch;
@class UIEvent;
/**
A click and draggable view of an ADSR Envelope (Atttack, Decay, Sustain, Release)
*/
SWIFT_CLASS("_TtC8AudioKit10AKADSRView")
@interface AKADSRView : UIView
/**
Attack time in seconds, Default: 0.1
*/
@property (nonatomic) double attackDuration;
/**
Decay time in seconds, Default: 0.1
*/
@property (nonatomic) double decayDuration;
/**
Sustain Level (0-1), Default: 0.5
*/
@property (nonatomic) double sustainLevel;
/**
Release time in seconds, Default: 0.1
*/
@property (nonatomic) double releaseDuration;
/**
Function to call when the values of the ADSR changes
*/
@property (nonatomic, copy) void (^ _Nullable callback)(double, double, double, double);
/**
/ Color Declarations
*/
@property (nonatomic, strong) UIColor * _Nonnull attackColor;
@property (nonatomic, strong) UIColor * _Nonnull decayColor;
@property (nonatomic, strong) UIColor * _Nonnull sustainColor;
@property (nonatomic, strong) UIColor * _Nonnull releaseColor;
@property (nonatomic) CGFloat curveStrokeWidth;
@property (nonatomic, strong) UIColor * _Nonnull curveColor;
- (nonnull instancetype)initWithCallback:(void (^ _Nullable)(double, double, double, double))callback OBJC_DESIGNATED_INITIALIZER;
- (nullable instancetype)initWithCoder:(NSCoder * _Nonnull)aDecoder OBJC_DESIGNATED_INITIALIZER;
- (void)prepareForInterfaceBuilder;
@property (nonatomic, readonly) CGSize intrinsicContentSize;
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) BOOL requiresConstraintBasedLayout;)
+ (BOOL)requiresConstraintBasedLayout;
- (void)touchesBegan:(NSSet<UITouch *> * _Nonnull)touches withEvent:(UIEvent * _Nullable)event;
- (void)touchesMoved:(NSSet<UITouch *> * _Nonnull)touches withEvent:(UIEvent * _Nullable)event;
- (void)drawRect:(CGRect)rect;
- (nonnull instancetype)initWithFrame:(CGRect)frame SWIFT_UNAVAILABLE;
@end
/**
Triggerable classic ADSR envelope
*/
SWIFT_CLASS("_TtC8AudioKit19AKAmplitudeEnvelope")
@interface AKAmplitudeEnvelope : AKNode
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) AudioComponentDescription ComponentDescription;)
+ (AudioComponentDescription)ComponentDescription;
/**
Ramp Time represents the speed at which parameters are allowed to change
*/
@property (nonatomic) double rampTime;
/**
Attack time
*/
@property (nonatomic) double attackDuration;
/**
Decay time
*/
@property (nonatomic) double decayDuration;
/**
Sustain Level
*/
@property (nonatomic) double sustainLevel;
/**
Release time
*/
@property (nonatomic) double releaseDuration;
/**
Tells whether the node is processing (ie. started, playing, or active)
*/
@property (nonatomic, readonly) BOOL isStarted;
/**
Initialize this envelope node
\param input Input node to process
\param attackDuration Attack time
\param decayDuration Decay time
\param sustainLevel Sustain Level
\param releaseDuration Release time
*/
- (nonnull instancetype)init:(AKNode * _Nonnull)input attackDuration:(double)attackDuration decayDuration:(double)decayDuration sustainLevel:(double)sustainLevel releaseDuration:(double)releaseDuration OBJC_DESIGNATED_INITIALIZER;
/**
Function to start, play, or activate the node, all do the same thing
*/
- (void)start;
/**
Function to stop or bypass the node, both are equivalent
*/
- (void)stop;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach SWIFT_UNAVAILABLE;
@end
/**
Performs a “root-mean-square” on a signal to get overall amplitude of a
signal. The output signal looks similar to that of a classic VU meter.
*/
SWIFT_CLASS("_TtC8AudioKit18AKAmplitudeTracker")
@interface AKAmplitudeTracker : AKNode
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) AudioComponentDescription ComponentDescription;)
+ (AudioComponentDescription)ComponentDescription;
/**
Half-power point (in Hz) of internal lowpass filter.
*/
@property (nonatomic) double halfPowerPoint;
/**
Tells whether the node is processing (ie. started, playing, or active)
*/
@property (nonatomic, readonly) BOOL isStarted;
/**
Detected amplitude
*/
@property (nonatomic, readonly) double amplitude;
/**
Initialize this amplitude tracker node
\param input Input node to process
\param halfPowerPoint Half-power point (in Hz) of internal lowpass filter.
*/
- (nonnull instancetype)init:(AKNode * _Nonnull)input halfPowerPoint:(double)halfPowerPoint OBJC_DESIGNATED_INITIALIZER;
/**
Function to start, play, or activate the node, all do the same thing
*/
- (void)start;
/**
Function to stop or bypass the node, both are equivalent
*/
- (void)stop;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach SWIFT_UNAVAILABLE;
@end
@class AVURLAsset;
@class AVAudioPCMBuffer;
/**
Audio file, inherits from AVAudioFile and adds functionality
*/
SWIFT_CLASS("_TtC8AudioKit11AKAudioFile")
@interface AKAudioFile : AVAudioFile
/**
Returns an AVAsset from the AKAudioFile
*/
@property (nonatomic, readonly, strong) AVURLAsset * _Nonnull avAsset;
/**
Returns audio data as an \code
Array
\endcode of \code
Float
\endcode Arrays.
If stereo:
<ul>
<li>
\code
floatChannelData?[0]
\endcode will contain an Array of left channel samples as \code
Float
\endcode
</li>
<li>
\code
floatChannelData?[1]
\endcode will contains an Array of right channel samples as \code
Float
\endcode
</li>
</ul>
*/
@property (nonatomic, copy) NSArray<NSArray<NSNumber *> *> * _Nullable floatChannelData;
/**
returns audio data as an AVAudioPCMBuffer
*/
@property (nonatomic, strong) AVAudioPCMBuffer * _Nonnull pcmBuffer;
/**
returns the peak level expressed in dB ( -> Float).
*/
@property (nonatomic) float maxLevel;
/**
Initialize the audio file
\param fileURL URL of the file
returns:
An initialized AKAudioFile object for reading, or nil if init failed.
*/
- (nullable instancetype)initForReading:(NSURL * _Nonnull)fileURL error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
/**
Initialize the audio file
\param fileURL URL of the file
\param format The processing commonFormat to use when reading from the file.
\param interleaved Whether to use an interleaved processing format.
returns:
An initialized AKAudioFile object for reading, or nil if init failed.
*/
- (nullable instancetype)initForReading:(NSURL * _Nonnull)fileURL commonFormat:(AVAudioCommonFormat)format interleaved:(BOOL)interleaved error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
/**
Initialize the audio file
From Apple doc: The file type to create is inferred from the file extension of fileURL.
This method will overwrite a file at the specified URL if a file already exists.
The file is opened for writing using the standard format, AVAudioPCMFormatFloat32.
Note: It seems that Apple’s AVAudioFile class has a bug with .wav files. They cannot be set
with a floating Point encoding. As a consequence, such files will fail to record properly.
So it’s better to use .caf (or .aif) files for recording purpose.
\param fileURL URL of the file.
\param settings The format of the file to create.
\param format The processing commonFormat to use when writing.
\param interleaved Whether to use an interleaved processing format.
throws:
NSError if init failed
returns:
An initialized AKAudioFile for writing, or nil if init failed.
*/
- (nullable instancetype)initForWriting:(NSURL * _Nonnull)fileURL settings:(NSDictionary<NSString *, id> * _Nonnull)settings commonFormat:(AVAudioCommonFormat)format interleaved:(BOOL)interleaved error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
/**
Super.init inherited from AVAudioFile superclass
From Apple doc: The file type to create is inferred from the file extension of fileURL.
This method will overwrite a file at the specified URL if a file already exists.
The file is opened for writing using the standard format, AVAudioPCMFormatFloat32.
Note: It seems that Apple’s AVAudioFile class has a bug with .wav files. They cannot be set
with a floating Point encoding. As a consequence, such files will fail to record properly.
So it’s better to use .caf (or .aif) files for recording purpose.
\param fileURL URL of the file.
\param settings The settings of the file to create.
returns:
An initialized AKAudioFile for writing, or nil if init failed.
*/
- (nullable instancetype)initForWriting:(NSURL * _Nonnull)fileURL settings:(NSDictionary<NSString *, id> * _Nonnull)settings error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
@end
@interface AKAudioFile (SWIFT_EXTENSION(AudioKit))
@end
@interface AKAudioFile (SWIFT_EXTENSION(AudioKit))
@end
@interface AKAudioFile (SWIFT_EXTENSION(AudioKit))
@end
@class AKSampler;
@class AKMIDISampler;
@class AKAudioPlayer;
@interface AKAudioFile (SWIFT_EXTENSION(AudioKit))
/**
Create an AKSampler loaded with the current AKAudioFile
*/
@property (nonatomic, readonly, strong) AKSampler * _Nullable sampler;
/**
Create an AKMIDISampler loaded with the current AKAudioFile
*/
@property (nonatomic, readonly, strong) AKMIDISampler * _Nullable midiSampler;
/**
Create an AKAudioPlayer to play the current AKAudioFile
*/
@property (nonatomic, readonly, strong) AKAudioPlayer * _Nullable player;
@end
@interface AKAudioFile (SWIFT_EXTENSION(AudioKit))
/**
Returns the remaining not completed queued Async processes (Int)
*/
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) NSInteger queuedAsyncProcessCount;)
+ (NSInteger)queuedAsyncProcessCount;
/**
Returns the total scheduled Async processes count (Int)
*/
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) NSInteger scheduledAsyncProcessesCount;)
+ (NSInteger)scheduledAsyncProcessesCount;
/**
Returns the completed Async processes count (Int)
*/
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) NSInteger completedAsyncProcessesCount;)
+ (NSInteger)completedAsyncProcessesCount;
@end
/**
Not so simple audio playback class
*/
SWIFT_CLASS("_TtC8AudioKit13AKAudioPlayer")
@interface AKAudioPlayer : AKNode
/**
Will be triggered when AKAudioPlayer has finished to play.
(will not as long as loop is on)
*/
@property (nonatomic, copy) void (^ _Nullable completionHandler)(void);
/**
Boolean indicating whether or not to loop the playback
*/
@property (nonatomic) BOOL looping;
/**
return the current played AKAudioFile
*/
@property (nonatomic, readonly, strong) AKAudioFile * _Nonnull audioFile;
@property (nonatomic, readonly, copy) NSString * _Nonnull path;
/**
Total duration of one loop through of the file
*/
@property (nonatomic, readonly) double duration;
/**
Output Volume (Default 1)
*/
@property (nonatomic) double volume;
/**
Whether or not the audio player is currently started
*/
@property (nonatomic, readonly) BOOL isStarted;
/**
Current playback time (in seconds)
*/
@property (nonatomic, readonly) double currentTime;
/**
Time within the audio file at the current time
*/
@property (nonatomic, readonly) double playhead;
/**
Pan (Default Center = 0)
*/
@property (nonatomic) double pan;
/**
sets the start time, If it is playing, player will
restart playing from the start time each time end time is set
*/
@property (nonatomic) double startTime;
/**
sets the end time, If it is playing, player will
restart playing from the start time each time end time is set
*/
@property (nonatomic) double endTime;
/**
Sets the time in the future when playback will commence. For immediately playback, leave it 0.
*/
@property (nonatomic) double scheduledTime;
/**
Initialize the audio player
Notice that completionCallBack will be triggered from a
background thread. Any UI update should be made using:
\code
Dispatch.main.async {
// UI updates...
}
\endcode\param file the AKAudioFile to play
\param looping will loop play if set to true, or stop when play ends, so it can trig the completionHandler callback. Default is false (non looping)
\param completionHandler AKCallback that will be triggered when the player end playing (useful for refreshing UI so we’re not playing anymore, we stopped playing…
returns:
an AKAudioPlayer if init succeeds, or nil if init fails. If fails, errors may be catched as it is a throwing init.
*/
- (nullable instancetype)initWithFile:(AKAudioFile * _Nonnull)file looping:(BOOL)looping error:(NSError * _Nullable * _Nullable)error completionHandler:(void (^ _Nullable)(void))completionHandler OBJC_DESIGNATED_INITIALIZER;
/**
Start playback
*/
- (void)start;
/**
Stop playback
*/
- (void)stop;
/**
Pause playback
*/
- (void)pause;
/**
resets in and out times for playing
*/
- (BOOL)reloadFileAndReturnError:(NSError * _Nullable * _Nullable)error;
/**
Replace player’s file with a new AKAudioFile file
*/
- (BOOL)replaceWithFile:(AKAudioFile * _Nonnull)file error:(NSError * _Nullable * _Nullable)error;
/**
Play the file back from a certain time, to an end time (if set). You can optionally set a scheduled time to play (in seconds).
\param time Time into the file at which to start playing back
\param endTime Time into the file at which to playing back will stop / Loop
\param scheduledTime Time in the future to start playback. This is useful for scheduling a group of sounds to
start concurrently, or to simply schedule the start time.
*/
- (void)playFrom:(double)time to:(double)endTime when:(double)scheduledTime;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach SWIFT_UNAVAILABLE;
@end
/**
An automatic wah effect, ported from Guitarix via Faust.
*/
SWIFT_CLASS("_TtC8AudioKit9AKAutoWah")
@interface AKAutoWah : AKNode
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) AudioComponentDescription ComponentDescription;)
+ (AudioComponentDescription)ComponentDescription;
/**
Ramp Time represents the speed at which parameters are allowed to change
*/
@property (nonatomic) double rampTime;
/**
Wah Amount
*/
@property (nonatomic) double wah;
/**
Dry/Wet Mix
*/
@property (nonatomic) double mix;
/**
Overall level
*/
@property (nonatomic) double amplitude;
/**
Tells whether the node is processing (ie. started, playing, or active)
*/
@property (nonatomic, readonly) BOOL isStarted;
/**
Initialize this autoWah node
\param input Input node to process
\param wah Wah Amount
\param mix Dry/Wet Mix
\param amplitude Overall level
*/
- (nonnull instancetype)init:(AKNode * _Nonnull)input wah:(double)wah mix:(double)mix amplitude:(double)amplitude OBJC_DESIGNATED_INITIALIZER;
/**
Function to start, play, or activate the node, all do the same thing
*/
- (void)start;
/**
Function to stop or bypass the node, both are equivalent
*/
- (void)stop;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach SWIFT_UNAVAILABLE;
@end
/**
This node outputs a version of the audio source, amplitude-modified so
that its rms power is equal to that of the comparator audio source. Thus a
signal that has suffered loss of power (eg., in passing through a filter
bank) can be restored by matching it with, for instance, its own source. It
should be noted that this modifies amplitude only; output signal is not
altered in any other respect.
*/
SWIFT_CLASS("_TtC8AudioKit10AKBalancer")
@interface AKBalancer : AKNode
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) AudioComponentDescription ComponentDescription;)
+ (AudioComponentDescription)ComponentDescription;
/**
Tells whether the node is processing (ie. started, playing, or active)
*/
@property (nonatomic, readonly) BOOL isStarted;
/**
Initialize this balance node
\param input Input node to process
\param comparator Audio to match power with
*/
- (nonnull instancetype)init:(AKNode * _Nonnull)input comparator:(AKNode * _Nonnull)comparator OBJC_DESIGNATED_INITIALIZER;
/**
Function to start, play, or activate the node, all do the same thing
*/
- (void)start;
/**
Function to stop or bypass the node, both are equivalent
*/
- (void)stop;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach SWIFT_UNAVAILABLE;
@end
/**
These filters are Butterworth second-order IIR filters. They offer an almost
flat passband and very good precision and stopband attenuation.
*/
SWIFT_CLASS("_TtC8AudioKit27AKBandPassButterworthFilter")
@interface AKBandPassButterworthFilter : AKNode
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) AudioComponentDescription ComponentDescription;)
+ (AudioComponentDescription)ComponentDescription;
/**
Ramp Time represents the speed at which parameters are allowed to change
*/
@property (nonatomic) double rampTime;
/**
Center frequency. (in Hertz)
*/
@property (nonatomic) double centerFrequency;
/**
Bandwidth. (in Hertz)
*/
@property (nonatomic) double bandwidth;
/**
Tells whether the node is processing (ie. started, playing, or active)
*/
@property (nonatomic, readonly) BOOL isStarted;
/**
Initialize this filter node
\param input Input node to process
\param centerFrequency Center frequency. (in Hertz)
\param bandwidth Bandwidth. (in Hertz)
*/
- (nonnull instancetype)init:(AKNode * _Nonnull)input centerFrequency:(double)centerFrequency bandwidth:(double)bandwidth OBJC_DESIGNATED_INITIALIZER;
/**
Function to start, play, or activate the node, all do the same thing
*/
- (void)start;
/**
Function to stop or bypass the node, both are equivalent
*/
- (void)stop;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach SWIFT_UNAVAILABLE;
@end
/**
AudioKit version of Apple’s BandPassFilter Audio Unit
*/
SWIFT_CLASS("_TtC8AudioKit16AKBandPassFilter")
@interface AKBandPassFilter : AKNode
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) AudioComponentDescription ComponentDescription;)
+ (AudioComponentDescription)ComponentDescription;
/**
Center Frequency (Hz) ranges from 20 to 22050 (Default: 5000)
*/
@property (nonatomic) double centerFrequency;
/**
Bandwidth (Cents) ranges from 100 to 12000 (Default: 600)
*/
@property (nonatomic) double bandwidth;
/**
Dry/Wet Mix (Default 100)
*/
@property (nonatomic) double dryWetMix;
/**
Tells whether the node is processing (ie. started, playing, or active)
*/
@property (nonatomic) BOOL isStarted;
/**
Initialize the band pass filter node
\param input Input node to process
\param centerFrequency Center Frequency (Hz) ranges from 20 to 22050 (Default: 5000)
\param bandwidth Bandwidth (Cents) ranges from 100 to 12000 (Default: 600)
*/
- (nonnull instancetype)init:(AKNode * _Nonnull)input centerFrequency:(double)centerFrequency bandwidth:(double)bandwidth OBJC_DESIGNATED_INITIALIZER;
/**
Function to start, play, or activate the node, all do the same thing
*/
- (void)start;
/**
Function to stop or bypass the node, both are equivalent
*/
- (void)stop;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach SWIFT_UNAVAILABLE;
@end
/**
These filters are Butterworth second-order IIR filters. They offer an almost
flat passband and very good precision and stopband attenuation.
*/
SWIFT_CLASS("_TtC8AudioKit29AKBandRejectButterworthFilter")
@interface AKBandRejectButterworthFilter : AKNode
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) AudioComponentDescription ComponentDescription;)
+ (AudioComponentDescription)ComponentDescription;
/**
Ramp Time represents the speed at which parameters are allowed to change
*/
@property (nonatomic) double rampTime;
/**
Center frequency. (in Hertz)
*/
@property (nonatomic) double centerFrequency;
/**
Bandwidth. (in Hertz)
*/
@property (nonatomic) double bandwidth;
/**
Tells whether the node is processing (ie. started, playing, or active)
*/
@property (nonatomic, readonly) BOOL isStarted;
/**
Initialize this filter node
\param input Input node to process
\param centerFrequency Center frequency. (in Hertz)
\param bandwidth Bandwidth. (in Hertz)
*/
- (nonnull instancetype)init:(AKNode * _Nonnull)input centerFrequency:(double)centerFrequency bandwidth:(double)bandwidth OBJC_DESIGNATED_INITIALIZER;
/**
Function to start, play, or activate the node, all do the same thing
*/
- (void)start;
/**
Function to stop or bypass the node, both are equivalent
*/
- (void)stop;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach SWIFT_UNAVAILABLE;
@end
/**
This will digitally degrade a signal.
*/
SWIFT_CLASS("_TtC8AudioKit12AKBitCrusher")
@interface AKBitCrusher : AKNode
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) AudioComponentDescription ComponentDescription;)
+ (AudioComponentDescription)ComponentDescription;
/**
Ramp Time represents the speed at which parameters are allowed to change
*/
@property (nonatomic) double rampTime;
/**
The bit depth of signal output. Typically in range (1-24). Non-integer values are OK.
*/
@property (nonatomic) double bitDepth;
/**
The sample rate of signal output.
*/
@property (nonatomic) double sampleRate;
/**
Tells whether the node is processing (ie. started, playing, or active)
*/
@property (nonatomic, readonly) BOOL isStarted;
/**
Initialize this bitcrusher node
\param input Input node to process
\param bitDepth The bit depth of signal output. Typically in range (1-24). Non-integer values are OK.
\param sampleRate The sample rate of signal output.
*/
- (nonnull instancetype)init:(AKNode * _Nonnull)input bitDepth:(double)bitDepth sampleRate:(double)sampleRate OBJC_DESIGNATED_INITIALIZER;
/**
Function to start, play, or activate the node, all do the same thing
*/
- (void)start;
/**
Function to stop or bypass the node, both are equivalent
*/
- (void)stop;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach SWIFT_UNAVAILABLE;
@end
/**
Stereo Booster
*/
SWIFT_CLASS("_TtC8AudioKit9AKBooster")
@interface AKBooster : AKNode
SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly) AudioComponentDescription ComponentDescription;)
+ (AudioComponentDescription)ComponentDescription;
/**
Ramp Time represents the speed at which parameters are allowed to change
*/
@property (nonatomic) double rampTime;
/**
Amplification Factor
*/
@property (nonatomic) double gain;
/**
Amplification Factor in db
*/
@property (nonatomic) double dB;
/**
Tells whether the node is processing (ie. started, playing, or active)
*/
@property (nonatomic, readonly) BOOL isStarted;
/**
Initialize this gainner node
\param input AKNode whose output will be amplified
\param gain Amplification factor (Default: 1, Minimum: 0)
*/
- (nonnull instancetype)init:(AKNode * _Nonnull)input gain:(double)gain OBJC_DESIGNATED_INITIALIZER;
/**
Function to start, play, or activate the node, all do the same thing
*/
- (void)start;
/**
Function to stop or bypass the node, both are equivalent
*/
- (void)stop;
- (nonnull instancetype)init SWIFT_UNAVAILABLE;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach SWIFT_UNAVAILABLE;
@end
SWIFT_CLASS("_TtC8AudioKit8AKButton")
@interface AKButton : UIView
@property (nonatomic, copy) NSString * _Nonnull title;
@property (nonatomic, strong) UIColor * _Nonnull color;
- (void)touchesBegan:(NSSet<UITouch *> * _Nonnull)touches withEvent:(UIEvent * _Nullable)event;
- (nonnull instancetype)initWithTitle:(NSString * _Nonnull)title color:(UIColor * _Nonnull)color frame:(CGRect)frame callback:(NSString * _Nonnull (^ _Nonnull)(void))callback OBJC_DESIGNATED_INITIALIZER;
- (nullable instancetype)initWithCoder:(NSCoder * _Nonnull)aDecoder OBJC_DESIGNATED_INITIALIZER;
- (void)drawRect:(CGRect)rect;
- (nonnull instancetype)initWithFrame:(CGRect)frame SWIFT_UNAVAILABLE;
@end
/**
Button that just access the start/stop feature of an AKNode,
primarily used for playgrounds, but potentially useful in your own code.
*/
SWIFT_CLASS("_TtC8AudioKit14AKBypassButton")
@interface AKBypassButton : UIView
- (void)touchesBegan:(NSSet<UITouch *> * _Nonnull)touches withEvent:(UIEvent * _Nullable)event;
/**
Required initializer
*/
- (nullable instancetype)initWithCoder:(NSCoder * _Nonnull)aDecoder OBJC_DESIGNATED_INITIALIZER;
/**
Draw the button
*/
- (void)drawRect:(CGRect)rect;
- (nonnull instancetype)initWithFrame:(CGRect)frame SWIFT_UNAVAILABLE;
@end
/**
Bare bones implementation of AKPolyphonic protocol
*/
SWIFT_CLASS("_TtC8AudioKit16AKPolyphonicNode")
@interface AKPolyphonicNode : AKNode
/**
Play a sound corresponding to a MIDI note
\param noteNumber MIDI Note Number
\param velocity MIDI Velocity
*/
- (void)playWithNoteNumber:(NSInteger)noteNumber velocity:(NSInteger)velocity;
/**
Stop a sound corresponding to a MIDI note
\param noteNumber MIDI Note Number
*/
- (void)stopWithNoteNumber:(NSInteger)noteNumber;
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
- (nonnull instancetype)initWithAvAudioNode:(AVAudioNode * _Nonnull)avAudioNode attach:(BOOL)attach OBJC_DESIGNATED_INITIALIZER;
@end
/**
A version of AKInstrument specifically targeted to instruments that
should be triggerable via MIDI or sequenced with the sequencer.
*/
SWIFT_CLASS("_TtC8AudioKit16AKMIDIInstrument")
@interface AKMIDIInstrument : AKPolyphonicNode
/**
MIDI Input
*/
@property (nonatomic) MIDIEndpointRef midiIn;
/**
Name of the instrument
*/
@property (nonatomic, copy) NSString * _Nonnull name;