-
Notifications
You must be signed in to change notification settings - Fork 25
Expand file tree
/
Copy pathSKMicrophoneConfiguration.h
More file actions
120 lines (104 loc) · 3.56 KB
/
Copy pathSKMicrophoneConfiguration.h
File metadata and controls
120 lines (104 loc) · 3.56 KB
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
//
// SKMicrophoneConfiguration.h
// SensingKit
//
// Copyright (c) 2014. Kleomenis Katevas
// Kleomenis Katevas, minos.kat@gmail.com
//
// This file is part of SensingKit-iOS library.
// For more information, please visit https://www.sensingkit.org
//
// SensingKit-iOS is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// SensingKit-iOS is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with SensingKit-iOS. If not, see <http://www.gnu.org/licenses/>.
//
#import <Foundation/Foundation.h>
#import <SensingKit/SKConfiguration.h>
/**
* These constants indicate the recording format of the Microphone sensor.
*/
typedef NS_ENUM(NSUInteger, SKMicrophoneRecordingFormat){
/**
* Linear PCM is an uncompressed audio data format.
*/
SKMicrophoneRecordingFormatLinearPCM = 0,
/**
* MPEG-4 AAC audio data format.
*/
SKMicrophoneRecordingFormatMPEG4AAC
};
/**
* These constants indicate the recording quality of the Microphone sensor.
*/
typedef NS_ENUM(NSUInteger, SKMicrophoneRecordingQuality){
/**
* Minimum recording quality
*/
SKMicrophoneRecordingQualityMin = 0,
/**
* Low recording quality
*/
SKMicrophoneRecordingQualityLow,
/**
* Medium recording quality
*/
SKMicrophoneRecordingQualityMedium,
/**
* High recording quality
*/
SKMicrophoneRecordingQualityHigh,
/**
* Maximum recording quality
*/
SKMicrophoneRecordingQualityMax
};
NS_ASSUME_NONNULL_BEGIN
/**
* An instance of SKMicrophoneConfiguration can be used to configure the Microphone sensor.
*/
@interface SKMicrophoneConfiguration : SKConfiguration <NSCopying>
- (instancetype)init NS_UNAVAILABLE;
/**
* Returns an SKMicrophoneConfiguration object, initialized with the path of the directory, as well as the filename that the recording will be stored.
*
* @param outputDirectory Path of the directory that the recording will be stored.
* @param filename A string with the desired filename of the recording, without the extension. Extension will be provided automatically based on the recordingFormat.
*
* @return A new SKMicrophoneConfiguration object.
*/
- (instancetype)initWithOutputDirectory:(NSURL *)outputDirectory withFilename:(NSString *)filename NS_DESIGNATED_INITIALIZER;
/**
* Path of the directory that the recording will be stored.
*/
@property (nonatomic, copy) NSURL *outputDirectory;
/**
* A string with the desired filename of the recording, without the extension. Extension will be provided automatically based on the recordingFormat.
*/
@property (nonatomic, copy) NSString *filename;
/**
* A read-only property that returns the full path of the recording filename.
*/
@property (nonatomic, copy, readonly) NSURL *recordingPath;
/**
* Recording format of the Microphone sensor.
*/
@property (nonatomic) SKMicrophoneRecordingFormat recordingFormat;
/**
* Recording quality of the Microphone sensor.
*/
@property (nonatomic) SKMicrophoneRecordingQuality recordingQuality;
/**
* The audio format sampling rate in hertz.
*/
@property (nonatomic) float sampleRate;
@end
NS_ASSUME_NONNULL_END