This repository has been archived by the owner on May 29, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
/
Visualizer.xml
1657 lines (1656 loc) · 110 KB
/
Visualizer.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
<Type Name="Visualizer" FullName="Android.Media.Audiofx.Visualizer">
<TypeSignature Language="C#" Value="public class Visualizer : Java.Lang.Object" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Visualizer extends Java.Lang.Object" />
<TypeSignature Language="DocId" Value="T:Android.Media.Audiofx.Visualizer" />
<TypeSignature Language="F#" Value="type Visualizer = class
 inherit Object" />
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Java.Lang.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("android/media/audiofx/Visualizer", DoNotGenerateAcw=true)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("android/media/audiofx/Visualizer", DoNotGenerateAcw=true)>]</AttributeName>
</Attribute>
</Attributes>
<Docs since="9">
<summary>The Visualizer class enables application to retrieve part of the currently playing audio for
visualization purpose.</summary>
<remarks>
<para>The Visualizer class enables application to retrieve part of the currently playing audio for
visualization purpose. It is not an audio recording interface and only returns partial and low
quality audio content. However, to protect privacy of certain audio data (e.g voice mail) the use
of the visualizer requires the permission android.permission.RECORD_AUDIO.</para>
<para>The audio session ID passed to the constructor indicates which audio content should be
visualized:<br>
<ul>
<li>If the session is 0, the audio output mix is visualized</li>
<li>If the session is not 0, the audio from a particular <c>android.media.MediaPlayer</c> or
<c>android.media.AudioTrack</c>
using this audio session is visualized </li>
</ul></para>
<para>Two types of representation of audio content can be captured: <br>
<ul>
<li>Waveform data: consecutive 8-bit (unsigned) mono samples by using the
<c>#getWaveForm(byte[])</c> method</li>
<li>Frequency data: 8-bit magnitude FFT by using the <c>#getFft(byte[])</c> method</li>
</ul></para>
<para>The length of the capture can be retrieved or specified by calling respectively
<c>#getCaptureSize()</c> and <c>#setCaptureSize(int)</c> methods. The capture size must be a
power of 2 in the range returned by <c>#getCaptureSizeRange()</c>.</para>
<para>In addition to the polling capture mode described above with <c>#getWaveForm(byte[])</c> and
<c>#getFft(byte[])</c> methods, a callback mode is also available by installing a listener by
use of the <c>#setDataCaptureListener(OnDataCaptureListener, int, boolean, boolean)</c> method.
The rate at which the listener capture method is called as well as the type of data returned is
specified.</para>
<para>Before capturing data, the Visualizer must be enabled by calling the
<c>#setEnabled(boolean)</c> method.
When data capture is not needed any more, the Visualizer should be disabled.</para>
<para>It is good practice to call the <c>#release()</c> method when the Visualizer is not used
anymore to free up native resources associated to the Visualizer instance.</para>
<para>Creating a Visualizer on the output mix (audio session 0) requires permission
<c>android.Manifest.permission#MODIFY_AUDIO_SETTINGS</c></para>
<para>The Visualizer class can also be used to perform measurements on the audio being played back.
The measurements to perform are defined by setting a mask of the requested measurement modes with
<c>#setMeasurementMode(int)</c>. Supported values are <c>#MEASUREMENT_MODE_NONE</c> to cancel
any measurement, and <c>#MEASUREMENT_MODE_PEAK_RMS</c> for peak and RMS monitoring.
Measurements can be retrieved through <c>#getMeasurementPeakRms(MeasurementPeakRms)</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Visualizer (int audioSession);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 audioSession) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.Audiofx.Visualizer.#ctor(System.Int32)" />
<MemberSignature Language="F#" Value="new Android.Media.Audiofx.Visualizer : int -> Android.Media.Audiofx.Visualizer" Usage="new Android.Media.Audiofx.Visualizer audioSession" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register(".ctor", "(I)V", "")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register(".ctor", "(I)V", "")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="audioSession" Type="System.Int32" />
</Parameters>
<Docs>
<param name="audioSession">system wide unique audio session identifier. If audioSession
is not 0, the visualizer will be attached to the MediaPlayer or AudioTrack in the
same audio session. Otherwise, the Visualizer will apply to the output mix.</param>
<summary>Class constructor.</summary>
<remarks>
<para>Class constructor.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#Visualizer(int)" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.Visualizer(int)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
<exception cref="T:Java.Lang.RuntimeException" />
<exception cref="T:Java.Lang.UnsupportedOperationException" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Visualizer (IntPtr javaReference, Android.Runtime.JniHandleOwnership transfer);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(native int javaReference, valuetype Android.Runtime.JniHandleOwnership transfer) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.Audiofx.Visualizer.#ctor(System.IntPtr,Android.Runtime.JniHandleOwnership)" />
<MemberSignature Language="F#" Value="new Android.Media.Audiofx.Visualizer : nativeint * Android.Runtime.JniHandleOwnership -> Android.Media.Audiofx.Visualizer" Usage="new Android.Media.Audiofx.Visualizer (javaReference, transfer)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="javaReference" Type="System.IntPtr" />
<Parameter Name="transfer" Type="Android.Runtime.JniHandleOwnership" />
</Parameters>
<Docs>
<param name="javaReference">A <see cref="T:System.IntPtr" />containing a Java Native Interface (JNI) object reference.</param>
<param name="transfer">A <see cref="T:Android.Runtime.JniHandleOwnership" />indicating how to handle <paramref name="javaReference" /></param>
<summary>A constructor used when creating managed representations of JNI objects; called by the runtime.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="AlreadyExists">
<MemberSignature Language="C#" Value="public const Android.Media.Audiofx.VisualizerStatus AlreadyExists = -2;" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Android.Media.Audiofx.VisualizerStatus AlreadyExists = (-2)" />
<MemberSignature Language="DocId" Value="F:Android.Media.Audiofx.Visualizer.AlreadyExists" />
<MemberSignature Language="F#" Value="val mutable AlreadyExists : Android.Media.Audiofx.VisualizerStatus" Usage="Android.Media.Audiofx.Visualizer.AlreadyExists" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("ALREADY_EXISTS")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("ALREADY_EXISTS")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerStatus</ReturnType>
</ReturnValue>
<MemberValue>-2</MemberValue>
<Docs>
<summary>Internal operation status.</summary>
<remarks>
<para>Internal operation status. Not returned by any method.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#ALREADY_EXISTS" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.ALREADY_EXISTS</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
</Member>
<Member MemberName="CaptureSize">
<MemberSignature Language="C#" Value="public virtual int CaptureSize { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 CaptureSize" />
<MemberSignature Language="DocId" Value="P:Android.Media.Audiofx.Visualizer.CaptureSize" />
<MemberSignature Language="F#" Value="member this.CaptureSize : int" Usage="Android.Media.Audiofx.Visualizer.CaptureSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getCaptureSize", "()I", "GetGetCaptureSizeHandler")]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getCaptureSize", "()I", "GetGetCaptureSizeHandler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns current capture size.</summary>
<value>the capture size in bytes.</value>
<remarks>
<para>Returns current capture size.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#getCaptureSize()" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.getCaptureSize()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
<exception cref="T:Java.Lang.IllegalStateException" />
</Docs>
</Member>
<Member MemberName="Enabled">
<MemberSignature Language="C#" Value="public virtual bool Enabled { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Enabled" />
<MemberSignature Language="DocId" Value="P:Android.Media.Audiofx.Visualizer.Enabled" />
<MemberSignature Language="F#" Value="member this.Enabled : bool" Usage="Android.Media.Audiofx.Visualizer.Enabled" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getEnabled", "()Z", "GetGetEnabledHandler")]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getEnabled", "()Z", "GetGetEnabledHandler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Get current activation state of the visualizer.</summary>
<value>true if the visualizer is active, false otherwise</value>
<remarks>
<para>Get current activation state of the visualizer.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#getEnabled()" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.getEnabled()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
</Member>
<Member MemberName="Error">
<MemberSignature Language="C#" Value="public const Android.Media.Audiofx.VisualizerStatus Error = -1;" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Android.Media.Audiofx.VisualizerStatus Error = (-1)" />
<MemberSignature Language="DocId" Value="F:Android.Media.Audiofx.Visualizer.Error" />
<MemberSignature Language="F#" Value="val mutable Error : Android.Media.Audiofx.VisualizerStatus" Usage="Android.Media.Audiofx.Visualizer.Error" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("ERROR")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("ERROR")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerStatus</ReturnType>
</ReturnValue>
<MemberValue>-1</MemberValue>
<Docs>
<summary>Unspecified error.</summary>
<remarks>
<para>Unspecified error.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#ERROR" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.ERROR</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
</Member>
<Member MemberName="ErrorBadValue">
<MemberSignature Language="C#" Value="public const Android.Media.Audiofx.VisualizerStatus ErrorBadValue = -4;" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Android.Media.Audiofx.VisualizerStatus ErrorBadValue = (-4)" />
<MemberSignature Language="DocId" Value="F:Android.Media.Audiofx.Visualizer.ErrorBadValue" />
<MemberSignature Language="F#" Value="val mutable ErrorBadValue : Android.Media.Audiofx.VisualizerStatus" Usage="Android.Media.Audiofx.Visualizer.ErrorBadValue" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("ERROR_BAD_VALUE")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("ERROR_BAD_VALUE")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerStatus</ReturnType>
</ReturnValue>
<MemberValue>-4</MemberValue>
<Docs>
<summary>Operation failed due to bad parameter value.</summary>
<remarks>
<para>Operation failed due to bad parameter value.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#ERROR_BAD_VALUE" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.ERROR_BAD_VALUE</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
</Member>
<Member MemberName="ErrorDeadObject">
<MemberSignature Language="C#" Value="public const Android.Media.Audiofx.VisualizerStatus ErrorDeadObject = -7;" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Android.Media.Audiofx.VisualizerStatus ErrorDeadObject = (-7)" />
<MemberSignature Language="DocId" Value="F:Android.Media.Audiofx.Visualizer.ErrorDeadObject" />
<MemberSignature Language="F#" Value="val mutable ErrorDeadObject : Android.Media.Audiofx.VisualizerStatus" Usage="Android.Media.Audiofx.Visualizer.ErrorDeadObject" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("ERROR_DEAD_OBJECT")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("ERROR_DEAD_OBJECT")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerStatus</ReturnType>
</ReturnValue>
<MemberValue>-7</MemberValue>
<Docs>
<summary>Operation failed due to dead remote object.</summary>
<remarks>
<para>Operation failed due to dead remote object.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#ERROR_DEAD_OBJECT" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.ERROR_DEAD_OBJECT</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
</Member>
<Member MemberName="ErrorInvalidOperation">
<MemberSignature Language="C#" Value="public const Android.Media.Audiofx.VisualizerStatus ErrorInvalidOperation = -5;" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Android.Media.Audiofx.VisualizerStatus ErrorInvalidOperation = (-5)" />
<MemberSignature Language="DocId" Value="F:Android.Media.Audiofx.Visualizer.ErrorInvalidOperation" />
<MemberSignature Language="F#" Value="val mutable ErrorInvalidOperation : Android.Media.Audiofx.VisualizerStatus" Usage="Android.Media.Audiofx.Visualizer.ErrorInvalidOperation" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("ERROR_INVALID_OPERATION")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("ERROR_INVALID_OPERATION")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerStatus</ReturnType>
</ReturnValue>
<MemberValue>-5</MemberValue>
<Docs>
<summary>Operation failed because it was requested in wrong state.</summary>
<remarks>
<para>Operation failed because it was requested in wrong state.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#ERROR_INVALID_OPERATION" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.ERROR_INVALID_OPERATION</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
</Member>
<Member MemberName="ErrorNoInit">
<MemberSignature Language="C#" Value="public const Android.Media.Audiofx.VisualizerStatus ErrorNoInit = -3;" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Android.Media.Audiofx.VisualizerStatus ErrorNoInit = (-3)" />
<MemberSignature Language="DocId" Value="F:Android.Media.Audiofx.Visualizer.ErrorNoInit" />
<MemberSignature Language="F#" Value="val mutable ErrorNoInit : Android.Media.Audiofx.VisualizerStatus" Usage="Android.Media.Audiofx.Visualizer.ErrorNoInit" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("ERROR_NO_INIT")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("ERROR_NO_INIT")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerStatus</ReturnType>
</ReturnValue>
<MemberValue>-3</MemberValue>
<Docs>
<summary>Operation failed due to bad object initialization.</summary>
<remarks>
<para>Operation failed due to bad object initialization.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#ERROR_NO_INIT" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.ERROR_NO_INIT</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
</Member>
<Member MemberName="ErrorNoMemory">
<MemberSignature Language="C#" Value="public const Android.Media.Audiofx.VisualizerStatus ErrorNoMemory = -6;" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Android.Media.Audiofx.VisualizerStatus ErrorNoMemory = (-6)" />
<MemberSignature Language="DocId" Value="F:Android.Media.Audiofx.Visualizer.ErrorNoMemory" />
<MemberSignature Language="F#" Value="val mutable ErrorNoMemory : Android.Media.Audiofx.VisualizerStatus" Usage="Android.Media.Audiofx.Visualizer.ErrorNoMemory" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("ERROR_NO_MEMORY")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("ERROR_NO_MEMORY")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerStatus enum directly instead of this field.", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerStatus</ReturnType>
</ReturnValue>
<MemberValue>-6</MemberValue>
<Docs>
<summary>Operation failed due to lack of memory.</summary>
<remarks>
<para>Operation failed due to lack of memory.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#ERROR_NO_MEMORY" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.ERROR_NO_MEMORY</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
</Member>
<Member MemberName="GetCaptureSizeRange">
<MemberSignature Language="C#" Value="public static int[]? GetCaptureSizeRange ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32[] GetCaptureSizeRange() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.Audiofx.Visualizer.GetCaptureSizeRange" />
<MemberSignature Language="F#" Value="static member GetCaptureSizeRange : unit -> int[]" Usage="Android.Media.Audiofx.Visualizer.GetCaptureSizeRange " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("getCaptureSizeRange", "()[I", "")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("getCaptureSizeRange", "()[I", "")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the capture size range.</summary>
<returns>the mininum capture size is returned in first array element and the maximum in second
array element.</returns>
<remarks>
<para>Returns the capture size range.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#getCaptureSizeRange()" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.getCaptureSizeRange()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
</Member>
<Member MemberName="GetFft">
<MemberSignature Language="C#" Value="public virtual Android.Media.Audiofx.VisualizerStatus GetFft (byte[]? fft);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype Android.Media.Audiofx.VisualizerStatus GetFft(unsigned int8[] fft) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.Audiofx.Visualizer.GetFft(System.Byte[])" />
<MemberSignature Language="F#" Value="abstract member GetFft : byte[] -> Android.Media.Audiofx.VisualizerStatus
override this.GetFft : byte[] -> Android.Media.Audiofx.VisualizerStatus" Usage="visualizer.GetFft fft" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("getFft", "([B)I", "GetGetFft_arrayBHandler")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("getFft", "([B)I", "GetGetFft_arrayBHandler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerStatus</ReturnType>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.GeneratedEnum]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.GeneratedEnum>]</AttributeName>
</Attribute>
</Attributes>
</ReturnValue>
<Parameters>
<Parameter Name="fft" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="fft">array of bytes where the FFT should be returned</param>
<summary>Returns a frequency capture of currently playing audio content.</summary>
<returns>
<c>#SUCCESS</c> in case of success,
<c>#ERROR_NO_MEMORY</c>, <c>#ERROR_INVALID_OPERATION</c> or <c>#ERROR_DEAD_OBJECT</c>
in case of failure.</returns>
<remarks>
<para>Returns a frequency capture of currently playing audio content.</para>
<para>This method must be called when the Visualizer is enabled.</para>
<para>The capture is an 8-bit magnitude FFT, the frequency range covered being 0 (DC) to half of
the sampling rate returned by <c>#getSamplingRate()</c>. The capture returns the real and
imaginary parts of a number of frequency points equal to half of the capture size plus one.</para>
<para>Note: only the real part is returned for the first point (DC) and the last point
(sampling frequency / 2).</para>
<para>The layout in the returned byte array is as follows:
<ul>
<li> n is the capture size returned by getCaptureSize()</li>
<li> Rfk, Ifk are respectively the real and imaginary parts of the kth frequency
component</li>
<li> If Fs is the sampling frequency retuned by getSamplingRate() the kth frequency is:
k * Fs / n </li>
</ul>
<table border="0" cellspacing="0" cellpadding="0">
<tr><td>Index</para>
<para></td>
<td>0 </p></td>
<td>1 </p></td>
<td>2 </p></td>
<td>3 </p></td>
<td>4 </p></td>
<td>5 </p></td>
<td>... </p></td>
<td>n - 2 </p></td>
<td>n - 1 </p></td></tr>
<tr><td>Data </p></td>
<td>Rf0 </p></td>
<td>Rf(n/2) </p></td>
<td>Rf1 </p></td>
<td>If1 </p></td>
<td>Rf2 </p></td>
<td>If2 </p></td>
<td>... </p></td>
<td>Rf(n/2-1) </p></td>
<td>If(n/2-1) </p></td></tr>
</table></para>
<para>In order to obtain magnitude and phase values the following code can
be used:</para>
<code lang="text/java">int n = fft.size();
float[] magnitudes = new float[n / 2 + 1];
float[] phases = new float[n / 2 + 1];
magnitudes[0] = (float)Math.abs(fft[0]); // DC
magnitudes[n / 2] = (float)Math.abs(fft[1]); // Nyquist
phases[0] = phases[n / 2] = 0;
for (int k = 1; k &lt; n / 2; k++) {
int i = k * 2;
magnitudes[k] = (float)Math.hypot(fft[i], fft[i + 1]);
phases[k] = (float)Math.atan2(fft[i + 1], fft[i]);
}</code>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#getFft(byte[])" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.getFft(byte[])</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
<exception cref="T:Java.Lang.IllegalStateException" />
</Docs>
</Member>
<Member MemberName="GetMeasurementPeakRms">
<MemberSignature Language="C#" Value="public virtual int GetMeasurementPeakRms (Android.Media.Audiofx.Visualizer.MeasurementPeakRms? measurement);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 GetMeasurementPeakRms(class Android.Media.Audiofx.Visualizer/MeasurementPeakRms measurement) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.Audiofx.Visualizer.GetMeasurementPeakRms(Android.Media.Audiofx.Visualizer.MeasurementPeakRms)" />
<MemberSignature Language="F#" Value="abstract member GetMeasurementPeakRms : Android.Media.Audiofx.Visualizer.MeasurementPeakRms -> int
override this.GetMeasurementPeakRms : Android.Media.Audiofx.Visualizer.MeasurementPeakRms -> int" Usage="visualizer.GetMeasurementPeakRms measurement" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("getMeasurementPeakRms", "(Landroid/media/audiofx/Visualizer$MeasurementPeakRms;)I", "GetGetMeasurementPeakRms_Landroid_media_audiofx_Visualizer_MeasurementPeakRms_Handler")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("getMeasurementPeakRms", "(Landroid/media/audiofx/Visualizer$MeasurementPeakRms;)I", "GetGetMeasurementPeakRms_Landroid_media_audiofx_Visualizer_MeasurementPeakRms_Handler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="measurement" Type="Android.Media.Audiofx.Visualizer+MeasurementPeakRms" />
</Parameters>
<Docs>
<param name="measurement">a non-null <c>Visualizer.MeasurementPeakRms</c> instance to store
the measurement values.</param>
<summary>Retrieves the latest peak and RMS measurement.</summary>
<returns>
<c>#SUCCESS</c> in case of success, <c>#ERROR_BAD_VALUE</c>,
<c>#ERROR_NO_MEMORY</c>, <c>#ERROR_INVALID_OPERATION</c> or <c>#ERROR_DEAD_OBJECT</c>
in case of failure.</returns>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#getMeasurementPeakRms(android.media.audiofx.MeasurementPeakRms)" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.getMeasurementPeakRms(android.media.audiofx.MeasurementPeakRms)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="GetWaveForm">
<MemberSignature Language="C#" Value="public virtual Android.Media.Audiofx.VisualizerStatus GetWaveForm (byte[]? waveform);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype Android.Media.Audiofx.VisualizerStatus GetWaveForm(unsigned int8[] waveform) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.Audiofx.Visualizer.GetWaveForm(System.Byte[])" />
<MemberSignature Language="F#" Value="abstract member GetWaveForm : byte[] -> Android.Media.Audiofx.VisualizerStatus
override this.GetWaveForm : byte[] -> Android.Media.Audiofx.VisualizerStatus" Usage="visualizer.GetWaveForm waveform" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("getWaveForm", "([B)I", "GetGetWaveForm_arrayBHandler")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("getWaveForm", "([B)I", "GetGetWaveForm_arrayBHandler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerStatus</ReturnType>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.GeneratedEnum]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.GeneratedEnum>]</AttributeName>
</Attribute>
</Attributes>
</ReturnValue>
<Parameters>
<Parameter Name="waveform" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="waveform">array of bytes where the waveform should be returned</param>
<summary>Returns a waveform capture of currently playing audio content.</summary>
<returns>
<c>#SUCCESS</c> in case of success,
<c>#ERROR_NO_MEMORY</c>, <c>#ERROR_INVALID_OPERATION</c> or <c>#ERROR_DEAD_OBJECT</c>
in case of failure.</returns>
<remarks>
<para>Returns a waveform capture of currently playing audio content. The capture consists in
a number of consecutive 8-bit (unsigned) mono PCM samples equal to the capture size returned
by <c>#getCaptureSize()</c>.</para>
<para>This method must be called when the Visualizer is enabled.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#getWaveForm(byte[])" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.getWaveForm(byte[])</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
<exception cref="T:Java.Lang.IllegalStateException" />
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
<MemberSignature Language="C#" Value="public override Java.Interop.JniPeerMembers JniPeerMembers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Java.Interop.JniPeerMembers JniPeerMembers" />
<MemberSignature Language="DocId" Value="P:Android.Media.Audiofx.Visualizer.JniPeerMembers" />
<MemberSignature Language="F#" Value="member this.JniPeerMembers : Java.Interop.JniPeerMembers" Usage="Android.Media.Audiofx.Visualizer.JniPeerMembers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="MaxCaptureRate">
<MemberSignature Language="C#" Value="public static int MaxCaptureRate { get; }" />
<MemberSignature Language="ILAsm" Value=".property int32 MaxCaptureRate" />
<MemberSignature Language="DocId" Value="P:Android.Media.Audiofx.Visualizer.MaxCaptureRate" />
<MemberSignature Language="F#" Value="static member MaxCaptureRate : int" Usage="Android.Media.Audiofx.Visualizer.MaxCaptureRate" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getMaxCaptureRate", "()I", "")]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getMaxCaptureRate", "()I", "")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the maximum capture rate for the callback capture method.</summary>
<value>the maximum capture rate expressed in milliHertz</value>
<remarks>
<para>Returns the maximum capture rate for the callback capture method. This is the maximum value
for the rate parameter of the
<c>#setDataCaptureListener(OnDataCaptureListener, int, boolean, boolean)</c> method.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#getMaxCaptureRate()" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.getMaxCaptureRate()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
</Member>
<Member MemberName="MeasurementMode">
<MemberSignature Language="C#" Value="public virtual Android.Media.Audiofx.VisualizerMeasurementMode MeasurementMode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Android.Media.Audiofx.VisualizerMeasurementMode MeasurementMode" />
<MemberSignature Language="DocId" Value="P:Android.Media.Audiofx.Visualizer.MeasurementMode" />
<MemberSignature Language="F#" Value="member this.MeasurementMode : Android.Media.Audiofx.VisualizerMeasurementMode" Usage="Android.Media.Audiofx.Visualizer.MeasurementMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getMeasurementMode", "()I", "GetGetMeasurementModeHandler")]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getMeasurementMode", "()I", "GetGetMeasurementModeHandler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerMeasurementMode</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the current measurement modes performed by this audio effect</summary>
<value>the mask of the measurements,
<c>#MEASUREMENT_MODE_NONE</c> (when no measurements are performed)
or <c>#MEASUREMENT_MODE_PEAK_RMS</c>.</value>
<remarks>
<para>Returns the current measurement modes performed by this audio effect</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#getMeasurementMode()" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.getMeasurementMode()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<exception cref="T:Java.Lang.IllegalStateException" />
</Docs>
<since version="Added in API level 19" />
</Member>
<Member MemberName="MeasurementModeNone">
<MemberSignature Language="C#" Value="public const Android.Media.Audiofx.VisualizerMeasurementMode MeasurementModeNone = 0;" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Android.Media.Audiofx.VisualizerMeasurementMode MeasurementModeNone = (0)" />
<MemberSignature Language="DocId" Value="F:Android.Media.Audiofx.Visualizer.MeasurementModeNone" />
<MemberSignature Language="F#" Value="val mutable MeasurementModeNone : Android.Media.Audiofx.VisualizerMeasurementMode" Usage="Android.Media.Audiofx.Visualizer.MeasurementModeNone" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("MEASUREMENT_MODE_NONE")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("MEASUREMENT_MODE_NONE")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerMeasurementMode enum directly instead of this field.", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerMeasurementMode enum directly instead of this field.", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerMeasurementMode</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Defines a measurement mode in which no measurements are performed.</summary>
<remarks>
<para>Defines a measurement mode in which no measurements are performed.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#MEASUREMENT_MODE_NONE" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.MEASUREMENT_MODE_NONE</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="MeasurementModePeakRms">
<MemberSignature Language="C#" Value="public const Android.Media.Audiofx.VisualizerMeasurementMode MeasurementModePeakRms = 1;" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Android.Media.Audiofx.VisualizerMeasurementMode MeasurementModePeakRms = (1)" />
<MemberSignature Language="DocId" Value="F:Android.Media.Audiofx.Visualizer.MeasurementModePeakRms" />
<MemberSignature Language="F#" Value="val mutable MeasurementModePeakRms : Android.Media.Audiofx.VisualizerMeasurementMode" Usage="Android.Media.Audiofx.Visualizer.MeasurementModePeakRms" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("MEASUREMENT_MODE_PEAK_RMS")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("MEASUREMENT_MODE_PEAK_RMS")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerMeasurementMode enum directly instead of this field.", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This constant will be removed in the future version. Use Android.Media.Audiofx.VisualizerMeasurementMode enum directly instead of this field.", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Media.Audiofx.VisualizerMeasurementMode</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Defines a measurement mode which computes the peak and RMS value in mB below the
"full scale", where 0mB is normally the maximum sample value (but see the note
below).</summary>
<remarks>
<para>Defines a measurement mode which computes the peak and RMS value in mB below the
"full scale", where 0mB is normally the maximum sample value (but see the note
below). Minimum value depends on the resolution of audio samples used by the audio
framework. The value of -9600mB is the minimum value for 16-bit audio systems and
-14400mB or below for "high resolution" systems. Values for peak and RMS can be
retrieved with <c>#getMeasurementPeakRms(MeasurementPeakRms)</c>.
<p class=note><strong>Note:</strong> when Visualizer effect is attached to the
global session (with session ID 0), it is possible to observe RMS peaks higher than
0 dBFS, for example in the case when there are multiple audio sources playing
simultaneously. In this case <c>#getMeasurementPeakRms(MeasurementPeakRms)</c>
method can return a positive value.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#MEASUREMENT_MODE_PEAK_RMS" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.MEASUREMENT_MODE_PEAK_RMS</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Release">
<MemberSignature Language="C#" Value="public virtual void Release ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Release() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.Audiofx.Visualizer.Release" />
<MemberSignature Language="F#" Value="abstract member Release : unit -> unit
override this.Release : unit -> unit" Usage="visualizer.Release " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("release", "()V", "GetReleaseHandler")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("release", "()V", "GetReleaseHandler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Releases the native Visualizer resources.</summary>
<remarks>
<para>Releases the native Visualizer resources. It is a good practice to release the
visualization engine when not in use.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/audiofx/Visualizer#release()" title="Reference documentation">Java documentation for <code>android.media.audiofx.Visualizer.release()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
</Docs>
</Member>
<Member MemberName="SamplingRate">
<MemberSignature Language="C#" Value="public virtual int SamplingRate { get; }" />