-
Notifications
You must be signed in to change notification settings - Fork 17
/
NAudio.xml
21964 lines (20752 loc) · 931 KB
/
NAudio.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>NAudio</name>
</assembly>
<members>
<member name="T:NAudio.Codecs.ALawDecoder">
<summary>
a-law decoder
based on code from:
http://hazelware.luggle.com/tutorials/mulawcompression.html
</summary>
</member>
<member name="F:NAudio.Codecs.ALawDecoder.ALawDecompressTable">
<summary>
only 512 bytes required, so just use a lookup
</summary>
</member>
<member name="M:NAudio.Codecs.ALawDecoder.ALawToLinearSample(System.Byte)">
<summary>
Converts an a-law encoded byte to a 16 bit linear sample
</summary>
<param name="aLaw">a-law encoded byte</param>
<returns>Linear sample</returns>
</member>
<member name="T:NAudio.Codecs.ALawEncoder">
<summary>
A-law encoder
</summary>
</member>
<member name="M:NAudio.Codecs.ALawEncoder.LinearToALawSample(System.Int16)">
<summary>
Encodes a single 16 bit sample to a-law
</summary>
<param name="sample">16 bit PCM sample</param>
<returns>a-law encoded byte</returns>
</member>
<member name="T:NAudio.Codecs.G722Codec">
<summary>
SpanDSP - a series of DSP components for telephony
g722_decode.c - The ITU G.722 codec, decode part.
Written by Steve Underwood <[email protected]>
Copyright (C) 2005 Steve Underwood
Ported to C# by Mark Heath 2011
Despite my general liking of the GPL, I place my own contributions
to this code in the public domain for the benefit of all mankind -
even the slimy ones who might try to proprietize my work and use it
to my detriment.
Based in part on a single channel G.722 codec which is:
Copyright (c) CMU 1993
Computer Science, Speech Group
Chengxiang Lu and Alex Hauptmann
</summary>
</member>
<member name="M:NAudio.Codecs.G722Codec.Saturate(System.Int32)">
<summary>
hard limits to 16 bit samples
</summary>
</member>
<member name="M:NAudio.Codecs.G722Codec.Decode(NAudio.Codecs.G722CodecState,System.Int16[],System.Byte[],System.Int32)">
<summary>
Decodes a buffer of G722
</summary>
<param name="state">Codec state</param>
<param name="outputBuffer">Output buffer (to contain decompressed PCM samples)</param>
<param name="inputG722Data"></param>
<param name="inputLength">Number of bytes in input G722 data to decode</param>
<returns>Number of samples written into output buffer</returns>
</member>
<member name="M:NAudio.Codecs.G722Codec.Encode(NAudio.Codecs.G722CodecState,System.Byte[],System.Int16[],System.Int32)">
<summary>
Encodes a buffer of G722
</summary>
<param name="state">Codec state</param>
<param name="outputBuffer">Output buffer (to contain encoded G722)</param>
<param name="inputBuffer">PCM 16 bit samples to encode</param>
<param name="inputBufferCount">Number of samples in the input buffer to encode</param>
<returns>Number of encoded bytes written into output buffer</returns>
</member>
<member name="T:NAudio.Codecs.G722CodecState">
<summary>
Stores state to be used between calls to Encode or Decode
</summary>
</member>
<member name="P:NAudio.Codecs.G722CodecState.ItuTestMode">
<summary>
ITU Test Mode
TRUE if the operating in the special ITU test mode, with the band split filters disabled.
</summary>
</member>
<member name="P:NAudio.Codecs.G722CodecState.Packed">
<summary>
TRUE if the G.722 data is packed
</summary>
</member>
<member name="P:NAudio.Codecs.G722CodecState.EncodeFrom8000Hz">
<summary>
8kHz Sampling
TRUE if encode from 8k samples/second
</summary>
</member>
<member name="P:NAudio.Codecs.G722CodecState.BitsPerSample">
<summary>
Bits Per Sample
6 for 48000kbps, 7 for 56000kbps, or 8 for 64000kbps.
</summary>
</member>
<member name="P:NAudio.Codecs.G722CodecState.QmfSignalHistory">
<summary>
Signal history for the QMF (x)
</summary>
</member>
<member name="P:NAudio.Codecs.G722CodecState.Band">
<summary>
Band
</summary>
</member>
<member name="P:NAudio.Codecs.G722CodecState.InBuffer">
<summary>
In bit buffer
</summary>
</member>
<member name="P:NAudio.Codecs.G722CodecState.InBits">
<summary>
Number of bits in InBuffer
</summary>
</member>
<member name="P:NAudio.Codecs.G722CodecState.OutBuffer">
<summary>
Out bit buffer
</summary>
</member>
<member name="P:NAudio.Codecs.G722CodecState.OutBits">
<summary>
Number of bits in OutBuffer
</summary>
</member>
<member name="M:NAudio.Codecs.G722CodecState.#ctor(System.Int32,NAudio.Codecs.G722Flags)">
<summary>
Creates a new instance of G722 Codec State for a
new encode or decode session
</summary>
<param name="rate">Bitrate (typically 64000)</param>
<param name="options">Special options</param>
</member>
<member name="T:NAudio.Codecs.Band">
<summary>
Band data for G722 Codec
</summary>
</member>
<member name="F:NAudio.Codecs.Band.s">
<summary>s</summary>
</member>
<member name="F:NAudio.Codecs.Band.sp">
<summary>sp</summary>
</member>
<member name="F:NAudio.Codecs.Band.sz">
<summary>sz</summary>
</member>
<member name="F:NAudio.Codecs.Band.r">
<summary>r</summary>
</member>
<member name="F:NAudio.Codecs.Band.a">
<summary>a</summary>
</member>
<member name="F:NAudio.Codecs.Band.ap">
<summary>ap</summary>
</member>
<member name="F:NAudio.Codecs.Band.p">
<summary>p</summary>
</member>
<member name="F:NAudio.Codecs.Band.d">
<summary>d</summary>
</member>
<member name="F:NAudio.Codecs.Band.b">
<summary>b</summary>
</member>
<member name="F:NAudio.Codecs.Band.bp">
<summary>bp</summary>
</member>
<member name="F:NAudio.Codecs.Band.sg">
<summary>sg</summary>
</member>
<member name="F:NAudio.Codecs.Band.nb">
<summary>nb</summary>
</member>
<member name="F:NAudio.Codecs.Band.det">
<summary>det</summary>
</member>
<member name="T:NAudio.Codecs.G722Flags">
<summary>
G722 Flags
</summary>
</member>
<member name="F:NAudio.Codecs.G722Flags.None">
<summary>
None
</summary>
</member>
<member name="F:NAudio.Codecs.G722Flags.SampleRate8000">
<summary>
Using a G722 sample rate of 8000
</summary>
</member>
<member name="F:NAudio.Codecs.G722Flags.Packed">
<summary>
Packed
</summary>
</member>
<member name="T:NAudio.Codecs.MuLawDecoder">
<summary>
mu-law decoder
based on code from:
http://hazelware.luggle.com/tutorials/mulawcompression.html
</summary>
</member>
<member name="F:NAudio.Codecs.MuLawDecoder.MuLawDecompressTable">
<summary>
only 512 bytes required, so just use a lookup
</summary>
</member>
<member name="M:NAudio.Codecs.MuLawDecoder.MuLawToLinearSample(System.Byte)">
<summary>
Converts a mu-law encoded byte to a 16 bit linear sample
</summary>
<param name="muLaw">mu-law encoded byte</param>
<returns>Linear sample</returns>
</member>
<member name="T:NAudio.Codecs.MuLawEncoder">
<summary>
mu-law encoder
based on code from:
http://hazelware.luggle.com/tutorials/mulawcompression.html
</summary>
</member>
<member name="M:NAudio.Codecs.MuLawEncoder.LinearToMuLawSample(System.Int16)">
<summary>
Encodes a single 16 bit sample to mu-law
</summary>
<param name="sample">16 bit PCM sample</param>
<returns>mu-law encoded byte</returns>
</member>
<member name="T:NAudio.CoreAudioApi.AudioCaptureClient">
<summary>
Audio Capture Client
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioCaptureClient.GetBuffer(System.Int32@,NAudio.CoreAudioApi.AudioClientBufferFlags@,System.Int64@,System.Int64@)">
<summary>
Gets a pointer to the buffer
</summary>
<returns>Pointer to the buffer</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioCaptureClient.GetBuffer(System.Int32@,NAudio.CoreAudioApi.AudioClientBufferFlags@)">
<summary>
Gets a pointer to the buffer
</summary>
<param name="numFramesToRead">Number of frames to read</param>
<param name="bufferFlags">Buffer flags</param>
<returns>Pointer to the buffer</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioCaptureClient.GetNextPacketSize">
<summary>
Gets the size of the next packet
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioCaptureClient.ReleaseBuffer(System.Int32)">
<summary>
Release buffer
</summary>
<param name="numFramesWritten">Number of frames written</param>
</member>
<member name="M:NAudio.CoreAudioApi.AudioCaptureClient.Dispose">
<summary>
Release the COM object
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioClient">
<summary>
Windows CoreAudio AudioClient
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClient.MixFormat">
<summary>
Retrieves the stream format that the audio engine uses for its internal processing of shared-mode streams.
Can be called before initialize
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioClient.Initialize(NAudio.CoreAudioApi.AudioClientShareMode,NAudio.CoreAudioApi.AudioClientStreamFlags,System.Int64,System.Int64,NAudio.Wave.WaveFormat,System.Guid)">
<summary>
Initializes the Audio Client
</summary>
<param name="shareMode">Share Mode</param>
<param name="streamFlags">Stream Flags</param>
<param name="bufferDuration">Buffer Duration</param>
<param name="periodicity">Periodicity</param>
<param name="waveFormat">Wave Format</param>
<param name="audioSessionGuid">Audio Session GUID (can be null)</param>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClient.BufferSize">
<summary>
Retrieves the size (maximum capacity) of the audio buffer associated with the endpoint. (must initialize first)
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClient.StreamLatency">
<summary>
Retrieves the maximum latency for the current stream and can be called any time after the stream has been initialized.
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClient.CurrentPadding">
<summary>
Retrieves the number of frames of padding in the endpoint buffer (must initialize first)
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClient.DefaultDevicePeriod">
<summary>
Retrieves the length of the periodic interval separating successive processing passes by the audio engine on the data in the endpoint buffer.
(can be called before initialize)
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClient.MinimumDevicePeriod">
<summary>
Gets the minimum device period
(can be called before initialize)
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClient.AudioStreamVolume">
<summary>
Returns the AudioStreamVolume service for this AudioClient.
</summary>
<remarks>
This returns the AudioStreamVolume object ONLY for shared audio streams.
</remarks>
<exception cref="T:System.InvalidOperationException">
This is thrown when an exclusive audio stream is being used.
</exception>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClient.AudioClockClient">
<summary>
Gets the AudioClockClient service
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClient.AudioRenderClient">
<summary>
Gets the AudioRenderClient service
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClient.AudioCaptureClient">
<summary>
Gets the AudioCaptureClient service
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioClient.IsFormatSupported(NAudio.CoreAudioApi.AudioClientShareMode,NAudio.Wave.WaveFormat)">
<summary>
Determines whether if the specified output format is supported
</summary>
<param name="shareMode">The share mode.</param>
<param name="desiredFormat">The desired format.</param>
<returns>True if the format is supported</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioClient.IsFormatSupported(NAudio.CoreAudioApi.AudioClientShareMode,NAudio.Wave.WaveFormat,NAudio.Wave.WaveFormatExtensible@)">
<summary>
Determines if the specified output format is supported in shared mode
</summary>
<param name="shareMode">Share Mode</param>
<param name="desiredFormat">Desired Format</param>
<param name="closestMatchFormat">Output The closest match format.</param>
<returns>True if the format is supported</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioClient.Start">
<summary>
Starts the audio stream
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioClient.Stop">
<summary>
Stops the audio stream.
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioClient.SetEventHandle(System.IntPtr)">
<summary>
Set the Event Handle for buffer synchro.
</summary>
<param name="eventWaitHandle">The Wait Handle to setup</param>
</member>
<member name="M:NAudio.CoreAudioApi.AudioClient.Reset">
<summary>
Resets the audio stream
Reset is a control method that the client calls to reset a stopped audio stream.
Resetting the stream flushes all pending data and resets the audio clock stream
position to 0. This method fails if it is called on a stream that is not stopped
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioClient.Dispose">
<summary>
Dispose
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioClientBufferFlags">
<summary>
Audio Client Buffer Flags
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientBufferFlags.None">
<summary>
None
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientBufferFlags.DataDiscontinuity">
<summary>
AUDCLNT_BUFFERFLAGS_DATA_DISCONTINUITY
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientBufferFlags.Silent">
<summary>
AUDCLNT_BUFFERFLAGS_SILENT
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientBufferFlags.TimestampError">
<summary>
AUDCLNT_BUFFERFLAGS_TIMESTAMP_ERROR
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioClientProperties">
<summary>
The AudioClientProperties structure is used to set the parameters that describe the properties of the client's audio stream.
</summary>
<remarks>http://msdn.microsoft.com/en-us/library/windows/desktop/hh968105(v=vs.85).aspx</remarks>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientProperties.cbSize">
<summary>
The size of the buffer for the audio stream.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientProperties.bIsOffload">
<summary>
Boolean value to indicate whether or not the audio stream is hardware-offloaded
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientProperties.eCategory">
<summary>
An enumeration that is used to specify the category of the audio stream.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientProperties.Options">
<summary>
A bit-field describing the characteristics of the stream. Supported in Windows 8.1 and later.
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioClientShareMode">
<summary>
AUDCLNT_SHAREMODE
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientShareMode.Shared">
<summary>
AUDCLNT_SHAREMODE_SHARED,
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientShareMode.Exclusive">
<summary>
AUDCLNT_SHAREMODE_EXCLUSIVE
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioClientStreamFlags">
<summary>
AUDCLNT_STREAMFLAGS
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientStreamFlags.None">
<summary>
None
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientStreamFlags.CrossProcess">
<summary>
AUDCLNT_STREAMFLAGS_CROSSPROCESS
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientStreamFlags.Loopback">
<summary>
AUDCLNT_STREAMFLAGS_LOOPBACK
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientStreamFlags.EventCallback">
<summary>
AUDCLNT_STREAMFLAGS_EVENTCALLBACK
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientStreamFlags.NoPersist">
<summary>
AUDCLNT_STREAMFLAGS_NOPERSIST
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioClientStreamOptions">
<summary>
Defines values that describe the characteristics of an audio stream.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientStreamOptions.None">
<summary>
No stream options.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioClientStreamOptions.Raw">
<summary>
The audio stream is a 'raw' stream that bypasses all signal processing except for endpoint specific, always-on processing in the APO, driver, and hardware.
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioClockClient">
<summary>
Audio Clock Client
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClockClient.Characteristics">
<summary>
Characteristics
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClockClient.Frequency">
<summary>
Frequency
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioClockClient.GetPosition(System.UInt64@,System.UInt64@)">
<summary>
Get Position
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClockClient.AdjustedPosition">
<summary>
Adjusted Position
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioClockClient.CanAdjustPosition">
<summary>
Can Adjust Position
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioClockClient.Dispose">
<summary>
Dispose
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioEndpointVolumeChannel">
<summary>
Audio Endpoint Volume Channel
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioEndpointVolumeChannel.VolumeLevel">
<summary>
Volume Level
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioEndpointVolumeChannel.VolumeLevelScalar">
<summary>
Volume Level Scalar
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioEndpointVolumeChannels">
<summary>
Audio Endpoint Volume Channels
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioEndpointVolumeChannels.Count">
<summary>
Channel Count
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioEndpointVolumeChannels.Item(System.Int32)">
<summary>
Indexer - get a specific channel
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioEndpointVolumeNotificationDelegate">
<summary>
Audio Endpoint Volume Notifiaction Delegate
</summary>
<param name="data">Audio Volume Notification Data</param>
</member>
<member name="T:NAudio.CoreAudioApi.AudioEndpointVolumeStepInformation">
<summary>
Audio Endpoint Volume Step Information
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioEndpointVolumeStepInformation.Step">
<summary>
Step
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioEndpointVolumeStepInformation.StepCount">
<summary>
StepCount
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioEndpointVolumeVolumeRange">
<summary>
Audio Endpoint Volume Volume Range
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioEndpointVolumeVolumeRange.MinDecibels">
<summary>
Minimum Decibels
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioEndpointVolumeVolumeRange.MaxDecibels">
<summary>
Maximum Decibels
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioEndpointVolumeVolumeRange.IncrementDecibels">
<summary>
Increment Decibels
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioMeterInformationChannels">
<summary>
Audio Meter Information Channels
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioMeterInformationChannels.Count">
<summary>
Metering Channel Count
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioMeterInformationChannels.Item(System.Int32)">
<summary>
Get Peak value
</summary>
<param name="index">Channel index</param>
<returns>Peak value</returns>
</member>
<member name="T:NAudio.CoreAudioApi.AudioRenderClient">
<summary>
Audio Render Client
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioRenderClient.GetBuffer(System.Int32)">
<summary>
Gets a pointer to the buffer
</summary>
<param name="numFramesRequested">Number of frames requested</param>
<returns>Pointer to the buffer</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioRenderClient.ReleaseBuffer(System.Int32,NAudio.CoreAudioApi.AudioClientBufferFlags)">
<summary>
Release buffer
</summary>
<param name="numFramesWritten">Number of frames written</param>
<param name="bufferFlags">Buffer flags</param>
</member>
<member name="M:NAudio.CoreAudioApi.AudioRenderClient.Dispose">
<summary>
Release the COM object
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioSessionControl">
<summary>
AudioSessionControl object for information
regarding an audio session
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionControl.#ctor(NAudio.CoreAudioApi.Interfaces.IAudioSessionControl)">
<summary>
Constructor.
</summary>
<param name="audioSessionControl"></param>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionControl.Dispose">
<summary>
Dispose
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionControl.Finalize">
<summary>
Finalizer
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionControl.AudioMeterInformation">
<summary>
Audio meter information of the audio session.
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionControl.SimpleAudioVolume">
<summary>
Simple audio volume of the audio session (for volume and mute status).
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionControl.State">
<summary>
The current state of the audio session.
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionControl.DisplayName">
<summary>
The name of the audio session.
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionControl.IconPath">
<summary>
the path to the icon shown in the mixer.
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionControl.GetSessionIdentifier">
<summary>
The session identifier of the audio session.
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionControl.GetSessionInstanceIdentifier">
<summary>
The session instance identifier of the audio session.
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionControl.GetProcessID">
<summary>
The process identifier of the audio session.
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionControl.IsSystemSoundsSession">
<summary>
Is the session a system sounds session.
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionControl.GetGroupingParam">
<summary>
the grouping param for an audio session grouping
</summary>
<returns></returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionControl.SetGroupingParam(System.Guid,System.Guid)">
<summary>
For chanigng the grouping param and supplying the context of said change
</summary>
<param name="groupingId"></param>
<param name="context"></param>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionControl.RegisterEventClient(NAudio.CoreAudioApi.Interfaces.IAudioSessionEventsHandler)">
<summary>
Registers an even client for callbacks
</summary>
<param name="eventClient"></param>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionControl.UnRegisterEventClient(NAudio.CoreAudioApi.Interfaces.IAudioSessionEventsHandler)">
<summary>
Unregisters an event client from receiving callbacks
</summary>
<param name="eventClient"></param>
</member>
<member name="T:NAudio.CoreAudioApi.AudioSessionEventsCallback">
<summary>
AudioSessionEvents callback implementation
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionEventsCallback.#ctor(NAudio.CoreAudioApi.Interfaces.IAudioSessionEventsHandler)">
<summary>
Constructor.
</summary>
<param name="handler"></param>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionEventsCallback.OnDisplayNameChanged(System.String,System.Guid@)">
<summary>
Notifies the client that the display name for the session has changed.
</summary>
<param name="displayName">The new display name for the session.</param>
<param name="eventContext">A user context value that is passed to the notification callback.</param>
<returns>An HRESULT code indicating whether the operation succeeded of failed.</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionEventsCallback.OnIconPathChanged(System.String,System.Guid@)">
<summary>
Notifies the client that the display icon for the session has changed.
</summary>
<param name="iconPath">The path for the new display icon for the session.</param>
<param name="eventContext">A user context value that is passed to the notification callback.</param>
<returns>An HRESULT code indicating whether the operation succeeded of failed.</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionEventsCallback.OnSimpleVolumeChanged(System.Single,System.Boolean,System.Guid@)">
<summary>
Notifies the client that the volume level or muting state of the session has changed.
</summary>
<param name="volume">The new volume level for the audio session.</param>
<param name="isMuted">The new muting state.</param>
<param name="eventContext">A user context value that is passed to the notification callback.</param>
<returns>An HRESULT code indicating whether the operation succeeded of failed.</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionEventsCallback.OnChannelVolumeChanged(System.UInt32,System.IntPtr,System.UInt32,System.Guid@)">
<summary>
Notifies the client that the volume level of an audio channel in the session submix has changed.
</summary>
<param name="channelCount">The channel count.</param>
<param name="newVolumes">An array of volumnes cooresponding with each channel index.</param>
<param name="channelIndex">The number of the channel whose volume level changed.</param>
<param name="eventContext">A user context value that is passed to the notification callback.</param>
<returns>An HRESULT code indicating whether the operation succeeded of failed.</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionEventsCallback.OnGroupingParamChanged(System.Guid@,System.Guid@)">
<summary>
Notifies the client that the grouping parameter for the session has changed.
</summary>
<param name="groupingId">The new grouping parameter for the session.</param>
<param name="eventContext">A user context value that is passed to the notification callback.</param>
<returns>An HRESULT code indicating whether the operation succeeded of failed.</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionEventsCallback.OnStateChanged(NAudio.CoreAudioApi.Interfaces.AudioSessionState)">
<summary>
Notifies the client that the stream-activity state of the session has changed.
</summary>
<param name="state">The new session state.</param>
<returns>An HRESULT code indicating whether the operation succeeded of failed.</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionEventsCallback.OnSessionDisconnected(NAudio.CoreAudioApi.Interfaces.AudioSessionDisconnectReason)">
<summary>
Notifies the client that the session has been disconnected.
</summary>
<param name="disconnectReason">The reason that the audio session was disconnected.</param>
<returns>An HRESULT code indicating whether the operation succeeded of failed.</returns>
</member>
<member name="T:NAudio.CoreAudioApi.AudioSessionManager">
<summary>
AudioSessionManager
Designed to manage audio sessions and in particuar the
SimpleAudioVolume interface to adjust a session volume
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioSessionManager.SessionCreatedDelegate">
<summary>
</summary>
<param name="sender"></param>
<param name="newSession"></param>
</member>
<member name="E:NAudio.CoreAudioApi.AudioSessionManager.OnSessionCreated">
<summary>
Occurs when audio session has been added (for example run another program that use audio playback).
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionManager.SimpleAudioVolume">
<summary>
SimpleAudioVolume object
for adjusting the volume for the user session
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionManager.AudioSessionControl">
<summary>
AudioSessionControl object
for registring for callbacks and other session information
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionManager.RefreshSessions">
<summary>
Refresh session of current device.
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioSessionManager.Sessions">
<summary>
Returns list of sessions of current device.
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionManager.Dispose">
<summary>
Dispose.
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioSessionManager.Finalize">
<summary>
Finalizer.
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioStreamCategory">
<summary>
Specifies the category of an audio stream.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioStreamCategory.Other">
<summary>
Other audio stream.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioStreamCategory.ForegroundOnlyMedia">
<summary>
Media that will only stream when the app is in the foreground.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioStreamCategory.BackgroundCapableMedia">
<summary>
Media that can be streamed when the app is in the background.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioStreamCategory.Communications">
<summary>
Real-time communications, such as VOIP or chat.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioStreamCategory.Alerts">
<summary>
Alert sounds.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioStreamCategory.SoundEffects">
<summary>
Sound effects.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioStreamCategory.GameEffects">
<summary>
Game sound effects.
</summary>
</member>
<member name="F:NAudio.CoreAudioApi.AudioStreamCategory.GameMedia">
<summary>
Background audio for games.
</summary>
</member>
<member name="T:NAudio.CoreAudioApi.AudioStreamVolume">
<summary>
Manages the AudioStreamVolume for the <see cref="T:NAudio.CoreAudioApi.AudioClient"/>.
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioStreamVolume.CheckChannelIndex(System.Int32,System.String)">
<summary>
Verify that the channel index is valid.
</summary>
<param name="channelIndex"></param>
<param name="parameter"></param>
</member>
<member name="M:NAudio.CoreAudioApi.AudioStreamVolume.GetAllVolumes">
<summary>
Return the current stream volumes for all channels
</summary>
<returns>An array of volume levels between 0.0 and 1.0 for each channel in the audio stream.</returns>
</member>
<member name="P:NAudio.CoreAudioApi.AudioStreamVolume.ChannelCount">
<summary>
Returns the current number of channels in this audio stream.
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioStreamVolume.GetChannelVolume(System.Int32)">
<summary>
Return the current volume for the requested channel.
</summary>
<param name="channelIndex">The 0 based index into the channels.</param>
<returns>The volume level for the channel between 0.0 and 1.0.</returns>
</member>
<member name="M:NAudio.CoreAudioApi.AudioStreamVolume.SetAllVolumes(System.Single[])">
<summary>
Set the volume level for each channel of the audio stream.
</summary>
<param name="levels">An array of volume levels (between 0.0 and 1.0) one for each channel.</param>
<remarks>
A volume level MUST be supplied for reach channel in the audio stream.
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
Thrown when <paramref name="levels"/> does not contain <see cref="P:NAudio.CoreAudioApi.AudioStreamVolume.ChannelCount"/> elements.
</exception>
</member>
<member name="M:NAudio.CoreAudioApi.AudioStreamVolume.SetChannelVolume(System.Int32,System.Single)">
<summary>
Sets the volume level for one channel in the audio stream.
</summary>
<param name="index">The 0-based index into the channels to adjust the volume of.</param>
<param name="level">The volume level between 0.0 and 1.0 for this channel of the audio stream.</param>
</member>
<member name="M:NAudio.CoreAudioApi.AudioStreamVolume.Dispose">
<summary>
Dispose
</summary>
</member>
<member name="M:NAudio.CoreAudioApi.AudioStreamVolume.Dispose(System.Boolean)">
<summary>
Release/cleanup objects during Dispose/finalization.
</summary>
<param name="disposing">True if disposing and false if being finalized.</param>
</member>
<member name="T:NAudio.CoreAudioApi.AudioVolumeNotificationData">
<summary>
Audio Volume Notification Data
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioVolumeNotificationData.EventContext">
<summary>
Event Context
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioVolumeNotificationData.Muted">
<summary>
Muted
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioVolumeNotificationData.MasterVolume">
<summary>
Master Volume
</summary>
</member>
<member name="P:NAudio.CoreAudioApi.AudioVolumeNotificationData.Channels">
<summary>