/
MediaPlayer.xml
5688 lines (5668 loc) · 400 KB
/
MediaPlayer.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="MediaPlayer" FullName="Android.Media.MediaPlayer">
<TypeSignature Language="C#" Value="public class MediaPlayer : Java.Lang.Object, Android.Media.IAudioRouting, Android.Media.IVolumeAutomation, IDisposable, Java.Interop.IJavaPeerable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MediaPlayer extends Java.Lang.Object implements class Android.Media.IAudioRouting, class Android.Media.IVolumeAutomation, class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Android.Media.MediaPlayer" />
<TypeSignature Language="F#" Value="type MediaPlayer = class
 inherit Object
 interface IAudioRouting
 interface IJavaObject
 interface IDisposable
 interface IJavaPeerable
 interface IVolumeAutomation" />
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Java.Lang.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Android.Media.IAudioRouting</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Android.Media.IVolumeAutomation</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Android.Runtime.IJavaObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Java.Interop.IJavaPeerable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("android/media/MediaPlayer", DoNotGenerateAcw=true)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("android/media/MediaPlayer", DoNotGenerateAcw=true)>]</AttributeName>
</Attribute>
</Attributes>
<Docs since="1">
<summary>MediaPlayer class can be used to control playback of audio/video files and streams.</summary>
<remarks>
<para>MediaPlayer class can be used to control playback of audio/video files and streams.</para>
<para>MediaPlayer is not thread-safe. Creation of and all access to player instances
should be on the same thread. If registering callbacks,
the thread must have a Looper.</para>
<para>Topics covered here are:
<ol>
<li>State Diagram<li>Valid and Invalid States<li>Permissions<li>Register informational and error callbacks</ol>
<div class="special reference">
<h3>Developer Guides</h3></para>
<para>For more information about how to use MediaPlayer, read the
<see href="https://developer.android.com/guide/topics/media/mediaplayer.html">Media Playback</see> developer guide.</para>
<para></div>
"StateDiagram"><h3>State Diagram</h3></para>
<para>Playback control of audio/video files and streams is managed as a state
machine. The following diagram shows the life cycle and the states of a
MediaPlayer object driven by the supported playback control operations.
The ovals represent the states a MediaPlayer object may reside
in. The arcs represent the playback control operations that drive the object
state transition. There are two types of arcs. The arcs with a single arrow
head represent synchronous method calls, while those with
a double arrow head represent asynchronous method calls.</para>
<para><img src="../../../images/mediaplayer_state_diagram.gif"
alt="MediaPlayer State diagram"
border="0" /></para>
<para>From this state diagram, one can see that a MediaPlayer object has the
following states:</para>
<para><ul>
<li>When a MediaPlayer object is just created using <c>new</c> or
after <c>#reset()</c> is called, it is in the <em>Idle</em> state; and after
<c>#release()</c> is called, it is in the <em>End</em> state. Between these
two states is the life cycle of the MediaPlayer object.
<ul>
<li>There is a subtle but important difference between a newly constructed
MediaPlayer object and the MediaPlayer object after <c>#reset()</c>
is called. It is a programming error to invoke methods such
as <c>#getCurrentPosition()</c>,
<c>#getDuration()</c>, <c>#getVideoHeight()</c>,
<c>#getVideoWidth()</c>, <c>#setAudioAttributes(AudioAttributes)</c>,
<c>#setLooping(boolean)</c>,
<c>#setVolume(float, float)</c>, <c>#pause()</c>, <c>#start()</c>,
<c>#stop()</c>, <c>#seekTo(long, int)</c>, <c>#prepare()</c> or
<c>#prepareAsync()</c> in the <em>Idle</em> state for both cases. If any of these
methods is called right after a MediaPlayer object is constructed,
the user supplied callback method OnErrorListener.onError() won't be
called by the internal player engine and the object state remains
unchanged; but if these methods are called right after <c>#reset()</c>,
the user supplied callback method OnErrorListener.onError() will be
invoked by the internal player engine and the object will be
transfered to the <em>Error</em> state. </li>
<li>You must keep a reference to a MediaPlayer instance to prevent it from being garbage
collected. If a MediaPlayer instance is garbage collected, <c>#release</c> will be
called, causing any ongoing playback to stop.
<li>You must call <c>#release()</c> once you have finished using an instance to release
acquired resources, such as memory and codecs. Once you have called <c>#release</c>, you
must no longer interact with the released instance.
<li>MediaPlayer objects created using <c>new</c> is in the
<em>Idle</em> state, while those created with one
of the overloaded convenient <c>create</c> methods are <em>NOT</em>
in the <em>Idle</em> state. In fact, the objects are in the <em>Prepared</em>
state if the creation using <c>create</c> method is successful.
</li>
</ul>
</li>
<li>In general, some playback control operation may fail due to various
reasons, such as unsupported audio/video format, poorly interleaved
audio/video, resolution too high, streaming timeout, and the like.
Thus, error reporting and recovery is an important concern under
these circumstances. Sometimes, due to programming errors, invoking a playback
control operation in an invalid state may also occur. Under all these
error conditions, the internal player engine invokes a user supplied
OnErrorListener.onError() method if an OnErrorListener has been
registered beforehand via
<c>#setOnErrorListener(android.media.MediaPlayer.OnErrorListener)</c>.
<ul>
<li>It is important to note that once an error occurs, the
MediaPlayer object enters the <em>Error</em> state (except as noted
above), even if an error listener has not been registered by the application.</li>
<li>In order to reuse a MediaPlayer object that is in the <em>
Error</em> state and recover from the error,
<c>#reset()</c> can be called to restore the object to its <em>Idle</em>
state.</li>
<li>It is good programming practice to have your application
register a OnErrorListener to look out for error notifications from
the internal player engine.</li>
<li>IllegalStateException is
thrown to prevent programming errors such as calling <c>#prepare()</c>,
<c>#prepareAsync()</c>, or one of the overloaded <c>setDataSource
</c> methods in an invalid state. </li>
</ul>
</li>
<li>Calling
<c>#setDataSource(FileDescriptor)</c>, or
<c>#setDataSource(String)</c>, or
<c>#setDataSource(Context, Uri)</c>, or
<c>#setDataSource(FileDescriptor, long, long)</c>, or
<c>#setDataSource(MediaDataSource)</c> transfers a
MediaPlayer object in the <em>Idle</em> state to the
<em>Initialized</em> state.
<ul>
<li>An IllegalStateException is thrown if
setDataSource() is called in any other state.</li>
<li>It is good programming
practice to always look out for <c>IllegalArgumentException</c>
and <c>IOException</c> that may be thrown from the overloaded
<c>setDataSource</c> methods.</li>
</ul>
</li>
<li>A MediaPlayer object must first enter the <em>Prepared</em> state
before playback can be started.
<ul>
<li>There are two ways (synchronous vs.
asynchronous) that the <em>Prepared</em> state can be reached:
either a call to <c>#prepare()</c> (synchronous) which
transfers the object to the <em>Prepared</em> state once the method call
returns, or a call to <c>#prepareAsync()</c> (asynchronous) which
first transfers the object to the <em>Preparing</em> state after the
call returns (which occurs almost right away) while the internal
player engine continues working on the rest of preparation work
until the preparation work completes. When the preparation completes or when <c>#prepare()</c> call returns,
the internal player engine then calls a user supplied callback method,
onPrepared() of the OnPreparedListener interface, if an
OnPreparedListener is registered beforehand via <c>#setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener)</c>.</li>
<li>It is important to note that
the <em>Preparing</em> state is a transient state, and the behavior
of calling any method with side effect while a MediaPlayer object is
in the <em>Preparing</em> state is undefined.</li>
<li>An IllegalStateException is
thrown if <c>#prepare()</c> or <c>#prepareAsync()</c> is called in
any other state.</li>
<li>While in the <em>Prepared</em> state, properties
such as audio/sound volume, screenOnWhilePlaying, looping can be
adjusted by invoking the corresponding set methods.</li>
</ul>
</li>
<li>To start the playback, <c>#start()</c> must be called. After
<c>#start()</c> returns successfully, the MediaPlayer object is in the
<em>Started</em> state. <c>#isPlaying()</c> can be called to test
whether the MediaPlayer object is in the <em>Started</em> state.
<ul>
<li>While in the <em>Started</em> state, the internal player engine calls
a user supplied OnBufferingUpdateListener.onBufferingUpdate() callback
method if a OnBufferingUpdateListener has been registered beforehand
via <c>#setOnBufferingUpdateListener(OnBufferingUpdateListener)</c>.
This callback allows applications to keep track of the buffering status
while streaming audio/video.</li>
<li>Calling <c>#start()</c> has no effect
on a MediaPlayer object that is already in the <em>Started</em> state.</li>
</ul>
</li>
<li>Playback can be paused and stopped, and the current playback position
can be adjusted. Playback can be paused via <c>#pause()</c>. When the call to
<c>#pause()</c> returns, the MediaPlayer object enters the
<em>Paused</em> state. Note that the transition from the <em>Started</em>
state to the <em>Paused</em> state and vice versa happens
asynchronously in the player engine. It may take some time before
the state is updated in calls to <c>#isPlaying()</c>, and it can be
a number of seconds in the case of streamed content.
<ul>
<li>Calling <c>#start()</c> to resume playback for a paused
MediaPlayer object, and the resumed playback
position is the same as where it was paused. When the call to
<c>#start()</c> returns, the paused MediaPlayer object goes back to
the <em>Started</em> state.</li>
<li>Calling <c>#pause()</c> has no effect on
a MediaPlayer object that is already in the <em>Paused</em> state.</li>
</ul>
</li>
<li>Calling <c>#stop()</c> stops playback and causes a
MediaPlayer in the <em>Started</em>, <em>Paused</em>, <em>Prepared
</em> or <em>PlaybackCompleted</em> state to enter the
<em>Stopped</em> state.
<ul>
<li>Once in the <em>Stopped</em> state, playback cannot be started
until <c>#prepare()</c> or <c>#prepareAsync()</c> are called to set
the MediaPlayer object to the <em>Prepared</em> state again.</li>
<li>Calling <c>#stop()</c> has no effect on a MediaPlayer
object that is already in the <em>Stopped</em> state.</li>
</ul>
</li>
<li>The playback position can be adjusted with a call to
<c>#seekTo(long, int)</c>.
<ul>
<li>Although the asynchronuous <c>#seekTo(long, int)</c>
call returns right away, the actual seek operation may take a while to
finish, especially for audio/video being streamed. When the actual
seek operation completes, the internal player engine calls a user
supplied OnSeekComplete.onSeekComplete() if an OnSeekCompleteListener
has been registered beforehand via
<c>#setOnSeekCompleteListener(OnSeekCompleteListener)</c>.</li>
<li>Please
note that <c>#seekTo(long, int)</c> can also be called in the other states,
such as <em>Prepared</em>, <em>Paused</em> and <em>PlaybackCompleted
</em> state. When <c>#seekTo(long, int)</c> is called in those states,
one video frame will be displayed if the stream has video and the requested
position is valid.
</li>
<li>Furthermore, the actual current playback position
can be retrieved with a call to <c>#getCurrentPosition()</c>, which
is helpful for applications such as a Music player that need to keep
track of the playback progress.</li>
</ul>
</li>
<li>When the playback reaches the end of stream, the playback completes.
<ul>
<li>If the looping mode was being set to <var>true</var> with
<c>#setLooping(boolean)</c>, the MediaPlayer object shall remain in
the <em>Started</em> state.</li>
<li>If the looping mode was set to <var>false
</var>, the player engine calls a user supplied callback method,
OnCompletion.onCompletion(), if a OnCompletionListener is registered
beforehand via <c>#setOnCompletionListener(OnCompletionListener)</c>.
The invoke of the callback signals that the object is now in the <em>
PlaybackCompleted</em> state.</li>
<li>While in the <em>PlaybackCompleted</em>
state, calling <c>#start()</c> can restart the playback from the
beginning of the audio/video source.</li>
</ul>
"Valid_and_Invalid_States"><h3>Valid and invalid states</h3>
<table border="0" cellspacing="0" cellpadding="0">
<tr><td>Method Name </p></td>
<td>Valid States </p></td>
<td>Invalid States </p></td>
<td>Comments </p></td></tr>
<tr><td>attachAuxEffect </p></td>
<td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted}</p></td>
<td>{Idle, Error}</p></td>
<td>This method must be called after setDataSource.
Calling it does not change the object state. </p></td></tr>
<tr><td>getAudioSessionId </p></td>
<td>any </p></td>
<td>{}</p></td>
<td>This method can be called in any state and calling it does not change
the object state. </p></td></tr>
<tr><td>getCurrentPosition </p></td>
<td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
PlaybackCompleted}</p></td>
<td>{Error}</p></td>
<td>Successful invoke of this method in a valid state does not change the
state. Calling this method in an invalid state transfers the object
to the <em>Error</em> state. </p></td></tr>
<tr><td>getDuration </p></td>
<td>{Prepared, Started, Paused, Stopped, PlaybackCompleted}</p></td>
<td>{Idle, Initialized, Error}</p></td>
<td>Successful invoke of this method in a valid state does not change the
state. Calling this method in an invalid state transfers the object
to the <em>Error</em> state. </p></td></tr>
<tr><td>getVideoHeight </p></td>
<td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
PlaybackCompleted}</p></td>
<td>{Error}</p></td>
<td>Successful invoke of this method in a valid state does not change the
state. Calling this method in an invalid state transfers the object
to the <em>Error</em> state. </p></td></tr>
<tr><td>getVideoWidth </p></td>
<td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
PlaybackCompleted}</p></td>
<td>{Error}</p></td>
<td>Successful invoke of this method in a valid state does not change
the state. Calling this method in an invalid state transfers the
object to the <em>Error</em> state. </p></td></tr>
<tr><td>isPlaying </p></td>
<td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
PlaybackCompleted}</p></td>
<td>{Error}</p></td>
<td>Successful invoke of this method in a valid state does not change
the state. Calling this method in an invalid state transfers the
object to the <em>Error</em> state. </p></td></tr>
<tr><td>pause </p></td>
<td>{Started, Paused, PlaybackCompleted}</p></td>
<td>{Idle, Initialized, Prepared, Stopped, Error}</p></td>
<td>Successful invoke of this method in a valid state transfers the
object to the <em>Paused</em> state. Calling this method in an
invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
<tr><td>prepare </p></td>
<td>{Initialized, Stopped}</p></td>
<td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error}</p></td>
<td>Successful invoke of this method in a valid state transfers the
object to the <em>Prepared</em> state. Calling this method in an
invalid state throws an IllegalStateException.</p></td></tr>
<tr><td>prepareAsync </p></td>
<td>{Initialized, Stopped}</p></td>
<td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error}</p></td>
<td>Successful invoke of this method in a valid state transfers the
object to the <em>Preparing</em> state. Calling this method in an
invalid state throws an IllegalStateException.</p></td></tr>
<tr><td>release </p></td>
<td>any </p></td>
<td>{}</p></td>
<td>After <c>#release()</c>, you must not interact with the object. </p></td></tr>
<tr><td>reset </p></td>
<td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
PlaybackCompleted, Error}</p></td>
<td>{}</p></td>
<td>After <c>#reset()</c>, the object is like being just created.</p></td></tr>
<tr><td>seekTo </p></td>
<td>{Prepared, Started, Paused, PlaybackCompleted}</p></td>
<td>{Idle, Initialized, Stopped, Error}</p></td>
<td>Successful invoke of this method in a valid state does not change
the state. Calling this method in an invalid state transfers the
object to the <em>Error</em> state. </p></td></tr>
<tr><td>setAudioAttributes </p></td>
<td>{Idle, Initialized, Stopped, Prepared, Started, Paused,
PlaybackCompleted}</p></td>
<td>{Error}</p></td>
<td>Successful invoke of this method does not change the state. In order for the
target audio attributes type to become effective, this method must be called before
prepare() or prepareAsync().</p></td></tr>
<tr><td>setAudioSessionId </p></td>
<td>{Idle}</p></td>
<td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted,
Error}</p></td>
<td>This method must be called in idle state as the audio session ID must be known before
calling setDataSource. Calling it does not change the object state. </p></td></tr>
<tr><td>setAudioStreamType (deprecated)</p></td>
<td>{Idle, Initialized, Stopped, Prepared, Started, Paused,
PlaybackCompleted}</p></td>
<td>{Error}</p></td>
<td>Successful invoke of this method does not change the state. In order for the
target audio stream type to become effective, this method must be called before
prepare() or prepareAsync().</p></td></tr>
<tr><td>setAuxEffectSendLevel </p></td>
<td>any</p></td>
<td>{}</p></td>
<td>Calling this method does not change the object state. </p></td></tr>
<tr><td>setDataSource </p></td>
<td>{Idle}</p></td>
<td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted,
Error}</p></td>
<td>Successful invoke of this method in a valid state transfers the
object to the <em>Initialized</em> state. Calling this method in an
invalid state throws an IllegalStateException.</p></td></tr>
<tr><td>setDisplay </p></td>
<td>any </p></td>
<td>{}</p></td>
<td>This method can be called in any state and calling it does not change
the object state. </p></td></tr>
<tr><td>setSurface </p></td>
<td>any </p></td>
<td>{}</p></td>
<td>This method can be called in any state and calling it does not change
the object state. </p></td></tr>
<tr><td>setVideoScalingMode </p></td>
<td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted}</p></td>
<td>{Idle, Error}</p></td>
<td>Successful invoke of this method does not change the state.</p></td></tr>
<tr><td>setLooping </p></td>
<td>{Idle, Initialized, Stopped, Prepared, Started, Paused,
PlaybackCompleted}</p></td>
<td>{Error}</p></td>
<td>Successful invoke of this method in a valid state does not change
the state. Calling this method in an
invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
<tr><td>isLooping </p></td>
<td>any </p></td>
<td>{}</p></td>
<td>This method can be called in any state and calling it does not change
the object state. </p></td></tr>
<tr><td>setOnBufferingUpdateListener </p></td>
<td>any </p></td>
<td>{}</p></td>
<td>This method can be called in any state and calling it does not change
the object state. </p></td></tr>
<tr><td>setOnCompletionListener </p></td>
<td>any </p></td>
<td>{}</p></td>
<td>This method can be called in any state and calling it does not change
the object state. </p></td></tr>
<tr><td>setOnErrorListener </p></td>
<td>any </p></td>
<td>{}</p></td>
<td>This method can be called in any state and calling it does not change
the object state. </p></td></tr>
<tr><td>setOnPreparedListener </p></td>
<td>any </p></td>
<td>{}</p></td>
<td>This method can be called in any state and calling it does not change
the object state. </p></td></tr>
<tr><td>setOnSeekCompleteListener </p></td>
<td>any </p></td>
<td>{}</p></td>
<td>This method can be called in any state and calling it does not change
the object state. </p></td></tr>
<tr><td>setPlaybackParams</p></td>
<td>{Initialized, Prepared, Started, Paused, PlaybackCompleted, Error}</p></td>
<td>{Idle, Stopped}</p></td>
<td>This method will change state in some cases, depending on when it's called.
</p></td></tr>
<tr><td>setScreenOnWhilePlaying</></td>
<td>any </p></td>
<td>{}</p></td>
<td>This method can be called in any state and calling it does not change
the object state. </p></td></tr>
<tr><td>setVolume </p></td>
<td>{Idle, Initialized, Stopped, Prepared, Started, Paused,
PlaybackCompleted}</p></td>
<td>{Error}</p></td>
<td>Successful invoke of this method does not change the state.
<tr><td>setWakeMode </p></td>
<td>any </p></td>
<td>{}</p></td>
<td>This method can be called in any state and calling it does not change
the object state.</p></td></tr>
<tr><td>start </p></td>
<td>{Prepared, Started, Paused, PlaybackCompleted}</p></td>
<td>{Idle, Initialized, Stopped, Error}</p></td>
<td>Successful invoke of this method in a valid state transfers the
object to the <em>Started</em> state. Calling this method in an
invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
<tr><td>stop </p></td>
<td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td>
<td>{Idle, Initialized, Error}</p></td>
<td>Successful invoke of this method in a valid state transfers the
object to the <em>Stopped</em> state. Calling this method in an
invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
<tr><td>getTrackInfo </p></td>
<td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td>
<td>{Idle, Initialized, Error}</p></td>
<td>Successful invoke of this method does not change the state.</p></td></tr>
<tr><td>addTimedTextSource </p></td>
<td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td>
<td>{Idle, Initialized, Error}</p></td>
<td>Successful invoke of this method does not change the state.</p></td></tr>
<tr><td>selectTrack </p></td>
<td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td>
<td>{Idle, Initialized, Error}</p></td>
<td>Successful invoke of this method does not change the state.</p></td></tr>
<tr><td>deselectTrack </p></td>
<td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td>
<td>{Idle, Initialized, Error}</p></td>
<td>Successful invoke of this method does not change the state.</p></td></tr>
</table>
"Permissions"><h3>Permissions</h3></para>
<para>One may need to declare a corresponding WAKE_LOCK permission <c>android.R.styleable#AndroidManifestUsesPermission &lt;uses-permission&gt;</c>
element.</para>
<para>This class requires the <c>android.Manifest.permission#INTERNET</c> permission
when used with network-based content.
"Callbacks"><h3>Callbacks</h3></para>
<para>Applications may want to register for informational and error
events in order to be informed of some internal state update and
possible runtime errors during playback or streaming. Registration for
these events is done by properly setting the appropriate listeners (via calls
to
<c>#setOnPreparedListener(OnPreparedListener) setOnPreparedListener</c>,
<c>#setOnVideoSizeChangedListener(OnVideoSizeChangedListener) setOnVideoSizeChangedListener</c>,
<c>#setOnSeekCompleteListener(OnSeekCompleteListener) setOnSeekCompleteListener</c>,
<c>#setOnCompletionListener(OnCompletionListener) setOnCompletionListener</c>,
<c>#setOnBufferingUpdateListener(OnBufferingUpdateListener) setOnBufferingUpdateListener</c>,
<c>#setOnInfoListener(OnInfoListener) setOnInfoListener</c>,
<c>#setOnErrorListener(OnErrorListener) setOnErrorListener</c>, etc).
In order to receive the respective callback
associated with these listeners, applications are required to create
MediaPlayer objects on a thread with its own Looper running (main UI
thread by default has a Looper running).</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/MediaPlayer" title="Reference documentation">Java documentation for <code>android.media.MediaPlayer</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 1" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MediaPlayer ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.MediaPlayer.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register(".ctor", "()V", "")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register(".ctor", "()V", "")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Default constructor.</summary>
<remarks>
<para>Default constructor.</para>
<para>Consider using one of the create() methods for synchronously instantiating a MediaPlayer
from a Uri or resource.</para>
<para>You must call <c>#release()</c> when you are finished using the instantiated instance.
Doing so frees any resources you have previously acquired.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/MediaPlayer#MediaPlayer()" title="Reference documentation">Java documentation for <code>android.media.MediaPlayer.MediaPlayer()</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 1" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MediaPlayer (Android.Content.Context context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Android.Content.Context context) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.MediaPlayer.#ctor(Android.Content.Context)" />
<MemberSignature Language="F#" Value="new Android.Media.MediaPlayer : Android.Content.Context -> Android.Media.MediaPlayer" Usage="new Android.Media.MediaPlayer context" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register(".ctor", "(Landroid/content/Context;)V", "", ApiSince=34)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register(".ctor", "(Landroid/content/Context;)V", "", ApiSince=34)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android34.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android34.0")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="context" Type="Android.Content.Context" />
</Parameters>
<Docs>
<param name="context">non-null context. This context will be used to pull information,
such as <c>android.content.AttributionSource</c> and device specific session ids, which
will be associated with the <c>MediaPlayer</c>.
However, the context itself will not be retained by the MediaPlayer.</param>
<summary>Default constructor with context.</summary>
<remarks>
<para>Default constructor with context.</para>
<para />
<para>Consider using one of the create() methods for synchronously instantiating a
MediaPlayer from a Uri or resource.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/MediaPlayer#MediaPlayer(android.content.Context)" title="Reference documentation">Java documentation for <code>android.media.MediaPlayer.MediaPlayer(android.content.Context)</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=".ctor">
<MemberSignature Language="C#" Value="protected MediaPlayer (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.MediaPlayer.#ctor(System.IntPtr,Android.Runtime.JniHandleOwnership)" />
<MemberSignature Language="F#" Value="new Android.Media.MediaPlayer : nativeint * Android.Runtime.JniHandleOwnership -> Android.Media.MediaPlayer" Usage="new Android.Media.MediaPlayer (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="AddOnRoutingChangedListener">
<MemberSignature Language="C#" Value="public virtual void AddOnRoutingChangedListener (Android.Media.IAudioRoutingOnRoutingChangedListener? listener, Android.OS.Handler? handler);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AddOnRoutingChangedListener(class Android.Media.IAudioRoutingOnRoutingChangedListener listener, class Android.OS.Handler handler) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.MediaPlayer.AddOnRoutingChangedListener(Android.Media.IAudioRoutingOnRoutingChangedListener,Android.OS.Handler)" />
<MemberSignature Language="F#" Value="abstract member AddOnRoutingChangedListener : Android.Media.IAudioRoutingOnRoutingChangedListener * Android.OS.Handler -> unit
override this.AddOnRoutingChangedListener : Android.Media.IAudioRoutingOnRoutingChangedListener * Android.OS.Handler -> unit" Usage="mediaPlayer.AddOnRoutingChangedListener (listener, handler)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Android.Media.IAudioRouting.AddOnRoutingChangedListener(Android.Media.IAudioRoutingOnRoutingChangedListener,Android.OS.Handler)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("addOnRoutingChangedListener", "(Landroid/media/AudioRouting$OnRoutingChangedListener;Landroid/os/Handler;)V", "GetAddOnRoutingChangedListener_Landroid_media_AudioRouting_OnRoutingChangedListener_Landroid_os_Handler_Handler", ApiSince=28)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("addOnRoutingChangedListener", "(Landroid/media/AudioRouting$OnRoutingChangedListener;Landroid/os/Handler;)V", "GetAddOnRoutingChangedListener_Landroid_media_AudioRouting_OnRoutingChangedListener_Landroid_os_Handler_Handler", ApiSince=28)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android28.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android28.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="listener" Type="Android.Media.IAudioRoutingOnRoutingChangedListener" />
<Parameter Name="handler" Type="Android.OS.Handler" />
</Parameters>
<Docs>
<param name="listener">The <c>AudioRouting.OnRoutingChangedListener</c> interface to receive
notifications of rerouting events.</param>
<param name="handler">Specifies the <c>Handler</c> object for the thread on which to execute
the callback. If <code>null</code>, the handler on the main looper will be used.</param>
<summary>Adds an <c>AudioRouting.OnRoutingChangedListener</c> to receive notifications of routing
changes on this MediaPlayer.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/MediaPlayer#addOnRoutingChangedListener(android.media.OnRoutingChangedListener,%20android.os.Handler)" title="Reference documentation">Java documentation for <code>android.media.MediaPlayer.addOnRoutingChangedListener(android.media.OnRoutingChangedListener, android.os.Handler)</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="AddTimedTextSource">
<MemberSignature Language="C#" Value="public virtual void AddTimedTextSource (Java.IO.FileDescriptor? fd, string? mimeType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AddTimedTextSource(class Java.IO.FileDescriptor fd, string mimeType) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.MediaPlayer.AddTimedTextSource(Java.IO.FileDescriptor,System.String)" />
<MemberSignature Language="F#" Value="abstract member AddTimedTextSource : Java.IO.FileDescriptor * string -> unit
override this.AddTimedTextSource : Java.IO.FileDescriptor * string -> unit" Usage="mediaPlayer.AddTimedTextSource (fd, mimeType)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("addTimedTextSource", "(Ljava/io/FileDescriptor;Ljava/lang/String;)V", "GetAddTimedTextSource_Ljava_io_FileDescriptor_Ljava_lang_String_Handler")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("addTimedTextSource", "(Ljava/io/FileDescriptor;Ljava/lang/String;)V", "GetAddTimedTextSource_Ljava_io_FileDescriptor_Ljava_lang_String_Handler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fd" Type="Java.IO.FileDescriptor" />
<Parameter Name="mimeType" Type="System.String" />
</Parameters>
<Docs>
<param name="fd">the FileDescriptor for the file you want to play</param>
<param name="mimeType">The mime type of the file. Must be one of the mime types listed above.</param>
<summary>Adds an external timed text source file (FileDescriptor).</summary>
<remarks>
<para>Adds an external timed text source file (FileDescriptor).
It is the caller's responsibility to close the file descriptor.
It is safe to do so as soon as this call returns.
Currently supported format is SubRip. Note that a single external timed text source may
contain multiple tracks in it. One can find the total number of available tracks
using <c>#getTrackInfo()</c> to see what additional tracks become available
after this method call.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/MediaPlayer#addTimedTextSource(java.io.FileDescriptor,%20java.lang.String)" title="Reference documentation">Java documentation for <code>android.media.MediaPlayer.addTimedTextSource(java.io.FileDescriptor, java.lang.String)</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 16" />
<exception cref="T:Java.Lang.IllegalArgumentException">if the mimeType is not supported.</exception>
<exception cref="T:Java.Lang.IllegalStateException">if called in an invalid state.
</exception>
</Docs>
</Member>
<Member MemberName="AddTimedTextSource">
<MemberSignature Language="C#" Value="public virtual void AddTimedTextSource (string? path, string? mimeType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AddTimedTextSource(string path, string mimeType) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.MediaPlayer.AddTimedTextSource(System.String,System.String)" />
<MemberSignature Language="F#" Value="abstract member AddTimedTextSource : string * string -> unit
override this.AddTimedTextSource : string * string -> unit" Usage="mediaPlayer.AddTimedTextSource (path, mimeType)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("addTimedTextSource", "(Ljava/lang/String;Ljava/lang/String;)V", "GetAddTimedTextSource_Ljava_lang_String_Ljava_lang_String_Handler")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("addTimedTextSource", "(Ljava/lang/String;Ljava/lang/String;)V", "GetAddTimedTextSource_Ljava_lang_String_Ljava_lang_String_Handler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="System.String" />
<Parameter Name="mimeType" Type="System.String" />
</Parameters>
<Docs>
<param name="path">The file path of external timed text source file.</param>
<param name="mimeType">The mime type of the file. Must be one of the mime types listed above.</param>
<summary>Adds an external timed text source file.</summary>
<remarks>
<para>Adds an external timed text source file.
Currently supported format is SubRip with the file extension .srt, case insensitive.
Note that a single external timed text source may contain multiple tracks in it.
One can find the total number of available tracks using <c>#getTrackInfo()</c> to see what
additional tracks become available after this method call.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/MediaPlayer#addTimedTextSource(java.lang.String,%20java.lang.String)" title="Reference documentation">Java documentation for <code>android.media.MediaPlayer.addTimedTextSource(java.lang.String, java.lang.String)</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 16" />
<exception cref="T:Java.IO.IOException">if the file cannot be accessed or is corrupted.</exception>
<exception cref="T:Java.Lang.IllegalArgumentException">if the mimeType is not supported.</exception>
<exception cref="T:Java.Lang.IllegalStateException">if called in an invalid state.
</exception>
</Docs>
</Member>
<Member MemberName="AddTimedTextSource">
<MemberSignature Language="C#" Value="public virtual void AddTimedTextSource (Android.Content.Context? context, Android.Net.Uri? uri, string? mimeType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AddTimedTextSource(class Android.Content.Context context, class Android.Net.Uri uri, string mimeType) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.MediaPlayer.AddTimedTextSource(Android.Content.Context,Android.Net.Uri,System.String)" />
<MemberSignature Language="F#" Value="abstract member AddTimedTextSource : Android.Content.Context * Android.Net.Uri * string -> unit
override this.AddTimedTextSource : Android.Content.Context * Android.Net.Uri * string -> unit" Usage="mediaPlayer.AddTimedTextSource (context, uri, mimeType)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("addTimedTextSource", "(Landroid/content/Context;Landroid/net/Uri;Ljava/lang/String;)V", "GetAddTimedTextSource_Landroid_content_Context_Landroid_net_Uri_Ljava_lang_String_Handler")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("addTimedTextSource", "(Landroid/content/Context;Landroid/net/Uri;Ljava/lang/String;)V", "GetAddTimedTextSource_Landroid_content_Context_Landroid_net_Uri_Ljava_lang_String_Handler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Android.Content.Context" />
<Parameter Name="uri" Type="Android.Net.Uri" />
<Parameter Name="mimeType" Type="System.String" />
</Parameters>
<Docs>
<param name="context">the Context to use when resolving the Uri</param>
<param name="uri">the Content URI of the data you want to play</param>
<param name="mimeType">The mime type of the file. Must be one of the mime types listed above.</param>
<summary>Adds an external timed text source file (Uri).</summary>
<remarks>
<para>Adds an external timed text source file (Uri).
Currently supported format is SubRip with the file extension .srt, case insensitive.
Note that a single external timed text source may contain multiple tracks in it.
One can find the total number of available tracks using <c>#getTrackInfo()</c> to see what
additional tracks become available after this method call.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/MediaPlayer#addTimedTextSource(android.content.Context,%20android.net.Uri,%20java.lang.String)" title="Reference documentation">Java documentation for <code>android.media.MediaPlayer.addTimedTextSource(android.content.Context, android.net.Uri, java.lang.String)</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 16" />
<exception cref="T:Java.IO.IOException">if the file cannot be accessed or is corrupted.</exception>
<exception cref="T:Java.Lang.IllegalArgumentException">if the mimeType is not supported.</exception>
<exception cref="T:Java.Lang.IllegalStateException">if called in an invalid state.
</exception>
</Docs>
</Member>
<Member MemberName="AddTimedTextSource">
<MemberSignature Language="C#" Value="public virtual void AddTimedTextSource (Java.IO.FileDescriptor? fd, long offset, long length, string? mime);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AddTimedTextSource(class Java.IO.FileDescriptor fd, int64 offset, int64 length, string mime) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.MediaPlayer.AddTimedTextSource(Java.IO.FileDescriptor,System.Int64,System.Int64,System.String)" />
<MemberSignature Language="F#" Value="abstract member AddTimedTextSource : Java.IO.FileDescriptor * int64 * int64 * string -> unit
override this.AddTimedTextSource : Java.IO.FileDescriptor * int64 * int64 * string -> unit" Usage="mediaPlayer.AddTimedTextSource (fd, offset, length, mime)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("addTimedTextSource", "(Ljava/io/FileDescriptor;JJLjava/lang/String;)V", "GetAddTimedTextSource_Ljava_io_FileDescriptor_JJLjava_lang_String_Handler")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("addTimedTextSource", "(Ljava/io/FileDescriptor;JJLjava/lang/String;)V", "GetAddTimedTextSource_Ljava_io_FileDescriptor_JJLjava_lang_String_Handler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fd" Type="Java.IO.FileDescriptor" />
<Parameter Name="offset" Type="System.Int64" />
<Parameter Name="length" Type="System.Int64" />
<Parameter Name="mime" Type="System.String" />
</Parameters>
<Docs>
<param name="fd">the FileDescriptor for the file you want to play</param>
<param name="offset">the offset into the file where the data to be played starts, in bytes</param>
<param name="length">the length in bytes of the data to be played</param>
<param name="mime">The mime type of the file. Must be one of the mime types listed above.</param>
<summary>Adds an external timed text file (FileDescriptor).</summary>
<remarks>
<para>Adds an external timed text file (FileDescriptor).
It is the caller's responsibility to close the file descriptor.
It is safe to do so as soon as this call returns.
Currently supported format is SubRip. Note that a single external timed text source may
contain multiple tracks in it. One can find the total number of available tracks
using <c>#getTrackInfo()</c> to see what additional tracks become available
after this method call.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/MediaPlayer#addTimedTextSource(java.io.FileDescriptor,%20long,%20long,%20java.lang.String)" title="Reference documentation">Java documentation for <code>android.media.MediaPlayer.addTimedTextSource(java.io.FileDescriptor, long, long, java.lang.String)</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 16" />
<exception cref="T:Java.Lang.IllegalArgumentException">if the mimeType is not supported.</exception>
<exception cref="T:Java.Lang.IllegalStateException">if called in an invalid state.
</exception>
</Docs>
</Member>
<Member MemberName="AttachAuxEffect">
<MemberSignature Language="C#" Value="public virtual void AttachAuxEffect (int effectId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AttachAuxEffect(int32 effectId) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Media.MediaPlayer.AttachAuxEffect(System.Int32)" />
<MemberSignature Language="F#" Value="abstract member AttachAuxEffect : int -> unit
override this.AttachAuxEffect : int -> unit" Usage="mediaPlayer.AttachAuxEffect effectId" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("attachAuxEffect", "(I)V", "GetAttachAuxEffect_IHandler")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("attachAuxEffect", "(I)V", "GetAttachAuxEffect_IHandler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="effectId" Type="System.Int32" />
</Parameters>
<Docs>
<param name="effectId">system wide unique id of the effect to attach</param>
<summary>Attaches an auxiliary effect to the player.</summary>
<remarks>
<para>Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation
effect which can be applied on any sound source that directs a certain amount of its
energy to this effect. This amount is defined by setAuxEffectSendLevel().
See <c>#setAuxEffectSendLevel(float)</c>.</para>
<para>After creating an auxiliary effect (e.g.
<c>android.media.audiofx.EnvironmentalReverb</c>), retrieve its ID with
<c>android.media.audiofx.AudioEffect#getId()</c> and use it when calling this method
to attach the player to the effect.</para>
<para>To detach the effect from the player, call this method with a null effect id.</para>
<para>This method must be called after one of the overloaded <c> setDataSource </c>
methods.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/MediaPlayer#attachAuxEffect(int)" title="Reference documentation">Java documentation for <code>android.media.MediaPlayer.attachAuxEffect(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" />
</Docs>
</Member>
<Member MemberName="AudioSessionId">
<MemberSignature Language="C#" Value="public virtual int AudioSessionId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 AudioSessionId" />
<MemberSignature Language="DocId" Value="P:Android.Media.MediaPlayer.AudioSessionId" />
<MemberSignature Language="F#" Value="member this.AudioSessionId : int with get, set" Usage="Android.Media.MediaPlayer.AudioSessionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getAudioSessionId", "()I", "GetGetAudioSessionIdHandler")]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getAudioSessionId", "()I", "GetGetAudioSessionIdHandler")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[set: Android.Runtime.Register("setAudioSessionId", "(I)V", "GetSetAudioSessionId_IHandler")]</AttributeName>
<AttributeName Language="F#">[<set: Android.Runtime.Register("setAudioSessionId", "(I)V", "GetSetAudioSessionId_IHandler")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<param name="sessionId">the audio session ID.
The audio session ID is a system wide unique identifier for the audio stream played by
this MediaPlayer instance.
The primary use of the audio session ID is to associate audio effects to a particular
instance of MediaPlayer: if an audio session ID is provided when creating an audio effect,
this effect will be applied only to the audio content of media players within the same
audio session and not to the output mix.
When created, a MediaPlayer instance automatically generates its own audio session ID.
However, it is possible to force this player to be part of an already existing audio session
by calling this method.
This method must be called before one of the overloaded <c> setDataSource </c> methods.
Note that session id set using this method will override device-specific audio session id,
if the <c>MediaPlayer</c> was instantiated using device-specific <c>Context</c> -
see <c>MediaPlayer#MediaPlayer(Context)</c>.</param>
<summary>Returns the audio session ID. -or- Sets the audio session ID.</summary>
<value>the audio session ID. <c>#setAudioSessionId(int)</c>
Note that the audio session ID is 0 only if a problem occured when the MediaPlayer was contructed.</value>
<remarks>
<para>Property getter documentation:</para>
<para>Returns the audio session ID.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/MediaPlayer#getAudioSessionId()" title="Reference documentation">Java documentation for <code>android.media.MediaPlayer.getAudioSessionId()</code>.</a>
</format>
</para>
<para>Property setter documentation:</para>
<para>Sets the audio session ID.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/media/MediaPlayer#setAudioSessionId(int)" title="Reference documentation">Java documentation for <code>android.media.MediaPlayer.setAudioSessionId(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>