blob: de67ae34edc2d2a8a48d9cab3c19c0869d588ef4 (
plain)
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
|
// SDLPerformAudioPassThru.h
//
#import "SDLRPCRequest.h"
#import "SDLAudioType.h"
#import "SDLBitsPerSample.h"
#import "SDLSamplingRate.h"
@class SDLTTSChunk;
/**
* This will open an audio pass thru session. By doing so the app can receive
* audio data through the vehicle microphone
* <p>
* Function Group: AudioPassThru
* <p>
* <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
* </p>
*
* <p>Since SmartDeviceLink 2.0</p>
* <p>See SDLEndAudioPassThru</p>
*/
NS_ASSUME_NONNULL_BEGIN
@interface SDLPerformAudioPassThru : SDLRPCRequest
- (instancetype)initWithSamplingRate:(SDLSamplingRate)samplingRate bitsPerSample:(SDLBitsPerSample)bitsPerSample audioType:(SDLAudioType)audioType maxDuration:(UInt32)maxDuration;
- (instancetype)initWithInitialPrompt:(nullable NSString *)initialPrompt audioPassThruDisplayText1:(nullable NSString *)audioPassThruDisplayText1 audioPassThruDisplayText2:(nullable NSString *)audioPassThruDisplayText2 samplingRate:(SDLSamplingRate)samplingRate bitsPerSample:(SDLBitsPerSample)bitsPerSample audioType:(SDLAudioType)audioType maxDuration:(UInt32)maxDuration muteAudio:(BOOL)muteAudio;
/**
* @abstract initial prompt which will be spoken before opening the audio pass
* thru session by SDL
* @discussion initialPrompt
* a Vector<TTSChunk> value represents the initial prompt which
* will be spoken before opening the audio pass thru session by
* SDL
* <p>
* <b>Notes: </b>
* <ul>
* <li>This is an array of text chunks of type TTSChunk</li>
* <li>The array must have at least one item</li>
* <li>If omitted, then no initial prompt is spoken</li>
* <li>Array Minsize: 1</li>
* <li>Array Maxsize: 100</li>
* </ul>
*/
@property (nullable, strong) NSMutableArray<SDLTTSChunk *> *initialPrompt;
/**
* @abstract a line of text displayed during audio capture
* @discussion audioPassThruDisplayText1
* a String value representing the line of text displayed during
* audio capture
* <p>
* <b>Notes: </b>Maxlength=500
*/
@property (nullable, strong) NSString *audioPassThruDisplayText1;
/**
* @abstract A line of text displayed during audio capture
* @discussion audioPassThruDisplayText2
* a String value representing the line of text displayed during
* audio capture
* <p>
* <b>Notes: </b>Maxlength=500
*/
@property (nullable, strong) NSString *audioPassThruDisplayText2;
/**
* @abstract A samplingRate
*
* @discussion a SamplingRate value representing a 8 or 16 or 22 or 24 khz
*/
@property (strong) SDLSamplingRate samplingRate;
/**
* @abstract the maximum duration of audio recording in milliseconds
*
* @discussion maxDuration
* an Integer value representing the maximum duration of audio
* recording in millisecond
* <p>
* <b>Notes: </b>Minvalue:1; Maxvalue:1000000
*/
@property (strong) NSNumber<SDLInt> *maxDuration;
/**
* @abstract the quality the audio is recorded - 8 bit or 16 bit
*
* @discussion a BitsPerSample value representing 8 bit or 16 bit
*/
@property (strong) SDLBitsPerSample bitsPerSample;
/**
* @abstract an audioType
*/
@property (strong) SDLAudioType audioType;
/**
* @abstract a Boolean value representing if the current audio source should be
* muted during the APT session<br/>
*/
@property (nullable, strong) NSNumber<SDLBool> *muteAudio;
@end
NS_ASSUME_NONNULL_END
|
