VLCKit
VLCAudioEqualizer.h
1 /*****************************************************************************
2  * VLCAudioEqualizer.h: VLCKit.framework VLCAudioEqualizer header
3  *****************************************************************************
4  * Copyright (C) 2023 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors:
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23 
24 #import <Foundation/Foundation.h>
25 
26 NS_ASSUME_NONNULL_BEGIN
27 
29 NS_SWIFT_NAME(VLCAudioEqualizer.Preset)
30 @interface VLCAudioEqualizerPreset : NSObject
31 
33 @property (nonatomic, copy, readonly) NSString *name;
35 @property (nonatomic, readonly) unsigned index;
36 
37 + (instancetype)new NS_UNAVAILABLE;
38 - (instancetype)init NS_UNAVAILABLE;
39 
40 @end
41 
43 NS_SWIFT_NAME(VLCAudioEqualizer.Band)
44 @interface VLCAudioEqualizerBand : NSObject
45 
49 @property (nonatomic, readonly) float frequency;
50 
54 @property (nonatomic, readonly) unsigned index;
55 
59 @property (nonatomic) float amplification;
60 
61 + (instancetype)new NS_UNAVAILABLE;
62 - (instancetype)init NS_UNAVAILABLE;
63 
64 @end
65 
67 NS_SWIFT_NAME(VLCAudioEqualizer)
68 @interface VLCAudioEqualizer : NSObject
69 
71 @property (class, nonatomic, copy, readonly) NSArray<VLCAudioEqualizerPreset *> *presets;
72 
76 @property (nonatomic) float preAmplification;
77 
79 @property (nonatomic, copy, readonly) NSArray<VLCAudioEqualizerBand *> *bands;
80 
81 - (instancetype)init;
82 - (instancetype)initWithPreset:(VLCAudioEqualizerPreset *)preset;
83 
84 @end
85 
86 NS_ASSUME_NONNULL_END
VLCAudioEqualizerPreset::name
NSString * name
equalizer preset name
Definition: VLCAudioEqualizer.h:54
VLCAudioEqualizerPreset
VLCAudioEqualizerPreset.
Definition: VLCAudioEqualizer.h:30
VLCAudioEqualizer
VLCAudioEqualizer.
Definition: VLCAudioEqualizer.h:68
VLCAudioEqualizerPreset::index
unsigned index
equalizer preset index
Definition: VLCAudioEqualizer.h:56
VLCAudioEqualizerBand
VLCAudioEqualizerBand.
Definition: VLCAudioEqualizer.h:44