-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmicrosoft.cognitiveservices.speech.sdk.bundle.d.ts
7629 lines (7438 loc) · 326 KB
/
microsoft.cognitiveservices.speech.sdk.bundle.d.ts
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 dts-bundle v0.7.3
// Dependencies for this module:
// ../../fs
import { PathLike } from "fs";
/**
* Represents audio input configuration used for specifying what type of input to use (microphone, file, stream).
* @class AudioConfig
* Updated in version 1.11.0
*/
export abstract class AudioConfig {
/**
* Creates an AudioConfig object representing the default microphone on the system.
* @member AudioConfig.fromDefaultMicrophoneInput
* @function
* @public
* @returns {AudioConfig} The audio input configuration being created.
*/
static fromDefaultMicrophoneInput(): AudioConfig;
/**
* Creates an AudioConfig object representing a microphone with the specified device ID.
* @member AudioConfig.fromMicrophoneInput
* @function
* @public
* @param {string | undefined} deviceId - Specifies the device ID of the microphone to be used.
* Default microphone is used the value is omitted.
* @returns {AudioConfig} The audio input configuration being created.
*/
static fromMicrophoneInput(deviceId?: string): AudioConfig;
/**
* Creates an AudioConfig object representing the specified file.
* @member AudioConfig.fromWavFileInput
* @function
* @public
* @param {File} fileName - Specifies the audio input file. Currently, only WAV / PCM is supported.
* @returns {AudioConfig} The audio input configuration being created.
*/
static fromWavFileInput(file: File): AudioConfig;
/**
* Creates an AudioConfig object representing the specified stream.
* @member AudioConfig.fromStreamInput
* @function
* @public
* @param {AudioInputStream | PullAudioInputStreamCallback | MediaStream} audioStream - Specifies the custom audio input
* stream. Currently, only WAV / PCM is supported.
* @returns {AudioConfig} The audio input configuration being created.
*/
static fromStreamInput(audioStream: AudioInputStream | PullAudioInputStreamCallback | MediaStream): AudioConfig;
/**
* Creates an AudioConfig object representing the default speaker.
* @member AudioConfig.fromDefaultSpeakerOutput
* @function
* @public
* @returns {AudioConfig} The audio output configuration being created.
* Added in version 1.11.0
*/
static fromDefaultSpeakerOutput(): AudioConfig;
/**
* Creates an AudioConfig object representing the custom IPlayer object.
* You can use the IPlayer object to control pause, resume, etc.
* @member AudioConfig.fromSpeakerOutput
* @function
* @public
* @param {IPlayer} player - the IPlayer object for playback.
* @returns {AudioConfig} The audio output configuration being created.
* Added in version 1.12.0
*/
static fromSpeakerOutput(player?: IPlayer): AudioConfig;
/**
* Creates an AudioConfig object representing a specified output audio file
* @member AudioConfig.fromAudioFileOutput
* @function
* @public
* @param {PathLike} filename - the filename of the output audio file
* @returns {AudioConfig} The audio output configuration being created.
* Added in version 1.11.0
*/
static fromAudioFileOutput(filename: PathLike): AudioConfig;
/**
* Creates an AudioConfig object representing a specified audio output stream
* @member AudioConfig.fromStreamOutput
* @function
* @public
* @param {AudioOutputStream | PushAudioOutputStreamCallback} audioStream - Specifies the custom audio output
* stream.
* @returns {AudioConfig} The audio output configuration being created.
* Added in version 1.11.0
*/
static fromStreamOutput(audioStream: AudioOutputStream | PushAudioOutputStreamCallback): AudioConfig;
/**
* Explicitly frees any external resource attached to the object
* @member AudioConfig.prototype.close
* @function
* @public
*/
abstract close(): void;
/**
* Sets an arbitrary property.
* @member SpeechConfig.prototype.setProperty
* @function
* @public
* @param {string} name - The name of the property to set.
* @param {string} value - The new value of the property.
*/
abstract setProperty(name: string, value: string): void;
/**
* Returns the current value of an arbitrary property.
* @member SpeechConfig.prototype.getProperty
* @function
* @public
* @param {string} name - The name of the property to query.
* @param {string} def - The value to return in case the property is not known.
* @returns {string} The current value, or provided default, of the given property.
*/
abstract getProperty(name: string, def?: string): string;
}
/**
* Represents audio input stream used for custom audio input configurations.
* @private
* @class AudioConfigImpl
*/
export class AudioConfigImpl extends AudioConfig implements IAudioSource {
/**
* Creates and initializes an instance of this class.
* @constructor
* @param {IAudioSource} source - An audio source.
*/
constructor(source: IAudioSource);
/**
* Format information for the audio
*/
get format(): Promise<AudioStreamFormatImpl>;
/**
* @member AudioConfigImpl.prototype.close
* @function
* @public
*/
close(cb?: () => void, err?: (error: string) => void): void;
/**
* @member AudioConfigImpl.prototype.id
* @function
* @public
*/
id(): string;
/**
* @member AudioConfigImpl.prototype.blob
* @function
* @public
*/
get blob(): Promise<Blob | Buffer>;
/**
* @member AudioConfigImpl.prototype.turnOn
* @function
* @public
* @returns {Promise<void>} A promise.
*/
turnOn(): Promise<void>;
/**
* @member AudioConfigImpl.prototype.attach
* @function
* @public
* @param {string} audioNodeId - The audio node id.
* @returns {Promise<IAudioStreamNode>} A promise.
*/
attach(audioNodeId: string): Promise<IAudioStreamNode>;
/**
* @member AudioConfigImpl.prototype.detach
* @function
* @public
* @param {string} audioNodeId - The audio node id.
*/
detach(audioNodeId: string): void;
/**
* @member AudioConfigImpl.prototype.turnOff
* @function
* @public
* @returns {Promise<void>} A promise.
*/
turnOff(): Promise<void>;
/**
* @member AudioConfigImpl.prototype.events
* @function
* @public
* @returns {EventSource<AudioSourceEvent>} An event source for audio events.
*/
get events(): EventSource<AudioSourceEvent>;
setProperty(name: string, value: string): void;
getProperty(name: string, def?: string): string;
get deviceInfo(): Promise<ISpeechConfigAudioDevice>;
}
export class AudioOutputConfigImpl extends AudioConfig implements IAudioDestination {
/**
* Creates and initializes an instance of this class.
* @constructor
* @param {IAudioDestination} destination - An audio destination.
*/
constructor(destination: IAudioDestination);
set format(format: AudioStreamFormat);
write(buffer: ArrayBuffer): void;
close(): void;
id(): string;
setProperty(name: string, value: string): void;
getProperty(name: string, def?: string): string;
}
/**
* Represents audio stream format used for custom audio input configurations.
* @class AudioStreamFormat
*/
export abstract class AudioStreamFormat {
/**
* Creates an audio stream format object representing the default audio stream
* format (16KHz 16bit mono PCM).
* @member AudioStreamFormat.getDefaultInputFormat
* @function
* @public
* @returns {AudioStreamFormat} The audio stream format being created.
*/
static getDefaultInputFormat(): AudioStreamFormat;
/**
* Creates an audio stream format object with the specified pcm waveformat characteristics.
* @member AudioStreamFormat.getWaveFormatPCM
* @function
* @public
* @param {number} samplesPerSecond - Sample rate, in samples per second (Hertz).
* @param {number} bitsPerSample - Bits per sample, typically 16.
* @param {number} channels - Number of channels in the waveform-audio data. Monaural data
* uses one channel and stereo data uses two channels.
* @returns {AudioStreamFormat} The audio stream format being created.
*/
static getWaveFormatPCM(samplesPerSecond: number, bitsPerSample: number, channels: number): AudioStreamFormat;
/**
* Explicitly frees any external resource attached to the object
* @member AudioStreamFormat.prototype.close
* @function
* @public
*/
abstract close(): void;
}
/**
* @private
* @class AudioStreamFormatImpl
*/
export class AudioStreamFormatImpl extends AudioStreamFormat {
protected privHeader: ArrayBuffer;
/**
* Creates an instance with the given values.
* @constructor
* @param {number} samplesPerSec - Samples per second.
* @param {number} bitsPerSample - Bits per sample.
* @param {number} channels - Number of channels.
*/
constructor(samplesPerSec?: number, bitsPerSample?: number, channels?: number);
/**
* Retrieves the default input format.
* @member AudioStreamFormatImpl.getDefaultInputFormat
* @function
* @public
* @returns {AudioStreamFormatImpl} The default input format.
*/
static getDefaultInputFormat(): AudioStreamFormatImpl;
/**
* Creates an audio context appropriate to current browser
* @member AudioStreamFormatImpl.getAudioContext
* @function
* @public
* @returns {AudioContext} An audio context instance
*/
static getAudioContext(sampleRate?: number): AudioContext;
/**
* Closes the configuration object.
* @member AudioStreamFormatImpl.prototype.close
* @function
* @public
*/
close(): void;
/**
* The format of the audio, valid values: 1 (PCM)
* @member AudioStreamFormatImpl.prototype.formatTag
* @function
* @public
*/
formatTag: number;
/**
* The number of channels, valid values: 1 (Mono).
* @member AudioStreamFormatImpl.prototype.channels
* @function
* @public
*/
channels: number;
/**
* The sample rate, valid values: 16000.
* @member AudioStreamFormatImpl.prototype.samplesPerSec
* @function
* @public
*/
samplesPerSec: number;
/**
* The bits per sample, valid values: 16
* @member AudioStreamFormatImpl.prototype.b
* @function
* @public
*/
bitsPerSample: number;
/**
* Average bytes per second, usually calculated as nSamplesPerSec * nChannels * ceil(wBitsPerSample, 8).
* @member AudioStreamFormatImpl.prototype.avgBytesPerSec
* @function
* @public
*/
avgBytesPerSec: number;
/**
* The size of a single frame, valid values: nChannels * ceil(wBitsPerSample, 8).
* @member AudioStreamFormatImpl.prototype.blockAlign
* @function
* @public
*/
blockAlign: number;
get header(): ArrayBuffer;
protected setString: (view: DataView, offset: number, str: string) => void;
}
/**
* Represents audio input stream used for custom audio input configurations.
* @class AudioInputStream
*/
export abstract class AudioInputStream {
/**
* Creates and initializes an instance.
* @constructor
*/
protected constructor();
/**
* Creates a memory backed PushAudioInputStream with the specified audio format.
* @member AudioInputStream.createPushStream
* @function
* @public
* @param {AudioStreamFormat} format - The audio data format in which audio will be
* written to the push audio stream's write() method (Required if format is not 16 kHz 16bit mono PCM).
* @returns {PushAudioInputStream} The audio input stream being created.
*/
static createPushStream(format?: AudioStreamFormat): PushAudioInputStream;
/**
* Creates a PullAudioInputStream that delegates to the specified callback interface for read()
* and close() methods.
* @member AudioInputStream.createPullStream
* @function
* @public
* @param {PullAudioInputStreamCallback} callback - The custom audio input object, derived from
* PullAudioInputStreamCallback
* @param {AudioStreamFormat} format - The audio data format in which audio will be returned from
* the callback's read() method (Required if format is not 16 kHz 16bit mono PCM).
* @returns {PullAudioInputStream} The audio input stream being created.
*/
static createPullStream(callback: PullAudioInputStreamCallback, format?: AudioStreamFormat): PullAudioInputStream;
/**
* Explicitly frees any external resource attached to the object
* @member AudioInputStream.prototype.close
* @function
* @public
*/
abstract close(): void;
}
/**
* Represents memory backed push audio input stream used for custom audio input configurations.
* @class PushAudioInputStream
*/
export abstract class PushAudioInputStream extends AudioInputStream {
/**
* Creates a memory backed PushAudioInputStream with the specified audio format.
* @member PushAudioInputStream.create
* @function
* @public
* @param {AudioStreamFormat} format - The audio data format in which audio will be written to the
* push audio stream's write() method (Required if format is not 16 kHz 16bit mono PCM).
* @returns {PushAudioInputStream} The push audio input stream being created.
*/
static create(format?: AudioStreamFormat): PushAudioInputStream;
/**
* Writes the audio data specified by making an internal copy of the data.
* @member PushAudioInputStream.prototype.write
* @function
* @public
* @param {ArrayBuffer} dataBuffer - The audio buffer of which this function will make a copy.
*/
abstract write(dataBuffer: ArrayBuffer): void;
/**
* Closes the stream.
* @member PushAudioInputStream.prototype.close
* @function
* @public
*/
abstract close(): void;
}
/**
* Represents memory backed push audio input stream used for custom audio input configurations.
* @private
* @class PushAudioInputStreamImpl
*/
export class PushAudioInputStreamImpl extends PushAudioInputStream implements IAudioSource {
/**
* Creates and initalizes an instance with the given values.
* @constructor
* @param {AudioStreamFormat} format - The audio stream format.
*/
constructor(format?: AudioStreamFormat);
/**
* Format information for the audio
*/
get format(): Promise<AudioStreamFormatImpl>;
/**
* Writes the audio data specified by making an internal copy of the data.
* @member PushAudioInputStreamImpl.prototype.write
* @function
* @public
* @param {ArrayBuffer} dataBuffer - The audio buffer of which this function will make a copy.
*/
write(dataBuffer: ArrayBuffer): void;
/**
* Closes the stream.
* @member PushAudioInputStreamImpl.prototype.close
* @function
* @public
*/
close(): void;
id(): string;
get blob(): Promise<Blob | Buffer>;
turnOn(): Promise<void>;
attach(audioNodeId: string): Promise<IAudioStreamNode>;
detach(audioNodeId: string): void;
turnOff(): Promise<void>;
get events(): EventSource<AudioSourceEvent>;
get deviceInfo(): Promise<ISpeechConfigAudioDevice>;
}
export abstract class PullAudioInputStream extends AudioInputStream {
/**
* Creates and initializes and instance.
* @constructor
*/
protected constructor();
/**
* Creates a PullAudioInputStream that delegates to the specified callback interface for
* read() and close() methods, using the default format (16 kHz 16bit mono PCM).
* @member PullAudioInputStream.create
* @function
* @public
* @param {PullAudioInputStreamCallback} callback - The custom audio input object,
* derived from PullAudioInputStreamCustomCallback
* @param {AudioStreamFormat} format - The audio data format in which audio will be
* returned from the callback's read() method (Required if format is not 16 kHz 16bit mono PCM).
* @returns {PullAudioInputStream} The push audio input stream being created.
*/
static create(callback: PullAudioInputStreamCallback, format?: AudioStreamFormat): PullAudioInputStream;
/**
* Explicitly frees any external resource attached to the object
* @member PullAudioInputStream.prototype.close
* @function
* @public
*/
abstract close(): void;
}
/**
* Represents audio input stream used for custom audio input configurations.
* @private
* @class PullAudioInputStreamImpl
*/
export class PullAudioInputStreamImpl extends PullAudioInputStream implements IAudioSource {
/**
* Creates a PullAudioInputStream that delegates to the specified callback interface for
* read() and close() methods, using the default format (16 kHz 16bit mono PCM).
* @constructor
* @param {PullAudioInputStreamCallback} callback - The custom audio input object,
* derived from PullAudioInputStreamCustomCallback
* @param {AudioStreamFormat} format - The audio data format in which audio will be
* returned from the callback's read() method (Required if format is not 16 kHz 16bit mono PCM).
*/
constructor(callback: PullAudioInputStreamCallback, format?: AudioStreamFormatImpl);
/**
* Format information for the audio
*/
get format(): Promise<AudioStreamFormatImpl>;
/**
* Closes the stream.
* @member PullAudioInputStreamImpl.prototype.close
* @function
* @public
*/
close(): void;
id(): string;
get blob(): Promise<Blob | Buffer>;
turnOn(): Promise<void>;
attach(audioNodeId: string): Promise<IAudioStreamNode>;
detach(audioNodeId: string): void;
turnOff(): Promise<void>;
get events(): EventSource<AudioSourceEvent>;
get deviceInfo(): Promise<ISpeechConfigAudioDevice>;
}
/**
* Represents audio output stream used for custom audio output configurations.
* @class AudioOutputStream
*/
export abstract class AudioOutputStream {
/**
* Creates and initializes an instance.
* @constructor
*/
protected constructor();
/**
* Sets the format of the AudioOutputStream
* Note: the format is set by the synthesizer before writing. Do not set it before passing it to AudioConfig
* @member AudioOutputStream.prototype.format
*/
abstract set format(format: AudioStreamFormat);
/**
* Creates a memory backed PullAudioOutputStream with the specified audio format.
* @member AudioOutputStream.createPullStream
* @function
* @public
* @returns {PullAudioOutputStream} The audio output stream being created.
*/
static createPullStream(): PullAudioOutputStream;
/**
* Explicitly frees any external resource attached to the object
* @member AudioOutputStream.prototype.close
* @function
* @public
*/
abstract close(): void;
}
/**
* Represents memory backed push audio output stream used for custom audio output configurations.
* @class PullAudioOutputStream
*/
export abstract class PullAudioOutputStream extends AudioOutputStream {
/**
* Creates a memory backed PullAudioOutputStream with the specified audio format.
* @member PullAudioOutputStream.create
* @function
* @public
* @returns {PullAudioOutputStream} The push audio output stream being created.
*/
static create(): PullAudioOutputStream;
/**
* Reads audio data from the internal buffer.
* @member PullAudioOutputStream.prototype.read
* @function
* @public
* @param {ArrayBuffer} dataBuffer - An ArrayBuffer to store the read data.
* @returns {Promise<number>} Audio buffer length has been read.
*/
abstract read(dataBuffer: ArrayBuffer): Promise<number>;
/**
* Closes the stream.
* @member PullAudioOutputStream.prototype.close
* @function
* @public
*/
abstract close(): void;
}
/**
* Represents memory backed push audio output stream used for custom audio output configurations.
* @private
* @class PullAudioOutputStreamImpl
*/
export class PullAudioOutputStreamImpl extends PullAudioOutputStream implements IAudioDestination {
/**
* Creates and initializes an instance with the given values.
* @constructor
*/
constructor();
/**
* Sets the format information to the stream. For internal use only.
* @param {AudioStreamFormat} format - the format to be set.
*/
set format(format: AudioStreamFormat);
/**
* Format information for the audio
*/
get format(): AudioStreamFormat;
/**
* Checks if the stream is closed
* @member PullAudioOutputStreamImpl.prototype.isClosed
* @property
* @public
*/
get isClosed(): boolean;
/**
* Gets the id of the stream
* @member PullAudioOutputStreamImpl.prototype.id
* @property
* @public
*/
id(): string;
/**
* Reads audio data from the internal buffer.
* @member PullAudioOutputStreamImpl.prototype.read
* @function
* @public
* @param {ArrayBuffer} dataBuffer - An ArrayBuffer to store the read data.
* @returns {Promise<number>} - Audio buffer length has been read.
*/
read(dataBuffer: ArrayBuffer): Promise<number>;
/**
* Writes the audio data specified by making an internal copy of the data.
* @member PullAudioOutputStreamImpl.prototype.write
* @function
* @public
* @param {ArrayBuffer} dataBuffer - The audio buffer of which this function will make a copy.
*/
write(dataBuffer: ArrayBuffer): void;
/**
* Closes the stream.
* @member PullAudioOutputStreamImpl.prototype.close
* @function
* @public
*/
close(): void;
}
export abstract class PushAudioOutputStream extends AudioOutputStream {
/**
* Creates and initializes and instance.
* @constructor
*/
protected constructor();
/**
* Creates a PushAudioOutputStream that delegates to the specified callback interface for
* write() and close() methods.
* @member PushAudioOutputStream.create
* @function
* @public
* @param {PushAudioOutputStreamCallback} callback - The custom audio output object,
* derived from PushAudioOutputStreamCallback
* @returns {PushAudioOutputStream} The push audio output stream being created.
*/
static create(callback: PushAudioOutputStreamCallback): PushAudioOutputStream;
/**
* Explicitly frees any external resource attached to the object
* @member PushAudioOutputStream.prototype.close
* @function
* @public
*/
abstract close(): void;
}
/**
* Represents audio output stream used for custom audio output configurations.
* @private
* @class PushAudioOutputStreamImpl
*/
export class PushAudioOutputStreamImpl extends PushAudioOutputStream implements IAudioDestination {
/**
* Creates a PushAudioOutputStream that delegates to the specified callback interface for
* read() and close() methods.
* @constructor
* @param {PushAudioOutputStreamCallback} callback - The custom audio output object,
* derived from PushAudioOutputStreamCallback
*/
constructor(callback: PushAudioOutputStreamCallback);
set format(format: AudioStreamFormat);
write(buffer: ArrayBuffer): void;
close(): void;
id(): string;
}
/**
* Defines the possible reasons a recognition result might be canceled.
* @class CancellationReason
*/
export enum CancellationReason {
/**
* Indicates that an error occurred during speech recognition.
* @member CancellationReason.Error
*/
Error = 0,
/**
* Indicates that the end of the audio stream was reached.
* @member CancellationReason.EndOfStream
*/
EndOfStream = 1
}
/**
* An abstract base class that defines callback methods (read() and close()) for
* custom audio input streams).
* @class PullAudioInputStreamCallback
*/
export abstract class PullAudioInputStreamCallback {
/**
* Reads data from audio input stream into the data buffer. The maximal number of bytes
* to be read is determined by the size of dataBuffer.
* @member PullAudioInputStreamCallback.prototype.read
* @function
* @public
* @param {ArrayBuffer} dataBuffer - The byte array to store the read data.
* @returns {number} the number of bytes have been read.
*/
abstract read(dataBuffer: ArrayBuffer): number;
/**
* Closes the audio input stream.
* @member PullAudioInputStreamCallback.prototype.close
* @function
* @public
*/
abstract close(): void;
}
/**
* An abstract base class that defines callback methods (write() and close()) for
* custom audio output streams).
* @class PushAudioOutputStreamCallback
*/
export abstract class PushAudioOutputStreamCallback {
/**
* Writes audio data into the data buffer.
* @member PushAudioOutputStreamCallback.prototype.write
* @function
* @public
* @param {ArrayBuffer} dataBuffer - The byte array that stores the audio data to write.
*/
abstract write(dataBuffer: ArrayBuffer): void;
/**
* Closes the audio output stream.
* @member PushAudioOutputStreamCallback.prototype.close
* @function
* @public
*/
abstract close(): void;
}
/**
* Represents a keyword recognition model for recognizing when
* the user says a keyword to initiate further speech recognition.
* @class KeywordRecognitionModel
*/
export class KeywordRecognitionModel {
/**
* Creates a keyword recognition model using the specified filename.
* @member KeywordRecognitionModel.fromFile
* @function
* @public
* @param {string} fileName - A string that represents file name for the keyword recognition model.
* Note, the file can point to a zip file in which case the model
* will be extracted from the zip.
* @returns {KeywordRecognitionModel} The keyword recognition model being created.
*/
static fromFile(fileName: string): KeywordRecognitionModel;
/**
* Creates a keyword recognition model using the specified filename.
* @member KeywordRecognitionModel.fromStream
* @function
* @public
* @param {string} file - A File that represents file for the keyword recognition model.
* Note, the file can point to a zip file in which case the model will be extracted from the zip.
* @returns {KeywordRecognitionModel} The keyword recognition model being created.
*/
static fromStream(file: File): KeywordRecognitionModel;
/**
* Dispose of associated resources.
* @member KeywordRecognitionModel.prototype.close
* @function
* @public
*/
close(): void;
}
/**
* Defines content for session events like SessionStarted/Stopped, SoundStarted/Stopped.
* @class SessionEventArgs
*/
export class SessionEventArgs {
/**
* Creates and initializes an instance of this class.
* @constructor
* @param {string} sessionId - The session id.
*/
constructor(sessionId: string);
/**
* Represents the session identifier.
* @member SessionEventArgs.prototype.sessionId
* @function
* @public
* @returns {string} Represents the session identifier.
*/
get sessionId(): string;
}
/**
* Defines payload for session events like Speech Start/End Detected
* @class
*/
export class RecognitionEventArgs extends SessionEventArgs {
/**
* Creates and initializes an instance of this class.
* @constructor
* @param {number} offset - The offset.
* @param {string} sessionId - The session id.
*/
constructor(offset: number, sessionId?: string);
/**
* Represents the message offset
* @member RecognitionEventArgs.prototype.offset
* @function
* @public
*/
get offset(): number;
}
/**
* Define Speech Recognizer output formats.
* @class OutputFormat
*/
export enum OutputFormat {
/**
* @member OutputFormat.Simple
*/
Simple = 0,
/**
* @member OutputFormat.Detailed
*/
Detailed = 1
}
/**
* Intent recognition result event arguments.
* @class
*/
export class IntentRecognitionEventArgs extends RecognitionEventArgs {
/**
* Creates and initializes an instance of this class.
* @constructor
* @param result - The result of the intent recognition.
* @param offset - The offset.
* @param sessionId - The session id.
*/
constructor(result: IntentRecognitionResult, offset?: number, sessionId?: string);
/**
* Represents the intent recognition result.
* @member IntentRecognitionEventArgs.prototype.result
* @function
* @public
* @returns {IntentRecognitionResult} Represents the intent recognition result.
*/
get result(): IntentRecognitionResult;
}
/**
* Defines result of speech recognition.
* @class RecognitionResult
*/
export class RecognitionResult {
/**
* Creates and initializes an instance of this class.
* @constructor
* @param {string} resultId - The result id.
* @param {ResultReason} reason - The reason.
* @param {string} text - The recognized text.
* @param {number} duration - The duration.
* @param {number} offset - The offset into the stream.
* @param {string} language - Primary Language detected, if provided.
* @param {string} languageDetectionConfidence - Primary Language confidence ("Unknown," "Low," "Medium," "High"...), if provided.
* @param {string} errorDetails - Error details, if provided.
* @param {string} json - Additional Json, if provided.
* @param {PropertyCollection} properties - Additional properties, if provided.
*/
constructor(resultId?: string, reason?: ResultReason, text?: string, duration?: number, offset?: number, language?: string, languageDetectionConfidence?: string, errorDetails?: string, json?: string, properties?: PropertyCollection);
/**
* Specifies the result identifier.
* @member RecognitionResult.prototype.resultId
* @function
* @public
* @returns {string} Specifies the result identifier.
*/
get resultId(): string;
/**
* Specifies status of the result.
* @member RecognitionResult.prototype.reason
* @function
* @public
* @returns {ResultReason} Specifies status of the result.
*/
get reason(): ResultReason;
/**
* Presents the recognized text in the result.
* @member RecognitionResult.prototype.text
* @function
* @public
* @returns {string} Presents the recognized text in the result.
*/
get text(): string;
/**
* Duration of recognized speech in 100 nano second incements.
* @member RecognitionResult.prototype.duration
* @function
* @public
* @returns {number} Duration of recognized speech in 100 nano second incements.
*/
get duration(): number;
/**
* Offset of recognized speech in 100 nano second incements.
* @member RecognitionResult.prototype.offset
* @function
* @public
* @returns {number} Offset of recognized speech in 100 nano second incements.
*/
get offset(): number;
/**
* Primary Language detected.
* @member RecognitionResult.prototype.language
* @function
* @public
* @returns {string} language detected.
*/
get language(): string;
/**
* Primary Language detection confidence (Unknown, Low, Medium, High).
* @member RecognitionResult.prototype.languageDetectionConfidence
* @function
* @public
* @returns {string} detection confidence strength.
*/
get languageDetectionConfidence(): string;
/**
* In case of an unsuccessful recognition, provides details of the occurred error.
* @member RecognitionResult.prototype.errorDetails
* @function
* @public
* @returns {string} a brief description of an error.
*/
get errorDetails(): string;
/**
* A string containing Json serialized recognition result as it was received from the service.
* @member RecognitionResult.prototype.json
* @function
* @private
* @returns {string} Json serialized representation of the result.
*/
get json(): string;
/**
* The set of properties exposed in the result.
* @member RecognitionResult.prototype.properties
* @function
* @public
* @returns {PropertyCollection} The set of properties exposed in the result.
*/
get properties(): PropertyCollection;
}
/**
* Defines result of speech recognition.
* @class SpeechRecognitionResult
*/
export class SpeechRecognitionResult extends RecognitionResult {
/**
* Creates and initializes an instance of this class.
* @constructor
* @public
* @param {string} resultId - The result id.
* @param {ResultReason} reason - The reason.
* @param {string} text - The recognized text.
* @param {number} duration - The duration.
* @param {number} offset - The offset into the stream.
* @param {string} language - Primary Language detected, if provided.
* @param {string} languageDetectionConfidence - Primary Language confidence ("Unknown," "Low," "Medium," "High"...), if provided.
* @param {string} speakerId - speaker id for conversation transcription, if provided.
* @param {string} errorDetails - Error details, if provided.
* @param {string} json - Additional Json, if provided.
* @param {PropertyCollection} properties - Additional properties, if provided.
*/
constructor(resultId?: string, reason?: ResultReason, text?: string, duration?: number, offset?: number, language?: string, languageDetectionConfidence?: string, speakerId?: string, errorDetails?: string, json?: string, properties?: PropertyCollection);
/**
* speaker id from conversation transcription/id scenarios
* @member SpeechRecognitionResult.prototype.speakerId
* @function
* @public
* @returns {string} id of speaker in given result
*/
get speakerId(): string;
}
/**
* Intent recognition result.
* @class
*/
export class IntentRecognitionResult extends SpeechRecognitionResult {
/**
* Creates and initializes an instance of this class.
* @constructor
* @param intentId - The intent id.
* @param resultId - The result id.
* @param reason - The reason.
* @param text - The recognized text.
* @param duration - The duration.
* @param offset - The offset into the stream.
* @param language - Primary Language detected, if provided.
* @param languageDetectionConfidence - Primary Language confidence ("Unknown," "Low," "Medium," "High"...), if provided.
* @param errorDetails - Error details, if provided.
* @param json - Additional Json, if provided.
* @param properties - Additional properties, if provided.
*/