MediaPlayer.java revision 5c2faf3dc310b100707eb9e32e1e5ae8ceffd0c6
1/* 2 * Copyright (C) 2006 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.media; 18 19import android.content.ContentResolver; 20import android.content.Context; 21import android.content.res.AssetFileDescriptor; 22import android.net.Uri; 23import android.os.Handler; 24import android.os.Looper; 25import android.os.Message; 26import android.os.Parcel; 27import android.os.ParcelFileDescriptor; 28import android.os.PowerManager; 29import android.util.Log; 30import android.view.Surface; 31import android.view.SurfaceHolder; 32import android.graphics.Bitmap; 33import android.graphics.ParcelSurfaceTexture; 34import android.graphics.SurfaceTexture; 35import android.media.AudioManager; 36 37import java.io.FileDescriptor; 38import java.io.IOException; 39import java.util.Map; 40import java.util.Set; 41import java.lang.ref.WeakReference; 42 43/** 44 * MediaPlayer class can be used to control playback 45 * of audio/video files and streams. An example on how to use the methods in 46 * this class can be found in {@link android.widget.VideoView}. 47 * Please see <a href="{@docRoot}guide/topics/media/index.html">Audio and Video</a> 48 * for additional help using MediaPlayer. 49 * 50 * <p>Topics covered here are: 51 * <ol> 52 * <li><a href="#StateDiagram">State Diagram</a> 53 * <li><a href="#Valid_and_Invalid_States">Valid and Invalid States</a> 54 * <li><a href="#Permissions">Permissions</a> 55 * <li><a href="#Callbacks">Register informational and error callbacks</a> 56 * </ol> 57 * 58 * <a name="StateDiagram"></a> 59 * <h3>State Diagram</h3> 60 * 61 * <p>Playback control of audio/video files and streams is managed as a state 62 * machine. The following diagram shows the life cycle and the states of a 63 * MediaPlayer object driven by the supported playback control operations. 64 * The ovals represent the states a MediaPlayer object may reside 65 * in. The arcs represent the playback control operations that drive the object 66 * state transition. There are two types of arcs. The arcs with a single arrow 67 * head represent synchronous method calls, while those with 68 * a double arrow head represent asynchronous method calls.</p> 69 * 70 * <p><img src="../../../images/mediaplayer_state_diagram.gif" 71 * alt="MediaPlayer State diagram" 72 * border="0" /></p> 73 * 74 * <p>From this state diagram, one can see that a MediaPlayer object has the 75 * following states:</p> 76 * <ul> 77 * <li>When a MediaPlayer object is just created using <code>new</code> or 78 * after {@link #reset()} is called, it is in the <em>Idle</em> state; and after 79 * {@link #release()} is called, it is in the <em>End</em> state. Between these 80 * two states is the life cycle of the MediaPlayer object. 81 * <ul> 82 * <li>There is a subtle but important difference between a newly constructed 83 * MediaPlayer object and the MediaPlayer object after {@link #reset()} 84 * is called. It is a programming error to invoke methods such 85 * as {@link #getCurrentPosition()}, 86 * {@link #getDuration()}, {@link #getVideoHeight()}, 87 * {@link #getVideoWidth()}, {@link #setAudioStreamType(int)}, 88 * {@link #setLooping(boolean)}, 89 * {@link #setVolume(float, float)}, {@link #pause()}, {@link #start()}, 90 * {@link #stop()}, {@link #seekTo(int)}, {@link #prepare()} or 91 * {@link #prepareAsync()} in the <em>Idle</em> state for both cases. If any of these 92 * methods is called right after a MediaPlayer object is constructed, 93 * the user supplied callback method OnErrorListener.onError() won't be 94 * called by the internal player engine and the object state remains 95 * unchanged; but if these methods are called right after {@link #reset()}, 96 * the user supplied callback method OnErrorListener.onError() will be 97 * invoked by the internal player engine and the object will be 98 * transfered to the <em>Error</em> state. </li> 99 * <li>It is also recommended that once 100 * a MediaPlayer object is no longer being used, call {@link #release()} immediately 101 * so that resources used by the internal player engine associated with the 102 * MediaPlayer object can be released immediately. Resource may include 103 * singleton resources such as hardware acceleration components and 104 * failure to call {@link #release()} may cause subsequent instances of 105 * MediaPlayer objects to fallback to software implementations or fail 106 * altogether. Once the MediaPlayer 107 * object is in the <em>End</em> state, it can no longer be used and 108 * there is no way to bring it back to any other state. </li> 109 * <li>Furthermore, 110 * the MediaPlayer objects created using <code>new</code> is in the 111 * <em>Idle</em> state, while those created with one 112 * of the overloaded convenient <code>create</code> methods are <em>NOT</em> 113 * in the <em>Idle</em> state. In fact, the objects are in the <em>Prepared</em> 114 * state if the creation using <code>create</code> method is successful. 115 * </li> 116 * </ul> 117 * </li> 118 * <li>In general, some playback control operation may fail due to various 119 * reasons, such as unsupported audio/video format, poorly interleaved 120 * audio/video, resolution too high, streaming timeout, and the like. 121 * Thus, error reporting and recovery is an important concern under 122 * these circumstances. Sometimes, due to programming errors, invoking a playback 123 * control operation in an invalid state may also occur. Under all these 124 * error conditions, the internal player engine invokes a user supplied 125 * OnErrorListener.onError() method if an OnErrorListener has been 126 * registered beforehand via 127 * {@link #setOnErrorListener(android.media.MediaPlayer.OnErrorListener)}. 128 * <ul> 129 * <li>It is important to note that once an error occurs, the 130 * MediaPlayer object enters the <em>Error</em> state (except as noted 131 * above), even if an error listener has not been registered by the application.</li> 132 * <li>In order to reuse a MediaPlayer object that is in the <em> 133 * Error</em> state and recover from the error, 134 * {@link #reset()} can be called to restore the object to its <em>Idle</em> 135 * state.</li> 136 * <li>It is good programming practice to have your application 137 * register a OnErrorListener to look out for error notifications from 138 * the internal player engine.</li> 139 * <li>IllegalStateException is 140 * thrown to prevent programming errors such as calling {@link #prepare()}, 141 * {@link #prepareAsync()}, or one of the overloaded <code>setDataSource 142 * </code> methods in an invalid state. </li> 143 * </ul> 144 * </li> 145 * <li>Calling 146 * {@link #setDataSource(FileDescriptor)}, or 147 * {@link #setDataSource(String)}, or 148 * {@link #setDataSource(Context, Uri)}, or 149 * {@link #setDataSource(FileDescriptor, long, long)} transfers a 150 * MediaPlayer object in the <em>Idle</em> state to the 151 * <em>Initialized</em> state. 152 * <ul> 153 * <li>An IllegalStateException is thrown if 154 * setDataSource() is called in any other state.</li> 155 * <li>It is good programming 156 * practice to always look out for <code>IllegalArgumentException</code> 157 * and <code>IOException</code> that may be thrown from the overloaded 158 * <code>setDataSource</code> methods.</li> 159 * </ul> 160 * </li> 161 * <li>A MediaPlayer object must first enter the <em>Prepared</em> state 162 * before playback can be started. 163 * <ul> 164 * <li>There are two ways (synchronous vs. 165 * asynchronous) that the <em>Prepared</em> state can be reached: 166 * either a call to {@link #prepare()} (synchronous) which 167 * transfers the object to the <em>Prepared</em> state once the method call 168 * returns, or a call to {@link #prepareAsync()} (asynchronous) which 169 * first transfers the object to the <em>Preparing</em> state after the 170 * call returns (which occurs almost right way) while the internal 171 * player engine continues working on the rest of preparation work 172 * until the preparation work completes. When the preparation completes or when {@link #prepare()} call returns, 173 * the internal player engine then calls a user supplied callback method, 174 * onPrepared() of the OnPreparedListener interface, if an 175 * OnPreparedListener is registered beforehand via {@link 176 * #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener)}.</li> 177 * <li>It is important to note that 178 * the <em>Preparing</em> state is a transient state, and the behavior 179 * of calling any method with side effect while a MediaPlayer object is 180 * in the <em>Preparing</em> state is undefined.</li> 181 * <li>An IllegalStateException is 182 * thrown if {@link #prepare()} or {@link #prepareAsync()} is called in 183 * any other state.</li> 184 * <li>While in the <em>Prepared</em> state, properties 185 * such as audio/sound volume, screenOnWhilePlaying, looping can be 186 * adjusted by invoking the corresponding set methods.</li> 187 * </ul> 188 * </li> 189 * <li>To start the playback, {@link #start()} must be called. After 190 * {@link #start()} returns successfully, the MediaPlayer object is in the 191 * <em>Started</em> state. {@link #isPlaying()} can be called to test 192 * whether the MediaPlayer object is in the <em>Started</em> state. 193 * <ul> 194 * <li>While in the <em>Started</em> state, the internal player engine calls 195 * a user supplied OnBufferingUpdateListener.onBufferingUpdate() callback 196 * method if a OnBufferingUpdateListener has been registered beforehand 197 * via {@link #setOnBufferingUpdateListener(OnBufferingUpdateListener)}. 198 * This callback allows applications to keep track of the buffering status 199 * while streaming audio/video.</li> 200 * <li>Calling {@link #start()} has not effect 201 * on a MediaPlayer object that is already in the <em>Started</em> state.</li> 202 * </ul> 203 * </li> 204 * <li>Playback can be paused and stopped, and the current playback position 205 * can be adjusted. Playback can be paused via {@link #pause()}. When the call to 206 * {@link #pause()} returns, the MediaPlayer object enters the 207 * <em>Paused</em> state. Note that the transition from the <em>Started</em> 208 * state to the <em>Paused</em> state and vice versa happens 209 * asynchronously in the player engine. It may take some time before 210 * the state is updated in calls to {@link #isPlaying()}, and it can be 211 * a number of seconds in the case of streamed content. 212 * <ul> 213 * <li>Calling {@link #start()} to resume playback for a paused 214 * MediaPlayer object, and the resumed playback 215 * position is the same as where it was paused. When the call to 216 * {@link #start()} returns, the paused MediaPlayer object goes back to 217 * the <em>Started</em> state.</li> 218 * <li>Calling {@link #pause()} has no effect on 219 * a MediaPlayer object that is already in the <em>Paused</em> state.</li> 220 * </ul> 221 * </li> 222 * <li>Calling {@link #stop()} stops playback and causes a 223 * MediaPlayer in the <em>Started</em>, <em>Paused</em>, <em>Prepared 224 * </em> or <em>PlaybackCompleted</em> state to enter the 225 * <em>Stopped</em> state. 226 * <ul> 227 * <li>Once in the <em>Stopped</em> state, playback cannot be started 228 * until {@link #prepare()} or {@link #prepareAsync()} are called to set 229 * the MediaPlayer object to the <em>Prepared</em> state again.</li> 230 * <li>Calling {@link #stop()} has no effect on a MediaPlayer 231 * object that is already in the <em>Stopped</em> state.</li> 232 * </ul> 233 * </li> 234 * <li>The playback position can be adjusted with a call to 235 * {@link #seekTo(int)}. 236 * <ul> 237 * <li>Although the asynchronuous {@link #seekTo(int)} 238 * call returns right way, the actual seek operation may take a while to 239 * finish, especially for audio/video being streamed. When the actual 240 * seek operation completes, the internal player engine calls a user 241 * supplied OnSeekComplete.onSeekComplete() if an OnSeekCompleteListener 242 * has been registered beforehand via 243 * {@link #setOnSeekCompleteListener(OnSeekCompleteListener)}.</li> 244 * <li>Please 245 * note that {@link #seekTo(int)} can also be called in the other states, 246 * such as <em>Prepared</em>, <em>Paused</em> and <em>PlaybackCompleted 247 * </em> state.</li> 248 * <li>Furthermore, the actual current playback position 249 * can be retrieved with a call to {@link #getCurrentPosition()}, which 250 * is helpful for applications such as a Music player that need to keep 251 * track of the playback progress.</li> 252 * </ul> 253 * </li> 254 * <li>When the playback reaches the end of stream, the playback completes. 255 * <ul> 256 * <li>If the looping mode was being set to <var>true</var>with 257 * {@link #setLooping(boolean)}, the MediaPlayer object shall remain in 258 * the <em>Started</em> state.</li> 259 * <li>If the looping mode was set to <var>false 260 * </var>, the player engine calls a user supplied callback method, 261 * OnCompletion.onCompletion(), if a OnCompletionListener is registered 262 * beforehand via {@link #setOnCompletionListener(OnCompletionListener)}. 263 * The invoke of the callback signals that the object is now in the <em> 264 * PlaybackCompleted</em> state.</li> 265 * <li>While in the <em>PlaybackCompleted</em> 266 * state, calling {@link #start()} can restart the playback from the 267 * beginning of the audio/video source.</li> 268 * </ul> 269 * 270 * 271 * <a name="Valid_and_Invalid_States"></a> 272 * <h3>Valid and invalid states</h3> 273 * 274 * <table border="0" cellspacing="0" cellpadding="0"> 275 * <tr><td>Method Name </p></td> 276 * <td>Valid Sates </p></td> 277 * <td>Invalid States </p></td> 278 * <td>Comments </p></td></tr> 279 * <tr><td>attachAuxEffect </p></td> 280 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td> 281 * <td>{Idle, Error} </p></td> 282 * <td>This method must be called after setDataSource. 283 * Calling it does not change the object state. </p></td></tr> 284 * <tr><td>getAudioSessionId </p></td> 285 * <td>any </p></td> 286 * <td>{} </p></td> 287 * <td>This method can be called in any state and calling it does not change 288 * the object state. </p></td></tr> 289 * <tr><td>getCurrentPosition </p></td> 290 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 291 * PlaybackCompleted} </p></td> 292 * <td>{Error}</p></td> 293 * <td>Successful invoke of this method in a valid state does not change the 294 * state. Calling this method in an invalid state transfers the object 295 * to the <em>Error</em> state. </p></td></tr> 296 * <tr><td>getDuration </p></td> 297 * <td>{Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td> 298 * <td>{Idle, Initialized, Error} </p></td> 299 * <td>Successful invoke of this method in a valid state does not change the 300 * state. Calling this method in an invalid state transfers the object 301 * to the <em>Error</em> state. </p></td></tr> 302 * <tr><td>getVideoHeight </p></td> 303 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 304 * PlaybackCompleted}</p></td> 305 * <td>{Error}</p></td> 306 * <td>Successful invoke of this method in a valid state does not change the 307 * state. Calling this method in an invalid state transfers the object 308 * to the <em>Error</em> state. </p></td></tr> 309 * <tr><td>getVideoWidth </p></td> 310 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 311 * PlaybackCompleted}</p></td> 312 * <td>{Error}</p></td> 313 * <td>Successful invoke of this method in a valid state does not change 314 * the state. Calling this method in an invalid state transfers the 315 * object to the <em>Error</em> state. </p></td></tr> 316 * <tr><td>isPlaying </p></td> 317 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 318 * PlaybackCompleted}</p></td> 319 * <td>{Error}</p></td> 320 * <td>Successful invoke of this method in a valid state does not change 321 * the state. Calling this method in an invalid state transfers the 322 * object to the <em>Error</em> state. </p></td></tr> 323 * <tr><td>pause </p></td> 324 * <td>{Started, Paused}</p></td> 325 * <td>{Idle, Initialized, Prepared, Stopped, PlaybackCompleted, Error}</p></td> 326 * <td>Successful invoke of this method in a valid state transfers the 327 * object to the <em>Paused</em> state. Calling this method in an 328 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 329 * <tr><td>prepare </p></td> 330 * <td>{Initialized, Stopped} </p></td> 331 * <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td> 332 * <td>Successful invoke of this method in a valid state transfers the 333 * object to the <em>Prepared</em> state. Calling this method in an 334 * invalid state throws an IllegalStateException.</p></td></tr> 335 * <tr><td>prepareAsync </p></td> 336 * <td>{Initialized, Stopped} </p></td> 337 * <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td> 338 * <td>Successful invoke of this method in a valid state transfers the 339 * object to the <em>Preparing</em> state. Calling this method in an 340 * invalid state throws an IllegalStateException.</p></td></tr> 341 * <tr><td>release </p></td> 342 * <td>any </p></td> 343 * <td>{} </p></td> 344 * <td>After {@link #release()}, the object is no longer available. </p></td></tr> 345 * <tr><td>reset </p></td> 346 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 347 * PlaybackCompleted, Error}</p></td> 348 * <td>{}</p></td> 349 * <td>After {@link #reset()}, the object is like being just created.</p></td></tr> 350 * <tr><td>seekTo </p></td> 351 * <td>{Prepared, Started, Paused, PlaybackCompleted} </p></td> 352 * <td>{Idle, Initialized, Stopped, Error}</p></td> 353 * <td>Successful invoke of this method in a valid state does not change 354 * the state. Calling this method in an invalid state transfers the 355 * object to the <em>Error</em> state. </p></td></tr> 356 * <tr><td>setAudioSessionId </p></td> 357 * <td>{Idle} </p></td> 358 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, 359 * Error} </p></td> 360 * <td>This method must be called in idle state as the audio session ID must be known before 361 * calling setDataSource. Calling it does not change the object state. </p></td></tr> 362 * <tr><td>setAudioStreamType </p></td> 363 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 364 * PlaybackCompleted}</p></td> 365 * <td>{Error}</p></td> 366 * <td>Successful invoke of this method does not change the state. In order for the 367 * target audio stream type to become effective, this method must be called before 368 * prepare() or prepareAsync().</p></td></tr> 369 * <tr><td>setAuxEffectSendLevel </p></td> 370 * <td>any</p></td> 371 * <td>{} </p></td> 372 * <td>Calling this method does not change the object state. </p></td></tr> 373 * <tr><td>setDataSource </p></td> 374 * <td>{Idle} </p></td> 375 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, 376 * Error} </p></td> 377 * <td>Successful invoke of this method in a valid state transfers the 378 * object to the <em>Initialized</em> state. Calling this method in an 379 * invalid state throws an IllegalStateException.</p></td></tr> 380 * <tr><td>setDisplay </p></td> 381 * <td>any </p></td> 382 * <td>{} </p></td> 383 * <td>This method can be called in any state and calling it does not change 384 * the object state. </p></td></tr> 385 * <tr><td>setTexture </p></td> 386 * <td>any </p></td> 387 * <td>{} </p></td> 388 * <td>This method can be called in any state and calling it does not change 389 * the object state. </p></td></tr> 390 * <tr><td>setLooping </p></td> 391 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 392 * PlaybackCompleted}</p></td> 393 * <td>{Error}</p></td> 394 * <td>Successful invoke of this method in a valid state does not change 395 * the state. Calling this method in an 396 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 397 * <tr><td>isLooping </p></td> 398 * <td>any </p></td> 399 * <td>{} </p></td> 400 * <td>This method can be called in any state and calling it does not change 401 * the object state. </p></td></tr> 402 * <tr><td>setOnBufferingUpdateListener </p></td> 403 * <td>any </p></td> 404 * <td>{} </p></td> 405 * <td>This method can be called in any state and calling it does not change 406 * the object state. </p></td></tr> 407 * <tr><td>setOnCompletionListener </p></td> 408 * <td>any </p></td> 409 * <td>{} </p></td> 410 * <td>This method can be called in any state and calling it does not change 411 * the object state. </p></td></tr> 412 * <tr><td>setOnErrorListener </p></td> 413 * <td>any </p></td> 414 * <td>{} </p></td> 415 * <td>This method can be called in any state and calling it does not change 416 * the object state. </p></td></tr> 417 * <tr><td>setOnPreparedListener </p></td> 418 * <td>any </p></td> 419 * <td>{} </p></td> 420 * <td>This method can be called in any state and calling it does not change 421 * the object state. </p></td></tr> 422 * <tr><td>setOnSeekCompleteListener </p></td> 423 * <td>any </p></td> 424 * <td>{} </p></td> 425 * <td>This method can be called in any state and calling it does not change 426 * the object state. </p></td></tr> 427 * <tr><td>setScreenOnWhilePlaying</></td> 428 * <td>any </p></td> 429 * <td>{} </p></td> 430 * <td>This method can be called in any state and calling it does not change 431 * the object state. </p></td></tr> 432 * <tr><td>setVolume </p></td> 433 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 434 * PlaybackCompleted}</p></td> 435 * <td>{Error}</p></td> 436 * <td>Successful invoke of this method does not change the state. 437 * <tr><td>setWakeMode </p></td> 438 * <td>any </p></td> 439 * <td>{} </p></td> 440 * <td>This method can be called in any state and calling it does not change 441 * the object state.</p></td></tr> 442 * <tr><td>start </p></td> 443 * <td>{Prepared, Started, Paused, PlaybackCompleted}</p></td> 444 * <td>{Idle, Initialized, Stopped, Error}</p></td> 445 * <td>Successful invoke of this method in a valid state transfers the 446 * object to the <em>Started</em> state. Calling this method in an 447 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 448 * <tr><td>stop </p></td> 449 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 450 * <td>{Idle, Initialized, Error}</p></td> 451 * <td>Successful invoke of this method in a valid state transfers the 452 * object to the <em>Stopped</em> state. Calling this method in an 453 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 454 * 455 * </table> 456 * 457 * <a name="Permissions"></a> 458 * <h3>Permissions</h3> 459 * <p>One may need to declare a corresponding WAKE_LOCK permission {@link 460 * android.R.styleable#AndroidManifestUsesPermission <uses-permission>} 461 * element. 462 * 463 * <a name="Callbacks"></a> 464 * <h3>Callbacks</h3> 465 * <p>Applications may want to register for informational and error 466 * events in order to be informed of some internal state update and 467 * possible runtime errors during playback or streaming. Registration for 468 * these events is done by properly setting the appropriate listeners (via calls 469 * to 470 * {@link #setOnPreparedListener(OnPreparedListener)}setOnPreparedListener, 471 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)}setOnVideoSizeChangedListener, 472 * {@link #setOnSeekCompleteListener(OnSeekCompleteListener)}setOnSeekCompleteListener, 473 * {@link #setOnCompletionListener(OnCompletionListener)}setOnCompletionListener, 474 * {@link #setOnBufferingUpdateListener(OnBufferingUpdateListener)}setOnBufferingUpdateListener, 475 * {@link #setOnInfoListener(OnInfoListener)}setOnInfoListener, 476 * {@link #setOnErrorListener(OnErrorListener)}setOnErrorListener, etc). 477 * In order to receive the respective callback 478 * associated with these listeners, applications are required to create 479 * MediaPlayer objects on a thread with its own Looper running (main UI 480 * thread by default has a Looper running). 481 * 482 */ 483public class MediaPlayer 484{ 485 /** 486 Constant to retrieve only the new metadata since the last 487 call. 488 // FIXME: unhide. 489 // FIXME: add link to getMetadata(boolean, boolean) 490 {@hide} 491 */ 492 public static final boolean METADATA_UPDATE_ONLY = true; 493 494 /** 495 Constant to retrieve all the metadata. 496 // FIXME: unhide. 497 // FIXME: add link to getMetadata(boolean, boolean) 498 {@hide} 499 */ 500 public static final boolean METADATA_ALL = false; 501 502 /** 503 Constant to enable the metadata filter during retrieval. 504 // FIXME: unhide. 505 // FIXME: add link to getMetadata(boolean, boolean) 506 {@hide} 507 */ 508 public static final boolean APPLY_METADATA_FILTER = true; 509 510 /** 511 Constant to disable the metadata filter during retrieval. 512 // FIXME: unhide. 513 // FIXME: add link to getMetadata(boolean, boolean) 514 {@hide} 515 */ 516 public static final boolean BYPASS_METADATA_FILTER = false; 517 518 static { 519 System.loadLibrary("media_jni"); 520 native_init(); 521 } 522 523 private final static String TAG = "MediaPlayer"; 524 // Name of the remote interface for the media player. Must be kept 525 // in sync with the 2nd parameter of the IMPLEMENT_META_INTERFACE 526 // macro invocation in IMediaPlayer.cpp 527 private final static String IMEDIA_PLAYER = "android.media.IMediaPlayer"; 528 529 private int mNativeContext; // accessed by native methods 530 private int mListenerContext; // accessed by native methods 531 private Surface mSurface; // accessed by native methods 532 private SurfaceHolder mSurfaceHolder; 533 private ParcelSurfaceTexture mParcelSurfaceTexture; // accessed by native methods 534 private EventHandler mEventHandler; 535 private PowerManager.WakeLock mWakeLock = null; 536 private boolean mScreenOnWhilePlaying; 537 private boolean mStayAwake; 538 539 /** 540 * Default constructor. Consider using one of the create() methods for 541 * synchronously instantiating a MediaPlayer from a Uri or resource. 542 * <p>When done with the MediaPlayer, you should call {@link #release()}, 543 * to free the resources. If not released, too many MediaPlayer instances may 544 * result in an exception.</p> 545 */ 546 public MediaPlayer() { 547 548 Looper looper; 549 if ((looper = Looper.myLooper()) != null) { 550 mEventHandler = new EventHandler(this, looper); 551 } else if ((looper = Looper.getMainLooper()) != null) { 552 mEventHandler = new EventHandler(this, looper); 553 } else { 554 mEventHandler = null; 555 } 556 557 /* Native setup requires a weak reference to our object. 558 * It's easier to create it here than in C++. 559 */ 560 native_setup(new WeakReference<MediaPlayer>(this)); 561 } 562 563 /* 564 * Update the MediaPlayer ISurface and ISurfaceTexture. 565 * Call after updating mSurface and/or mParcelSurfaceTexture. 566 */ 567 private native void _setVideoSurfaceOrSurfaceTexture(); 568 569 /** 570 * Create a request parcel which can be routed to the native media 571 * player using {@link #invoke(Parcel, Parcel)}. The Parcel 572 * returned has the proper InterfaceToken set. The caller should 573 * not overwrite that token, i.e it can only append data to the 574 * Parcel. 575 * 576 * @return A parcel suitable to hold a request for the native 577 * player. 578 * {@hide} 579 */ 580 public Parcel newRequest() { 581 Parcel parcel = Parcel.obtain(); 582 parcel.writeInterfaceToken(IMEDIA_PLAYER); 583 return parcel; 584 } 585 586 /** 587 * Invoke a generic method on the native player using opaque 588 * parcels for the request and reply. Both payloads' format is a 589 * convention between the java caller and the native player. 590 * Must be called after setDataSource to make sure a native player 591 * exists. 592 * 593 * @param request Parcel with the data for the extension. The 594 * caller must use {@link #newRequest()} to get one. 595 * 596 * @param reply Output parcel with the data returned by the 597 * native player. 598 * 599 * @return The status code see utils/Errors.h 600 * {@hide} 601 */ 602 public int invoke(Parcel request, Parcel reply) { 603 int retcode = native_invoke(request, reply); 604 reply.setDataPosition(0); 605 return retcode; 606 } 607 608 /** 609 * Sets the {@link SurfaceHolder} to use for displaying the video 610 * portion of the media. A surface must be set if a display is 611 * needed. Not calling this method when playing back a video will 612 * result in only the audio track being played. 613 * 614 * Either a surface or surface texture must be set if a display or video sink 615 * is needed. Not calling this method or {@link #setTexture(SurfaceTexture)} 616 * when playing back a video will result in only the audio track being played. 617 * 618 * @param sh the SurfaceHolder to use for video display 619 */ 620 public void setDisplay(SurfaceHolder sh) { 621 mSurfaceHolder = sh; 622 if (sh != null) { 623 mSurface = sh.getSurface(); 624 } else { 625 mSurface = null; 626 } 627 mParcelSurfaceTexture = null; 628 _setVideoSurfaceOrSurfaceTexture(); 629 updateSurfaceScreenOn(); 630 } 631 632 /** 633 * Sets the {@link SurfaceTexture} to be used as the sink for the 634 * video portion of the media. Either a surface or surface texture 635 * must be set if a video sink is needed. The same surface texture 636 * can be re-set without harm. Setting a surface texture will un-set 637 * any surface that was set via {@link #setDisplay(SurfaceHolder)}. 638 * Not calling this method or {@link #setDisplay(SurfaceHolder)} 639 * when playing back a video will result in only the audio track 640 * being played. Note that if a SurfaceTexture is used, the value 641 * set via setScreenOnWhilePlaying has no effect. 642 * 643 * The timestamps provided by {@link SurfaceTexture#getTimestamp()} for a 644 * SurfaceTexture set as the video sink have an unspecified zero point, 645 * and cannot be directly compared between different media sources or different 646 * instances of the same media source, or across multiple runs of the same 647 * program. The timestamp is normally monotonically increasing and unaffected 648 * by time-of-day adjustments, but is reset when the position is set. 649 */ 650 public void setTexture(SurfaceTexture st) { 651 ParcelSurfaceTexture pst = null; 652 if (st != null) { 653 pst = ParcelSurfaceTexture.fromSurfaceTexture(st); 654 } 655 setParcelSurfaceTexture(pst); 656 } 657 658 /** 659 * Sets the {@link ParcelSurfaceTexture} to be used as the sink for the video portion of 660 * the media. This is similar to {@link #setTexture(SurfaceTexture)}, but supports using 661 * a {@link ParcelSurfaceTexture} to transport the texture to be used via Binder. Setting 662 * a parceled surface texture will un-set any surface or surface texture that was previously 663 * set. See {@link #setTexture(SurfaceTexture)} for more details. 664 * 665 * @param pst The {@link ParcelSurfaceTexture} to be used as the sink for 666 * the video portion of the media. 667 * 668 * @hide Pending review by API council. 669 */ 670 public void setParcelSurfaceTexture(ParcelSurfaceTexture pst) { 671 if (mScreenOnWhilePlaying && pst != null && mParcelSurfaceTexture == null) { 672 Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective for SurfaceTexture"); 673 } 674 mSurfaceHolder = null; 675 mSurface = null; 676 mParcelSurfaceTexture = pst; 677 _setVideoSurfaceOrSurfaceTexture(); 678 updateSurfaceScreenOn(); 679 } 680 681 /** 682 * Convenience method to create a MediaPlayer for a given Uri. 683 * On success, {@link #prepare()} will already have been called and must not be called again. 684 * <p>When done with the MediaPlayer, you should call {@link #release()}, 685 * to free the resources. If not released, too many MediaPlayer instances will 686 * result in an exception.</p> 687 * 688 * @param context the Context to use 689 * @param uri the Uri from which to get the datasource 690 * @return a MediaPlayer object, or null if creation failed 691 */ 692 public static MediaPlayer create(Context context, Uri uri) { 693 return create (context, uri, null); 694 } 695 696 /** 697 * Convenience method to create a MediaPlayer for a given Uri. 698 * On success, {@link #prepare()} will already have been called and must not be called again. 699 * <p>When done with the MediaPlayer, you should call {@link #release()}, 700 * to free the resources. If not released, too many MediaPlayer instances will 701 * result in an exception.</p> 702 * 703 * @param context the Context to use 704 * @param uri the Uri from which to get the datasource 705 * @param holder the SurfaceHolder to use for displaying the video 706 * @return a MediaPlayer object, or null if creation failed 707 */ 708 public static MediaPlayer create(Context context, Uri uri, SurfaceHolder holder) { 709 710 try { 711 MediaPlayer mp = new MediaPlayer(); 712 mp.setDataSource(context, uri); 713 if (holder != null) { 714 mp.setDisplay(holder); 715 } 716 mp.prepare(); 717 return mp; 718 } catch (IOException ex) { 719 Log.d(TAG, "create failed:", ex); 720 // fall through 721 } catch (IllegalArgumentException ex) { 722 Log.d(TAG, "create failed:", ex); 723 // fall through 724 } catch (SecurityException ex) { 725 Log.d(TAG, "create failed:", ex); 726 // fall through 727 } 728 729 return null; 730 } 731 732 // Note no convenience method to create a MediaPlayer with SurfaceTexture sink. 733 734 /** 735 * Convenience method to create a MediaPlayer for a given resource id. 736 * On success, {@link #prepare()} will already have been called and must not be called again. 737 * <p>When done with the MediaPlayer, you should call {@link #release()}, 738 * to free the resources. If not released, too many MediaPlayer instances will 739 * result in an exception.</p> 740 * 741 * @param context the Context to use 742 * @param resid the raw resource id (<var>R.raw.<something></var>) for 743 * the resource to use as the datasource 744 * @return a MediaPlayer object, or null if creation failed 745 */ 746 public static MediaPlayer create(Context context, int resid) { 747 try { 748 AssetFileDescriptor afd = context.getResources().openRawResourceFd(resid); 749 if (afd == null) return null; 750 751 MediaPlayer mp = new MediaPlayer(); 752 mp.setDataSource(afd.getFileDescriptor(), afd.getStartOffset(), afd.getLength()); 753 afd.close(); 754 mp.prepare(); 755 return mp; 756 } catch (IOException ex) { 757 Log.d(TAG, "create failed:", ex); 758 // fall through 759 } catch (IllegalArgumentException ex) { 760 Log.d(TAG, "create failed:", ex); 761 // fall through 762 } catch (SecurityException ex) { 763 Log.d(TAG, "create failed:", ex); 764 // fall through 765 } 766 return null; 767 } 768 769 /** 770 * Sets the data source as a content Uri. 771 * 772 * @param context the Context to use when resolving the Uri 773 * @param uri the Content URI of the data you want to play 774 * @throws IllegalStateException if it is called in an invalid state 775 */ 776 public void setDataSource(Context context, Uri uri) 777 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 778 setDataSource(context, uri, null); 779 } 780 781 /** 782 * Sets the data source as a content Uri. 783 * 784 * @param context the Context to use when resolving the Uri 785 * @param uri the Content URI of the data you want to play 786 * @param headers the headers to be sent together with the request for the data 787 * @throws IllegalStateException if it is called in an invalid state 788 */ 789 public void setDataSource(Context context, Uri uri, Map<String, String> headers) 790 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 791 792 String scheme = uri.getScheme(); 793 if(scheme == null || scheme.equals("file")) { 794 setDataSource(uri.getPath()); 795 return; 796 } 797 798 AssetFileDescriptor fd = null; 799 try { 800 ContentResolver resolver = context.getContentResolver(); 801 fd = resolver.openAssetFileDescriptor(uri, "r"); 802 if (fd == null) { 803 return; 804 } 805 // Note: using getDeclaredLength so that our behavior is the same 806 // as previous versions when the content provider is returning 807 // a full file. 808 if (fd.getDeclaredLength() < 0) { 809 setDataSource(fd.getFileDescriptor()); 810 } else { 811 setDataSource(fd.getFileDescriptor(), fd.getStartOffset(), fd.getDeclaredLength()); 812 } 813 return; 814 } catch (SecurityException ex) { 815 } catch (IOException ex) { 816 } finally { 817 if (fd != null) { 818 fd.close(); 819 } 820 } 821 Log.d(TAG, "Couldn't open file on client side, trying server side"); 822 setDataSource(uri.toString(), headers); 823 return; 824 } 825 826 /** 827 * Sets the data source (file-path or http/rtsp URL) to use. 828 * 829 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 830 * @throws IllegalStateException if it is called in an invalid state 831 */ 832 public native void setDataSource(String path) throws IOException, IllegalArgumentException, IllegalStateException; 833 834 /** 835 * Sets the data source (file-path or http/rtsp URL) to use. 836 * 837 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 838 * @param headers the headers associated with the http request for the stream you want to play 839 * @throws IllegalStateException if it is called in an invalid state 840 * @hide pending API council 841 */ 842 public void setDataSource(String path, Map<String, String> headers) 843 throws IOException, IllegalArgumentException, IllegalStateException 844 { 845 String[] keys = null; 846 String[] values = null; 847 848 if (headers != null) { 849 keys = new String[headers.size()]; 850 values = new String[headers.size()]; 851 852 int i = 0; 853 for (Map.Entry<String, String> entry: headers.entrySet()) { 854 keys[i] = entry.getKey(); 855 values[i] = entry.getValue(); 856 ++i; 857 } 858 } 859 _setDataSource(path, keys, values); 860 } 861 862 private native void _setDataSource( 863 String path, String[] keys, String[] values) 864 throws IOException, IllegalArgumentException, IllegalStateException; 865 866 /** 867 * Sets the data source (FileDescriptor) to use. It is the caller's responsibility 868 * to close the file descriptor. It is safe to do so as soon as this call returns. 869 * 870 * @param fd the FileDescriptor for the file you want to play 871 * @throws IllegalStateException if it is called in an invalid state 872 */ 873 public void setDataSource(FileDescriptor fd) 874 throws IOException, IllegalArgumentException, IllegalStateException { 875 // intentionally less than LONG_MAX 876 setDataSource(fd, 0, 0x7ffffffffffffffL); 877 } 878 879 /** 880 * Sets the data source (FileDescriptor) to use. The FileDescriptor must be 881 * seekable (N.B. a LocalSocket is not seekable). It is the caller's responsibility 882 * to close the file descriptor. It is safe to do so as soon as this call returns. 883 * 884 * @param fd the FileDescriptor for the file you want to play 885 * @param offset the offset into the file where the data to be played starts, in bytes 886 * @param length the length in bytes of the data to be played 887 * @throws IllegalStateException if it is called in an invalid state 888 */ 889 public native void setDataSource(FileDescriptor fd, long offset, long length) 890 throws IOException, IllegalArgumentException, IllegalStateException; 891 892 /** 893 * Prepares the player for playback, synchronously. 894 * 895 * After setting the datasource and the display surface, you need to either 896 * call prepare() or prepareAsync(). For files, it is OK to call prepare(), 897 * which blocks until MediaPlayer is ready for playback. 898 * 899 * @throws IllegalStateException if it is called in an invalid state 900 */ 901 public native void prepare() throws IOException, IllegalStateException; 902 903 /** 904 * Prepares the player for playback, asynchronously. 905 * 906 * After setting the datasource and the display surface, you need to either 907 * call prepare() or prepareAsync(). For streams, you should call prepareAsync(), 908 * which returns immediately, rather than blocking until enough data has been 909 * buffered. 910 * 911 * @throws IllegalStateException if it is called in an invalid state 912 */ 913 public native void prepareAsync() throws IllegalStateException; 914 915 /** 916 * Starts or resumes playback. If playback had previously been paused, 917 * playback will continue from where it was paused. If playback had 918 * been stopped, or never started before, playback will start at the 919 * beginning. 920 * 921 * @throws IllegalStateException if it is called in an invalid state 922 */ 923 public void start() throws IllegalStateException { 924 stayAwake(true); 925 _start(); 926 } 927 928 private native void _start() throws IllegalStateException; 929 930 /** 931 * Stops playback after playback has been stopped or paused. 932 * 933 * @throws IllegalStateException if the internal player engine has not been 934 * initialized. 935 */ 936 public void stop() throws IllegalStateException { 937 stayAwake(false); 938 _stop(); 939 } 940 941 private native void _stop() throws IllegalStateException; 942 943 /** 944 * Pauses playback. Call start() to resume. 945 * 946 * @throws IllegalStateException if the internal player engine has not been 947 * initialized. 948 */ 949 public void pause() throws IllegalStateException { 950 stayAwake(false); 951 _pause(); 952 } 953 954 private native void _pause() throws IllegalStateException; 955 956 /** 957 * Set the low-level power management behavior for this MediaPlayer. This 958 * can be used when the MediaPlayer is not playing through a SurfaceHolder 959 * set with {@link #setDisplay(SurfaceHolder)} and thus can use the 960 * high-level {@link #setScreenOnWhilePlaying(boolean)} feature. 961 * 962 * <p>This function has the MediaPlayer access the low-level power manager 963 * service to control the device's power usage while playing is occurring. 964 * The parameter is a combination of {@link android.os.PowerManager} wake flags. 965 * Use of this method requires {@link android.Manifest.permission#WAKE_LOCK} 966 * permission. 967 * By default, no attempt is made to keep the device awake during playback. 968 * 969 * @param context the Context to use 970 * @param mode the power/wake mode to set 971 * @see android.os.PowerManager 972 */ 973 public void setWakeMode(Context context, int mode) { 974 boolean washeld = false; 975 if (mWakeLock != null) { 976 if (mWakeLock.isHeld()) { 977 washeld = true; 978 mWakeLock.release(); 979 } 980 mWakeLock = null; 981 } 982 983 PowerManager pm = (PowerManager)context.getSystemService(Context.POWER_SERVICE); 984 mWakeLock = pm.newWakeLock(mode|PowerManager.ON_AFTER_RELEASE, MediaPlayer.class.getName()); 985 mWakeLock.setReferenceCounted(false); 986 if (washeld) { 987 mWakeLock.acquire(); 988 } 989 } 990 991 /** 992 * Control whether we should use the attached SurfaceHolder to keep the 993 * screen on while video playback is occurring. This is the preferred 994 * method over {@link #setWakeMode} where possible, since it doesn't 995 * require that the application have permission for low-level wake lock 996 * access. 997 * 998 * @param screenOn Supply true to keep the screen on, false to allow it 999 * to turn off. 1000 */ 1001 public void setScreenOnWhilePlaying(boolean screenOn) { 1002 if (mScreenOnWhilePlaying != screenOn) { 1003 if (screenOn && mParcelSurfaceTexture != null) { 1004 Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective for SurfaceTexture"); 1005 } 1006 mScreenOnWhilePlaying = screenOn; 1007 updateSurfaceScreenOn(); 1008 } 1009 } 1010 1011 private void stayAwake(boolean awake) { 1012 if (mWakeLock != null) { 1013 if (awake && !mWakeLock.isHeld()) { 1014 mWakeLock.acquire(); 1015 } else if (!awake && mWakeLock.isHeld()) { 1016 mWakeLock.release(); 1017 } 1018 } 1019 mStayAwake = awake; 1020 updateSurfaceScreenOn(); 1021 } 1022 1023 private void updateSurfaceScreenOn() { 1024 if (mSurfaceHolder != null) { 1025 mSurfaceHolder.setKeepScreenOn(mScreenOnWhilePlaying && mStayAwake); 1026 } 1027 } 1028 1029 /** 1030 * Returns the width of the video. 1031 * 1032 * @return the width of the video, or 0 if there is no video, 1033 * no display surface was set, or the width has not been determined 1034 * yet. The OnVideoSizeChangedListener can be registered via 1035 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)} 1036 * to provide a notification when the width is available. 1037 */ 1038 public native int getVideoWidth(); 1039 1040 /** 1041 * Returns the height of the video. 1042 * 1043 * @return the height of the video, or 0 if there is no video, 1044 * no display surface was set, or the height has not been determined 1045 * yet. The OnVideoSizeChangedListener can be registered via 1046 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)} 1047 * to provide a notification when the height is available. 1048 */ 1049 public native int getVideoHeight(); 1050 1051 /** 1052 * Checks whether the MediaPlayer is playing. 1053 * 1054 * @return true if currently playing, false otherwise 1055 */ 1056 public native boolean isPlaying(); 1057 1058 /** 1059 * Seeks to specified time position. 1060 * 1061 * @param msec the offset in milliseconds from the start to seek to 1062 * @throws IllegalStateException if the internal player engine has not been 1063 * initialized 1064 */ 1065 public native void seekTo(int msec) throws IllegalStateException; 1066 1067 /** 1068 * Gets the current playback position. 1069 * 1070 * @return the current position in milliseconds 1071 */ 1072 public native int getCurrentPosition(); 1073 1074 /** 1075 * Gets the duration of the file. 1076 * 1077 * @return the duration in milliseconds 1078 */ 1079 public native int getDuration(); 1080 1081 /** 1082 * Gets the media metadata. 1083 * 1084 * @param update_only controls whether the full set of available 1085 * metadata is returned or just the set that changed since the 1086 * last call. See {@see #METADATA_UPDATE_ONLY} and {@see 1087 * #METADATA_ALL}. 1088 * 1089 * @param apply_filter if true only metadata that matches the 1090 * filter is returned. See {@see #APPLY_METADATA_FILTER} and {@see 1091 * #BYPASS_METADATA_FILTER}. 1092 * 1093 * @return The metadata, possibly empty. null if an error occured. 1094 // FIXME: unhide. 1095 * {@hide} 1096 */ 1097 public Metadata getMetadata(final boolean update_only, 1098 final boolean apply_filter) { 1099 Parcel reply = Parcel.obtain(); 1100 Metadata data = new Metadata(); 1101 1102 if (!native_getMetadata(update_only, apply_filter, reply)) { 1103 reply.recycle(); 1104 return null; 1105 } 1106 1107 // Metadata takes over the parcel, don't recycle it unless 1108 // there is an error. 1109 if (!data.parse(reply)) { 1110 reply.recycle(); 1111 return null; 1112 } 1113 return data; 1114 } 1115 1116 /** 1117 * Set a filter for the metadata update notification and update 1118 * retrieval. The caller provides 2 set of metadata keys, allowed 1119 * and blocked. The blocked set always takes precedence over the 1120 * allowed one. 1121 * Metadata.MATCH_ALL and Metadata.MATCH_NONE are 2 sets available as 1122 * shorthands to allow/block all or no metadata. 1123 * 1124 * By default, there is no filter set. 1125 * 1126 * @param allow Is the set of metadata the client is interested 1127 * in receiving new notifications for. 1128 * @param block Is the set of metadata the client is not interested 1129 * in receiving new notifications for. 1130 * @return The call status code. 1131 * 1132 // FIXME: unhide. 1133 * {@hide} 1134 */ 1135 public int setMetadataFilter(Set<Integer> allow, Set<Integer> block) { 1136 // Do our serialization manually instead of calling 1137 // Parcel.writeArray since the sets are made of the same type 1138 // we avoid paying the price of calling writeValue (used by 1139 // writeArray) which burns an extra int per element to encode 1140 // the type. 1141 Parcel request = newRequest(); 1142 1143 // The parcel starts already with an interface token. There 1144 // are 2 filters. Each one starts with a 4bytes number to 1145 // store the len followed by a number of int (4 bytes as well) 1146 // representing the metadata type. 1147 int capacity = request.dataSize() + 4 * (1 + allow.size() + 1 + block.size()); 1148 1149 if (request.dataCapacity() < capacity) { 1150 request.setDataCapacity(capacity); 1151 } 1152 1153 request.writeInt(allow.size()); 1154 for(Integer t: allow) { 1155 request.writeInt(t); 1156 } 1157 request.writeInt(block.size()); 1158 for(Integer t: block) { 1159 request.writeInt(t); 1160 } 1161 return native_setMetadataFilter(request); 1162 } 1163 1164 /** 1165 * Releases resources associated with this MediaPlayer object. 1166 * It is considered good practice to call this method when you're 1167 * done using the MediaPlayer. For instance, whenever the Activity 1168 * of an application is paused, this method should be invoked to 1169 * release the MediaPlayer object. In addition to unnecessary resources 1170 * (such as memory and instances of codecs) being hold, failure to 1171 * call this method immediately if a MediaPlayer object is no longer 1172 * needed may also lead to continuous battery consumption for mobile 1173 * devices, and playback failure if no multiple instances of the 1174 * same codec is supported on a device. 1175 */ 1176 public void release() { 1177 stayAwake(false); 1178 updateSurfaceScreenOn(); 1179 mOnPreparedListener = null; 1180 mOnBufferingUpdateListener = null; 1181 mOnCompletionListener = null; 1182 mOnSeekCompleteListener = null; 1183 mOnErrorListener = null; 1184 mOnInfoListener = null; 1185 mOnVideoSizeChangedListener = null; 1186 mOnTimedTextListener = null; 1187 _release(); 1188 } 1189 1190 private native void _release(); 1191 1192 /** 1193 * Resets the MediaPlayer to its uninitialized state. After calling 1194 * this method, you will have to initialize it again by setting the 1195 * data source and calling prepare(). 1196 */ 1197 public void reset() { 1198 stayAwake(false); 1199 _reset(); 1200 // make sure none of the listeners get called anymore 1201 mEventHandler.removeCallbacksAndMessages(null); 1202 } 1203 1204 private native void _reset(); 1205 1206 /** 1207 * Sets the audio stream type for this MediaPlayer. See {@link AudioManager} 1208 * for a list of stream types. Must call this method before prepare() or 1209 * prepareAsync() in order for the target stream type to become effective 1210 * thereafter. 1211 * 1212 * @param streamtype the audio stream type 1213 * @see android.media.AudioManager 1214 */ 1215 public native void setAudioStreamType(int streamtype); 1216 1217 /** 1218 * Sets the player to be looping or non-looping. 1219 * 1220 * @param looping whether to loop or not 1221 */ 1222 public native void setLooping(boolean looping); 1223 1224 /** 1225 * Checks whether the MediaPlayer is looping or non-looping. 1226 * 1227 * @return true if the MediaPlayer is currently looping, false otherwise 1228 */ 1229 public native boolean isLooping(); 1230 1231 /** 1232 * Sets the volume on this player. 1233 * This API is recommended for balancing the output of audio streams 1234 * within an application. Unless you are writing an application to 1235 * control user settings, this API should be used in preference to 1236 * {@link AudioManager#setStreamVolume(int, int, int)} which sets the volume of ALL streams of 1237 * a particular type. Note that the passed volume values are raw scalars. 1238 * UI controls should be scaled logarithmically. 1239 * 1240 * @param leftVolume left volume scalar 1241 * @param rightVolume right volume scalar 1242 */ 1243 public native void setVolume(float leftVolume, float rightVolume); 1244 1245 /** 1246 * Currently not implemented, returns null. 1247 * @deprecated 1248 * @hide 1249 */ 1250 public native Bitmap getFrameAt(int msec) throws IllegalStateException; 1251 1252 /** 1253 * Sets the audio session ID. 1254 * 1255 * @param sessionId the audio session ID. 1256 * The audio session ID is a system wide unique identifier for the audio stream played by 1257 * this MediaPlayer instance. 1258 * The primary use of the audio session ID is to associate audio effects to a particular 1259 * instance of MediaPlayer: if an audio session ID is provided when creating an audio effect, 1260 * this effect will be applied only to the audio content of media players within the same 1261 * audio session and not to the output mix. 1262 * When created, a MediaPlayer instance automatically generates its own audio session ID. 1263 * However, it is possible to force this player to be part of an already existing audio session 1264 * by calling this method. 1265 * This method must be called before one of the overloaded <code> setDataSource </code> methods. 1266 * @throws IllegalStateException if it is called in an invalid state 1267 */ 1268 public native void setAudioSessionId(int sessionId) throws IllegalArgumentException, IllegalStateException; 1269 1270 /** 1271 * Returns the audio session ID. 1272 * 1273 * @return the audio session ID. {@see #setAudioSessionId(int)} 1274 * Note that the audio session ID is 0 only if a problem occured when the MediaPlayer was contructed. 1275 */ 1276 public native int getAudioSessionId(); 1277 1278 /** 1279 * Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation 1280 * effect which can be applied on any sound source that directs a certain amount of its 1281 * energy to this effect. This amount is defined by setAuxEffectSendLevel(). 1282 * {@see #setAuxEffectSendLevel(float)}. 1283 * <p>After creating an auxiliary effect (e.g. 1284 * {@link android.media.audiofx.EnvironmentalReverb}), retrieve its ID with 1285 * {@link android.media.audiofx.AudioEffect#getId()} and use it when calling this method 1286 * to attach the player to the effect. 1287 * <p>To detach the effect from the player, call this method with a null effect id. 1288 * <p>This method must be called after one of the overloaded <code> setDataSource </code> 1289 * methods. 1290 * @param effectId system wide unique id of the effect to attach 1291 */ 1292 public native void attachAuxEffect(int effectId); 1293 1294 /* Do not change these values (starting with KEY_PARAMETER) without updating 1295 * their counterparts in include/media/mediaplayer.h! 1296 */ 1297 /* 1298 * Key used in setParameter method. 1299 * Indicates the index of the timed text track to be enabled/disabled. 1300 * The index includes both the in-band and out-of-band timed text. 1301 * The index should start from in-band text if any. Application can retrieve the number 1302 * of in-band text tracks by using MediaMetadataRetriever::extractMetadata(). 1303 * Note it might take a few hundred ms to scan an out-of-band text file 1304 * before displaying it. 1305 */ 1306 private static final int KEY_PARAMETER_TIMED_TEXT_TRACK_INDEX = 1000; 1307 /* 1308 * Key used in setParameter method. 1309 * Used to add out-of-band timed text source path. 1310 * Application can add multiple text sources by calling setParameter() with 1311 * KEY_PARAMETER_TIMED_TEXT_ADD_OUT_OF_BAND_SOURCE multiple times. 1312 */ 1313 private static final int KEY_PARAMETER_TIMED_TEXT_ADD_OUT_OF_BAND_SOURCE = 1001; 1314 1315 /** 1316 * Sets the parameter indicated by key. 1317 * @param key key indicates the parameter to be set. 1318 * @param value value of the parameter to be set. 1319 * @return true if the parameter is set successfully, false otherwise 1320 * {@hide} 1321 */ 1322 public native boolean setParameter(int key, Parcel value); 1323 1324 /** 1325 * Sets the parameter indicated by key. 1326 * @param key key indicates the parameter to be set. 1327 * @param value value of the parameter to be set. 1328 * @return true if the parameter is set successfully, false otherwise 1329 * {@hide} 1330 */ 1331 public boolean setParameter(int key, String value) { 1332 Parcel p = Parcel.obtain(); 1333 p.writeString(value); 1334 return setParameter(key, p); 1335 } 1336 1337 /** 1338 * Sets the parameter indicated by key. 1339 * @param key key indicates the parameter to be set. 1340 * @param value value of the parameter to be set. 1341 * @return true if the parameter is set successfully, false otherwise 1342 * {@hide} 1343 */ 1344 public boolean setParameter(int key, int value) { 1345 Parcel p = Parcel.obtain(); 1346 p.writeInt(value); 1347 return setParameter(key, p); 1348 } 1349 1350 /** 1351 * Gets the value of the parameter indicated by key. 1352 * @param key key indicates the parameter to get. 1353 * @param reply value of the parameter to get. 1354 */ 1355 private native void getParameter(int key, Parcel reply); 1356 1357 /** 1358 * Gets the value of the parameter indicated by key. 1359 * @param key key indicates the parameter to get. 1360 * @return value of the parameter. 1361 * {@hide} 1362 */ 1363 public Parcel getParcelParameter(int key) { 1364 Parcel p = Parcel.obtain(); 1365 getParameter(key, p); 1366 return p; 1367 } 1368 1369 /** 1370 * Gets the value of the parameter indicated by key. 1371 * @param key key indicates the parameter to get. 1372 * @return value of the parameter. 1373 * {@hide} 1374 */ 1375 public String getStringParameter(int key) { 1376 Parcel p = Parcel.obtain(); 1377 getParameter(key, p); 1378 return p.readString(); 1379 } 1380 1381 /** 1382 * Gets the value of the parameter indicated by key. 1383 * @param key key indicates the parameter to get. 1384 * @return value of the parameter. 1385 * {@hide} 1386 */ 1387 public int getIntParameter(int key) { 1388 Parcel p = Parcel.obtain(); 1389 getParameter(key, p); 1390 return p.readInt(); 1391 } 1392 1393 /** 1394 * Sets the send level of the player to the attached auxiliary effect 1395 * {@see #attachAuxEffect(int)}. The level value range is 0 to 1.0. 1396 * <p>By default the send level is 0, so even if an effect is attached to the player 1397 * this method must be called for the effect to be applied. 1398 * <p>Note that the passed level value is a raw scalar. UI controls should be scaled 1399 * logarithmically: the gain applied by audio framework ranges from -72dB to 0dB, 1400 * so an appropriate conversion from linear UI input x to level is: 1401 * x == 0 -> level = 0 1402 * 0 < x <= R -> level = 10^(72*(x-R)/20/R) 1403 * @param level send level scalar 1404 */ 1405 public native void setAuxEffectSendLevel(float level); 1406 1407 /** 1408 * @param request Parcel destinated to the media player. The 1409 * Interface token must be set to the IMediaPlayer 1410 * one to be routed correctly through the system. 1411 * @param reply[out] Parcel that will contain the reply. 1412 * @return The status code. 1413 */ 1414 private native final int native_invoke(Parcel request, Parcel reply); 1415 1416 1417 /** 1418 * @param update_only If true fetch only the set of metadata that have 1419 * changed since the last invocation of getMetadata. 1420 * The set is built using the unfiltered 1421 * notifications the native player sent to the 1422 * MediaPlayerService during that period of 1423 * time. If false, all the metadatas are considered. 1424 * @param apply_filter If true, once the metadata set has been built based on 1425 * the value update_only, the current filter is applied. 1426 * @param reply[out] On return contains the serialized 1427 * metadata. Valid only if the call was successful. 1428 * @return The status code. 1429 */ 1430 private native final boolean native_getMetadata(boolean update_only, 1431 boolean apply_filter, 1432 Parcel reply); 1433 1434 /** 1435 * @param request Parcel with the 2 serialized lists of allowed 1436 * metadata types followed by the one to be 1437 * dropped. Each list starts with an integer 1438 * indicating the number of metadata type elements. 1439 * @return The status code. 1440 */ 1441 private native final int native_setMetadataFilter(Parcel request); 1442 1443 private static native final void native_init(); 1444 private native final void native_setup(Object mediaplayer_this); 1445 private native final void native_finalize(); 1446 1447 /** 1448 * @param index The index of the text track to be turned on. 1449 * @return true if the text track is enabled successfully. 1450 * {@hide} 1451 */ 1452 public boolean enableTimedTextTrackIndex(int index) { 1453 if (index < 0) { 1454 return false; 1455 } 1456 return setParameter(KEY_PARAMETER_TIMED_TEXT_TRACK_INDEX, index); 1457 } 1458 1459 /** 1460 * Enables the first timed text track if any. 1461 * @return true if the text track is enabled successfully 1462 * {@hide} 1463 */ 1464 public boolean enableTimedText() { 1465 return enableTimedTextTrackIndex(0); 1466 } 1467 1468 /** 1469 * Disables timed text display. 1470 * @return true if the text track is disabled successfully. 1471 * {@hide} 1472 */ 1473 public boolean disableTimedText() { 1474 return setParameter(KEY_PARAMETER_TIMED_TEXT_TRACK_INDEX, -1); 1475 } 1476 1477 /** 1478 * @param reply Parcel with audio/video duration info for battery 1479 tracking usage 1480 * @return The status code. 1481 * {@hide} 1482 */ 1483 public native static int native_pullBatteryData(Parcel reply); 1484 1485 @Override 1486 protected void finalize() { native_finalize(); } 1487 1488 /* Do not change these values without updating their counterparts 1489 * in include/media/mediaplayer.h! 1490 */ 1491 private static final int MEDIA_NOP = 0; // interface test message 1492 private static final int MEDIA_PREPARED = 1; 1493 private static final int MEDIA_PLAYBACK_COMPLETE = 2; 1494 private static final int MEDIA_BUFFERING_UPDATE = 3; 1495 private static final int MEDIA_SEEK_COMPLETE = 4; 1496 private static final int MEDIA_SET_VIDEO_SIZE = 5; 1497 private static final int MEDIA_TIMED_TEXT = 99; 1498 private static final int MEDIA_ERROR = 100; 1499 private static final int MEDIA_INFO = 200; 1500 1501 private class EventHandler extends Handler 1502 { 1503 private MediaPlayer mMediaPlayer; 1504 1505 public EventHandler(MediaPlayer mp, Looper looper) { 1506 super(looper); 1507 mMediaPlayer = mp; 1508 } 1509 1510 @Override 1511 public void handleMessage(Message msg) { 1512 if (mMediaPlayer.mNativeContext == 0) { 1513 Log.w(TAG, "mediaplayer went away with unhandled events"); 1514 return; 1515 } 1516 switch(msg.what) { 1517 case MEDIA_PREPARED: 1518 if (mOnPreparedListener != null) 1519 mOnPreparedListener.onPrepared(mMediaPlayer); 1520 return; 1521 1522 case MEDIA_PLAYBACK_COMPLETE: 1523 if (mOnCompletionListener != null) 1524 mOnCompletionListener.onCompletion(mMediaPlayer); 1525 stayAwake(false); 1526 return; 1527 1528 case MEDIA_BUFFERING_UPDATE: 1529 if (mOnBufferingUpdateListener != null) 1530 mOnBufferingUpdateListener.onBufferingUpdate(mMediaPlayer, msg.arg1); 1531 return; 1532 1533 case MEDIA_SEEK_COMPLETE: 1534 if (mOnSeekCompleteListener != null) 1535 mOnSeekCompleteListener.onSeekComplete(mMediaPlayer); 1536 return; 1537 1538 case MEDIA_SET_VIDEO_SIZE: 1539 if (mOnVideoSizeChangedListener != null) 1540 mOnVideoSizeChangedListener.onVideoSizeChanged(mMediaPlayer, msg.arg1, msg.arg2); 1541 return; 1542 1543 case MEDIA_ERROR: 1544 // For PV specific error values (msg.arg2) look in 1545 // opencore/pvmi/pvmf/include/pvmf_return_codes.h 1546 Log.e(TAG, "Error (" + msg.arg1 + "," + msg.arg2 + ")"); 1547 boolean error_was_handled = false; 1548 if (mOnErrorListener != null) { 1549 error_was_handled = mOnErrorListener.onError(mMediaPlayer, msg.arg1, msg.arg2); 1550 } 1551 if (mOnCompletionListener != null && ! error_was_handled) { 1552 mOnCompletionListener.onCompletion(mMediaPlayer); 1553 } 1554 stayAwake(false); 1555 return; 1556 1557 case MEDIA_INFO: 1558 if (msg.arg1 != MEDIA_INFO_VIDEO_TRACK_LAGGING) { 1559 Log.i(TAG, "Info (" + msg.arg1 + "," + msg.arg2 + ")"); 1560 } 1561 if (mOnInfoListener != null) { 1562 mOnInfoListener.onInfo(mMediaPlayer, msg.arg1, msg.arg2); 1563 } 1564 // No real default action so far. 1565 return; 1566 case MEDIA_TIMED_TEXT: 1567 if (mOnTimedTextListener != null) { 1568 mOnTimedTextListener.onTimedText(mMediaPlayer, (String)msg.obj); 1569 } 1570 return; 1571 1572 case MEDIA_NOP: // interface test message - ignore 1573 break; 1574 1575 default: 1576 Log.e(TAG, "Unknown message type " + msg.what); 1577 return; 1578 } 1579 } 1580 } 1581 1582 /** 1583 * Called from native code when an interesting event happens. This method 1584 * just uses the EventHandler system to post the event back to the main app thread. 1585 * We use a weak reference to the original MediaPlayer object so that the native 1586 * code is safe from the object disappearing from underneath it. (This is 1587 * the cookie passed to native_setup().) 1588 */ 1589 private static void postEventFromNative(Object mediaplayer_ref, 1590 int what, int arg1, int arg2, Object obj) 1591 { 1592 MediaPlayer mp = (MediaPlayer)((WeakReference)mediaplayer_ref).get(); 1593 if (mp == null) { 1594 return; 1595 } 1596 1597 if (mp.mEventHandler != null) { 1598 Message m = mp.mEventHandler.obtainMessage(what, arg1, arg2, obj); 1599 mp.mEventHandler.sendMessage(m); 1600 } 1601 } 1602 1603 /** 1604 * Interface definition for a callback to be invoked when the media 1605 * source is ready for playback. 1606 */ 1607 public interface OnPreparedListener 1608 { 1609 /** 1610 * Called when the media file is ready for playback. 1611 * 1612 * @param mp the MediaPlayer that is ready for playback 1613 */ 1614 void onPrepared(MediaPlayer mp); 1615 } 1616 1617 /** 1618 * Register a callback to be invoked when the media source is ready 1619 * for playback. 1620 * 1621 * @param listener the callback that will be run 1622 */ 1623 public void setOnPreparedListener(OnPreparedListener listener) 1624 { 1625 mOnPreparedListener = listener; 1626 } 1627 1628 private OnPreparedListener mOnPreparedListener; 1629 1630 /** 1631 * Interface definition for a callback to be invoked when playback of 1632 * a media source has completed. 1633 */ 1634 public interface OnCompletionListener 1635 { 1636 /** 1637 * Called when the end of a media source is reached during playback. 1638 * 1639 * @param mp the MediaPlayer that reached the end of the file 1640 */ 1641 void onCompletion(MediaPlayer mp); 1642 } 1643 1644 /** 1645 * Register a callback to be invoked when the end of a media source 1646 * has been reached during playback. 1647 * 1648 * @param listener the callback that will be run 1649 */ 1650 public void setOnCompletionListener(OnCompletionListener listener) 1651 { 1652 mOnCompletionListener = listener; 1653 } 1654 1655 private OnCompletionListener mOnCompletionListener; 1656 1657 /** 1658 * Interface definition of a callback to be invoked indicating buffering 1659 * status of a media resource being streamed over the network. 1660 */ 1661 public interface OnBufferingUpdateListener 1662 { 1663 /** 1664 * Called to update status in buffering a media stream received through 1665 * progressive HTTP download. The received buffering percentage 1666 * indicates how much of the content has been buffered or played. 1667 * For example a buffering update of 80 percent when half the content 1668 * has already been played indicates that the next 30 percent of the 1669 * content to play has been buffered. 1670 * 1671 * @param mp the MediaPlayer the update pertains to 1672 * @param percent the percentage (0-100) of the content 1673 * that has been buffered or played thus far 1674 */ 1675 void onBufferingUpdate(MediaPlayer mp, int percent); 1676 } 1677 1678 /** 1679 * Register a callback to be invoked when the status of a network 1680 * stream's buffer has changed. 1681 * 1682 * @param listener the callback that will be run. 1683 */ 1684 public void setOnBufferingUpdateListener(OnBufferingUpdateListener listener) 1685 { 1686 mOnBufferingUpdateListener = listener; 1687 } 1688 1689 private OnBufferingUpdateListener mOnBufferingUpdateListener; 1690 1691 /** 1692 * Interface definition of a callback to be invoked indicating 1693 * the completion of a seek operation. 1694 */ 1695 public interface OnSeekCompleteListener 1696 { 1697 /** 1698 * Called to indicate the completion of a seek operation. 1699 * 1700 * @param mp the MediaPlayer that issued the seek operation 1701 */ 1702 public void onSeekComplete(MediaPlayer mp); 1703 } 1704 1705 /** 1706 * Register a callback to be invoked when a seek operation has been 1707 * completed. 1708 * 1709 * @param listener the callback that will be run 1710 */ 1711 public void setOnSeekCompleteListener(OnSeekCompleteListener listener) 1712 { 1713 mOnSeekCompleteListener = listener; 1714 } 1715 1716 private OnSeekCompleteListener mOnSeekCompleteListener; 1717 1718 /** 1719 * Interface definition of a callback to be invoked when the 1720 * video size is first known or updated 1721 */ 1722 public interface OnVideoSizeChangedListener 1723 { 1724 /** 1725 * Called to indicate the video size 1726 * 1727 * @param mp the MediaPlayer associated with this callback 1728 * @param width the width of the video 1729 * @param height the height of the video 1730 */ 1731 public void onVideoSizeChanged(MediaPlayer mp, int width, int height); 1732 } 1733 1734 /** 1735 * Register a callback to be invoked when the video size is 1736 * known or updated. 1737 * 1738 * @param listener the callback that will be run 1739 */ 1740 public void setOnVideoSizeChangedListener(OnVideoSizeChangedListener listener) 1741 { 1742 mOnVideoSizeChangedListener = listener; 1743 } 1744 1745 private OnVideoSizeChangedListener mOnVideoSizeChangedListener; 1746 1747 /** 1748 * Interface definition of a callback to be invoked when a 1749 * timed text is available for display. 1750 * {@hide} 1751 */ 1752 public interface OnTimedTextListener 1753 { 1754 /** 1755 * Called to indicate the video size 1756 * 1757 * @param mp the MediaPlayer associated with this callback 1758 * @param text the timed text sample which contains the 1759 * text needed to be displayed. 1760 * {@hide} 1761 */ 1762 public void onTimedText(MediaPlayer mp, String text); 1763 } 1764 1765 /** 1766 * Register a callback to be invoked when a timed text is available 1767 * for display. 1768 * 1769 * @param listener the callback that will be run 1770 * {@hide} 1771 */ 1772 public void setOnTimedTextListener(OnTimedTextListener listener) 1773 { 1774 mOnTimedTextListener = listener; 1775 } 1776 1777 private OnTimedTextListener mOnTimedTextListener; 1778 1779 1780 /* Do not change these values without updating their counterparts 1781 * in include/media/mediaplayer.h! 1782 */ 1783 /** Unspecified media player error. 1784 * @see android.media.MediaPlayer.OnErrorListener 1785 */ 1786 public static final int MEDIA_ERROR_UNKNOWN = 1; 1787 1788 /** Media server died. In this case, the application must release the 1789 * MediaPlayer object and instantiate a new one. 1790 * @see android.media.MediaPlayer.OnErrorListener 1791 */ 1792 public static final int MEDIA_ERROR_SERVER_DIED = 100; 1793 1794 /** The video is streamed and its container is not valid for progressive 1795 * playback i.e the video's index (e.g moov atom) is not at the start of the 1796 * file. 1797 * @see android.media.MediaPlayer.OnErrorListener 1798 */ 1799 public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200; 1800 1801 /** 1802 * Interface definition of a callback to be invoked when there 1803 * has been an error during an asynchronous operation (other errors 1804 * will throw exceptions at method call time). 1805 */ 1806 public interface OnErrorListener 1807 { 1808 /** 1809 * Called to indicate an error. 1810 * 1811 * @param mp the MediaPlayer the error pertains to 1812 * @param what the type of error that has occurred: 1813 * <ul> 1814 * <li>{@link #MEDIA_ERROR_UNKNOWN} 1815 * <li>{@link #MEDIA_ERROR_SERVER_DIED} 1816 * </ul> 1817 * @param extra an extra code, specific to the error. Typically 1818 * implementation dependant. 1819 * @return True if the method handled the error, false if it didn't. 1820 * Returning false, or not having an OnErrorListener at all, will 1821 * cause the OnCompletionListener to be called. 1822 */ 1823 boolean onError(MediaPlayer mp, int what, int extra); 1824 } 1825 1826 /** 1827 * Register a callback to be invoked when an error has happened 1828 * during an asynchronous operation. 1829 * 1830 * @param listener the callback that will be run 1831 */ 1832 public void setOnErrorListener(OnErrorListener listener) 1833 { 1834 mOnErrorListener = listener; 1835 } 1836 1837 private OnErrorListener mOnErrorListener; 1838 1839 1840 /* Do not change these values without updating their counterparts 1841 * in include/media/mediaplayer.h! 1842 */ 1843 /** Unspecified media player info. 1844 * @see android.media.MediaPlayer.OnInfoListener 1845 */ 1846 public static final int MEDIA_INFO_UNKNOWN = 1; 1847 1848 /** The video is too complex for the decoder: it can't decode frames fast 1849 * enough. Possibly only the audio plays fine at this stage. 1850 * @see android.media.MediaPlayer.OnInfoListener 1851 */ 1852 public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING = 700; 1853 1854 /** MediaPlayer is temporarily pausing playback internally in order to 1855 * buffer more data. 1856 * @see android.media.MediaPlayer.OnInfoListener 1857 */ 1858 public static final int MEDIA_INFO_BUFFERING_START = 701; 1859 1860 /** MediaPlayer is resuming playback after filling buffers. 1861 * @see android.media.MediaPlayer.OnInfoListener 1862 */ 1863 public static final int MEDIA_INFO_BUFFERING_END = 702; 1864 1865 /** Bad interleaving means that a media has been improperly interleaved or 1866 * not interleaved at all, e.g has all the video samples first then all the 1867 * audio ones. Video is playing but a lot of disk seeks may be happening. 1868 * @see android.media.MediaPlayer.OnInfoListener 1869 */ 1870 public static final int MEDIA_INFO_BAD_INTERLEAVING = 800; 1871 1872 /** The media cannot be seeked (e.g live stream) 1873 * @see android.media.MediaPlayer.OnInfoListener 1874 */ 1875 public static final int MEDIA_INFO_NOT_SEEKABLE = 801; 1876 1877 /** A new set of metadata is available. 1878 * @see android.media.MediaPlayer.OnInfoListener 1879 */ 1880 public static final int MEDIA_INFO_METADATA_UPDATE = 802; 1881 1882 /** 1883 * Interface definition of a callback to be invoked to communicate some 1884 * info and/or warning about the media or its playback. 1885 */ 1886 public interface OnInfoListener 1887 { 1888 /** 1889 * Called to indicate an info or a warning. 1890 * 1891 * @param mp the MediaPlayer the info pertains to. 1892 * @param what the type of info or warning. 1893 * <ul> 1894 * <li>{@link #MEDIA_INFO_UNKNOWN} 1895 * <li>{@link #MEDIA_INFO_VIDEO_TRACK_LAGGING} 1896 * <li>{@link #MEDIA_INFO_BUFFERING_START} 1897 * <li>{@link #MEDIA_INFO_BUFFERING_END} 1898 * <li>{@link #MEDIA_INFO_BAD_INTERLEAVING} 1899 * <li>{@link #MEDIA_INFO_NOT_SEEKABLE} 1900 * <li>{@link #MEDIA_INFO_METADATA_UPDATE} 1901 * </ul> 1902 * @param extra an extra code, specific to the info. Typically 1903 * implementation dependant. 1904 * @return True if the method handled the info, false if it didn't. 1905 * Returning false, or not having an OnErrorListener at all, will 1906 * cause the info to be discarded. 1907 */ 1908 boolean onInfo(MediaPlayer mp, int what, int extra); 1909 } 1910 1911 /** 1912 * Register a callback to be invoked when an info/warning is available. 1913 * 1914 * @param listener the callback that will be run 1915 */ 1916 public void setOnInfoListener(OnInfoListener listener) 1917 { 1918 mOnInfoListener = listener; 1919 } 1920 1921 private OnInfoListener mOnInfoListener; 1922 1923} 1924