MediaPlayer.java revision 6ff9b812abe388478bbaba118a580c3f4a30c863
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 holder or surface 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 Surface} to be used as the sink for the video portion of 634 * the media. This is similar to {@link #setDisplay(SurfaceHolder)}, but does not 635 * support {@link #setScreenOnWhilePlaying(boolean)} or {@link #updateSurfaceScreenOn()}. 636 * Setting a Surface will un-set any Surface or SurfaceHolder that was previously set. 637 * 638 * @param surface The {@link Surface} to be used for the video portion of the media. 639 * 640 * @hide Pending review by API council. 641 */ 642 public void setSurface(Surface surface) { 643 if (mScreenOnWhilePlaying && surface != null && mSurface != null) { 644 Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective for Surface"); 645 } 646 mSurfaceHolder = null; 647 mSurface = surface; 648 mParcelSurfaceTexture = null; // TODO(tedbo): Remove. 649 _setVideoSurfaceOrSurfaceTexture(); 650 updateSurfaceScreenOn(); 651 } 652 653 /** 654 * Sets the {@link SurfaceTexture} to be used as the sink for the 655 * video portion of the media. Either a surface or surface texture 656 * must be set if a video sink is needed. The same surface texture 657 * can be re-set without harm. Setting a surface texture will un-set 658 * any surface that was set via {@link #setDisplay(SurfaceHolder)}. 659 * Not calling this method or {@link #setDisplay(SurfaceHolder)} 660 * when playing back a video will result in only the audio track 661 * being played. Note that if a SurfaceTexture is used, the value 662 * set via setScreenOnWhilePlaying has no effect. 663 * 664 * The timestamps provided by {@link SurfaceTexture#getTimestamp()} for a 665 * SurfaceTexture set as the video sink have an unspecified zero point, 666 * and cannot be directly compared between different media sources or different 667 * instances of the same media source, or across multiple runs of the same 668 * program. The timestamp is normally monotonically increasing and unaffected 669 * by time-of-day adjustments, but is reset when the position is set. 670 */ 671 public void setTexture(SurfaceTexture st) { 672 ParcelSurfaceTexture pst = null; 673 if (st != null) { 674 pst = ParcelSurfaceTexture.fromSurfaceTexture(st); 675 } 676 setParcelSurfaceTexture(pst); 677 } 678 679 /** 680 * Sets the {@link ParcelSurfaceTexture} to be used as the sink for the video portion of 681 * the media. This is similar to {@link #setTexture(SurfaceTexture)}, but supports using 682 * a {@link ParcelSurfaceTexture} to transport the texture to be used via Binder. Setting 683 * a parceled surface texture will un-set any surface or surface texture that was previously 684 * set. See {@link #setTexture(SurfaceTexture)} for more details. 685 * 686 * @param pst The {@link ParcelSurfaceTexture} to be used as the sink for 687 * the video portion of the media. 688 * 689 * @hide Pending removal when there are no more callers. 690 */ 691 public void setParcelSurfaceTexture(ParcelSurfaceTexture pst) { 692 if (mScreenOnWhilePlaying && pst != null && mParcelSurfaceTexture == null) { 693 Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective for SurfaceTexture"); 694 } 695 mSurfaceHolder = null; 696 mSurface = null; 697 mParcelSurfaceTexture = pst; 698 _setVideoSurfaceOrSurfaceTexture(); 699 updateSurfaceScreenOn(); 700 } 701 702 /** 703 * Convenience method to create a MediaPlayer for a given Uri. 704 * On success, {@link #prepare()} will already have been called and must not be called again. 705 * <p>When done with the MediaPlayer, you should call {@link #release()}, 706 * to free the resources. If not released, too many MediaPlayer instances will 707 * result in an exception.</p> 708 * 709 * @param context the Context to use 710 * @param uri the Uri from which to get the datasource 711 * @return a MediaPlayer object, or null if creation failed 712 */ 713 public static MediaPlayer create(Context context, Uri uri) { 714 return create (context, uri, null); 715 } 716 717 /** 718 * Convenience method to create a MediaPlayer for a given Uri. 719 * On success, {@link #prepare()} will already have been called and must not be called again. 720 * <p>When done with the MediaPlayer, you should call {@link #release()}, 721 * to free the resources. If not released, too many MediaPlayer instances will 722 * result in an exception.</p> 723 * 724 * @param context the Context to use 725 * @param uri the Uri from which to get the datasource 726 * @param holder the SurfaceHolder to use for displaying the video 727 * @return a MediaPlayer object, or null if creation failed 728 */ 729 public static MediaPlayer create(Context context, Uri uri, SurfaceHolder holder) { 730 731 try { 732 MediaPlayer mp = new MediaPlayer(); 733 mp.setDataSource(context, uri); 734 if (holder != null) { 735 mp.setDisplay(holder); 736 } 737 mp.prepare(); 738 return mp; 739 } catch (IOException ex) { 740 Log.d(TAG, "create failed:", ex); 741 // fall through 742 } catch (IllegalArgumentException ex) { 743 Log.d(TAG, "create failed:", ex); 744 // fall through 745 } catch (SecurityException ex) { 746 Log.d(TAG, "create failed:", ex); 747 // fall through 748 } 749 750 return null; 751 } 752 753 // Note no convenience method to create a MediaPlayer with SurfaceTexture sink. 754 755 /** 756 * Convenience method to create a MediaPlayer for a given resource id. 757 * On success, {@link #prepare()} will already have been called and must not be called again. 758 * <p>When done with the MediaPlayer, you should call {@link #release()}, 759 * to free the resources. If not released, too many MediaPlayer instances will 760 * result in an exception.</p> 761 * 762 * @param context the Context to use 763 * @param resid the raw resource id (<var>R.raw.<something></var>) for 764 * the resource to use as the datasource 765 * @return a MediaPlayer object, or null if creation failed 766 */ 767 public static MediaPlayer create(Context context, int resid) { 768 try { 769 AssetFileDescriptor afd = context.getResources().openRawResourceFd(resid); 770 if (afd == null) return null; 771 772 MediaPlayer mp = new MediaPlayer(); 773 mp.setDataSource(afd.getFileDescriptor(), afd.getStartOffset(), afd.getLength()); 774 afd.close(); 775 mp.prepare(); 776 return mp; 777 } catch (IOException ex) { 778 Log.d(TAG, "create failed:", ex); 779 // fall through 780 } catch (IllegalArgumentException ex) { 781 Log.d(TAG, "create failed:", ex); 782 // fall through 783 } catch (SecurityException ex) { 784 Log.d(TAG, "create failed:", ex); 785 // fall through 786 } 787 return null; 788 } 789 790 /** 791 * Sets the data source as a content Uri. 792 * 793 * @param context the Context to use when resolving the Uri 794 * @param uri the Content URI of the data you want to play 795 * @throws IllegalStateException if it is called in an invalid state 796 */ 797 public void setDataSource(Context context, Uri uri) 798 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 799 setDataSource(context, uri, null); 800 } 801 802 /** 803 * Sets the data source as a content Uri. 804 * 805 * @param context the Context to use when resolving the Uri 806 * @param uri the Content URI of the data you want to play 807 * @param headers the headers to be sent together with the request for the data 808 * @throws IllegalStateException if it is called in an invalid state 809 */ 810 public void setDataSource(Context context, Uri uri, Map<String, String> headers) 811 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 812 813 String scheme = uri.getScheme(); 814 if(scheme == null || scheme.equals("file")) { 815 setDataSource(uri.getPath()); 816 return; 817 } 818 819 AssetFileDescriptor fd = null; 820 try { 821 ContentResolver resolver = context.getContentResolver(); 822 fd = resolver.openAssetFileDescriptor(uri, "r"); 823 if (fd == null) { 824 return; 825 } 826 // Note: using getDeclaredLength so that our behavior is the same 827 // as previous versions when the content provider is returning 828 // a full file. 829 if (fd.getDeclaredLength() < 0) { 830 setDataSource(fd.getFileDescriptor()); 831 } else { 832 setDataSource(fd.getFileDescriptor(), fd.getStartOffset(), fd.getDeclaredLength()); 833 } 834 return; 835 } catch (SecurityException ex) { 836 } catch (IOException ex) { 837 } finally { 838 if (fd != null) { 839 fd.close(); 840 } 841 } 842 Log.d(TAG, "Couldn't open file on client side, trying server side"); 843 setDataSource(uri.toString(), headers); 844 return; 845 } 846 847 /** 848 * Sets the data source (file-path or http/rtsp URL) to use. 849 * 850 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 851 * @throws IllegalStateException if it is called in an invalid state 852 */ 853 public native void setDataSource(String path) throws IOException, IllegalArgumentException, IllegalStateException; 854 855 /** 856 * Sets the data source (file-path or http/rtsp URL) to use. 857 * 858 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 859 * @param headers the headers associated with the http request for the stream you want to play 860 * @throws IllegalStateException if it is called in an invalid state 861 * @hide pending API council 862 */ 863 public void setDataSource(String path, Map<String, String> headers) 864 throws IOException, IllegalArgumentException, IllegalStateException 865 { 866 String[] keys = null; 867 String[] values = null; 868 869 if (headers != null) { 870 keys = new String[headers.size()]; 871 values = new String[headers.size()]; 872 873 int i = 0; 874 for (Map.Entry<String, String> entry: headers.entrySet()) { 875 keys[i] = entry.getKey(); 876 values[i] = entry.getValue(); 877 ++i; 878 } 879 } 880 _setDataSource(path, keys, values); 881 } 882 883 private native void _setDataSource( 884 String path, String[] keys, String[] values) 885 throws IOException, IllegalArgumentException, IllegalStateException; 886 887 /** 888 * Sets the data source (FileDescriptor) to use. It is the caller's responsibility 889 * to close the file descriptor. It is safe to do so as soon as this call returns. 890 * 891 * @param fd the FileDescriptor for the file you want to play 892 * @throws IllegalStateException if it is called in an invalid state 893 */ 894 public void setDataSource(FileDescriptor fd) 895 throws IOException, IllegalArgumentException, IllegalStateException { 896 // intentionally less than LONG_MAX 897 setDataSource(fd, 0, 0x7ffffffffffffffL); 898 } 899 900 /** 901 * Sets the data source (FileDescriptor) to use. The FileDescriptor must be 902 * seekable (N.B. a LocalSocket is not seekable). It is the caller's responsibility 903 * to close the file descriptor. It is safe to do so as soon as this call returns. 904 * 905 * @param fd the FileDescriptor for the file you want to play 906 * @param offset the offset into the file where the data to be played starts, in bytes 907 * @param length the length in bytes of the data to be played 908 * @throws IllegalStateException if it is called in an invalid state 909 */ 910 public native void setDataSource(FileDescriptor fd, long offset, long length) 911 throws IOException, IllegalArgumentException, IllegalStateException; 912 913 /** 914 * Prepares the player for playback, synchronously. 915 * 916 * After setting the datasource and the display surface, you need to either 917 * call prepare() or prepareAsync(). For files, it is OK to call prepare(), 918 * which blocks until MediaPlayer is ready for playback. 919 * 920 * @throws IllegalStateException if it is called in an invalid state 921 */ 922 public native void prepare() throws IOException, IllegalStateException; 923 924 /** 925 * Prepares the player for playback, asynchronously. 926 * 927 * After setting the datasource and the display surface, you need to either 928 * call prepare() or prepareAsync(). For streams, you should call prepareAsync(), 929 * which returns immediately, rather than blocking until enough data has been 930 * buffered. 931 * 932 * @throws IllegalStateException if it is called in an invalid state 933 */ 934 public native void prepareAsync() throws IllegalStateException; 935 936 /** 937 * Starts or resumes playback. If playback had previously been paused, 938 * playback will continue from where it was paused. If playback had 939 * been stopped, or never started before, playback will start at the 940 * beginning. 941 * 942 * @throws IllegalStateException if it is called in an invalid state 943 */ 944 public void start() throws IllegalStateException { 945 stayAwake(true); 946 _start(); 947 } 948 949 private native void _start() throws IllegalStateException; 950 951 /** 952 * Stops playback after playback has been stopped or paused. 953 * 954 * @throws IllegalStateException if the internal player engine has not been 955 * initialized. 956 */ 957 public void stop() throws IllegalStateException { 958 stayAwake(false); 959 _stop(); 960 } 961 962 private native void _stop() throws IllegalStateException; 963 964 /** 965 * Pauses playback. Call start() to resume. 966 * 967 * @throws IllegalStateException if the internal player engine has not been 968 * initialized. 969 */ 970 public void pause() throws IllegalStateException { 971 stayAwake(false); 972 _pause(); 973 } 974 975 private native void _pause() throws IllegalStateException; 976 977 /** 978 * Set the low-level power management behavior for this MediaPlayer. This 979 * can be used when the MediaPlayer is not playing through a SurfaceHolder 980 * set with {@link #setDisplay(SurfaceHolder)} and thus can use the 981 * high-level {@link #setScreenOnWhilePlaying(boolean)} feature. 982 * 983 * <p>This function has the MediaPlayer access the low-level power manager 984 * service to control the device's power usage while playing is occurring. 985 * The parameter is a combination of {@link android.os.PowerManager} wake flags. 986 * Use of this method requires {@link android.Manifest.permission#WAKE_LOCK} 987 * permission. 988 * By default, no attempt is made to keep the device awake during playback. 989 * 990 * @param context the Context to use 991 * @param mode the power/wake mode to set 992 * @see android.os.PowerManager 993 */ 994 public void setWakeMode(Context context, int mode) { 995 boolean washeld = false; 996 if (mWakeLock != null) { 997 if (mWakeLock.isHeld()) { 998 washeld = true; 999 mWakeLock.release(); 1000 } 1001 mWakeLock = null; 1002 } 1003 1004 PowerManager pm = (PowerManager)context.getSystemService(Context.POWER_SERVICE); 1005 mWakeLock = pm.newWakeLock(mode|PowerManager.ON_AFTER_RELEASE, MediaPlayer.class.getName()); 1006 mWakeLock.setReferenceCounted(false); 1007 if (washeld) { 1008 mWakeLock.acquire(); 1009 } 1010 } 1011 1012 /** 1013 * Control whether we should use the attached SurfaceHolder to keep the 1014 * screen on while video playback is occurring. This is the preferred 1015 * method over {@link #setWakeMode} where possible, since it doesn't 1016 * require that the application have permission for low-level wake lock 1017 * access. 1018 * 1019 * @param screenOn Supply true to keep the screen on, false to allow it 1020 * to turn off. 1021 */ 1022 public void setScreenOnWhilePlaying(boolean screenOn) { 1023 if (mScreenOnWhilePlaying != screenOn) { 1024 if (screenOn && mSurfaceHolder == null) { 1025 Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective without a SurfaceHolder"); 1026 } 1027 mScreenOnWhilePlaying = screenOn; 1028 updateSurfaceScreenOn(); 1029 } 1030 } 1031 1032 private void stayAwake(boolean awake) { 1033 if (mWakeLock != null) { 1034 if (awake && !mWakeLock.isHeld()) { 1035 mWakeLock.acquire(); 1036 } else if (!awake && mWakeLock.isHeld()) { 1037 mWakeLock.release(); 1038 } 1039 } 1040 mStayAwake = awake; 1041 updateSurfaceScreenOn(); 1042 } 1043 1044 private void updateSurfaceScreenOn() { 1045 if (mSurfaceHolder != null) { 1046 mSurfaceHolder.setKeepScreenOn(mScreenOnWhilePlaying && mStayAwake); 1047 } 1048 } 1049 1050 /** 1051 * Returns the width of the video. 1052 * 1053 * @return the width of the video, or 0 if there is no video, 1054 * no display surface was set, or the width has not been determined 1055 * yet. The OnVideoSizeChangedListener can be registered via 1056 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)} 1057 * to provide a notification when the width is available. 1058 */ 1059 public native int getVideoWidth(); 1060 1061 /** 1062 * Returns the height of the video. 1063 * 1064 * @return the height of the video, or 0 if there is no video, 1065 * no display surface was set, or the height has not been determined 1066 * yet. The OnVideoSizeChangedListener can be registered via 1067 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)} 1068 * to provide a notification when the height is available. 1069 */ 1070 public native int getVideoHeight(); 1071 1072 /** 1073 * Checks whether the MediaPlayer is playing. 1074 * 1075 * @return true if currently playing, false otherwise 1076 */ 1077 public native boolean isPlaying(); 1078 1079 /** 1080 * Seeks to specified time position. 1081 * 1082 * @param msec the offset in milliseconds from the start to seek to 1083 * @throws IllegalStateException if the internal player engine has not been 1084 * initialized 1085 */ 1086 public native void seekTo(int msec) throws IllegalStateException; 1087 1088 /** 1089 * Gets the current playback position. 1090 * 1091 * @return the current position in milliseconds 1092 */ 1093 public native int getCurrentPosition(); 1094 1095 /** 1096 * Gets the duration of the file. 1097 * 1098 * @return the duration in milliseconds 1099 */ 1100 public native int getDuration(); 1101 1102 /** 1103 * Gets the media metadata. 1104 * 1105 * @param update_only controls whether the full set of available 1106 * metadata is returned or just the set that changed since the 1107 * last call. See {@see #METADATA_UPDATE_ONLY} and {@see 1108 * #METADATA_ALL}. 1109 * 1110 * @param apply_filter if true only metadata that matches the 1111 * filter is returned. See {@see #APPLY_METADATA_FILTER} and {@see 1112 * #BYPASS_METADATA_FILTER}. 1113 * 1114 * @return The metadata, possibly empty. null if an error occured. 1115 // FIXME: unhide. 1116 * {@hide} 1117 */ 1118 public Metadata getMetadata(final boolean update_only, 1119 final boolean apply_filter) { 1120 Parcel reply = Parcel.obtain(); 1121 Metadata data = new Metadata(); 1122 1123 if (!native_getMetadata(update_only, apply_filter, reply)) { 1124 reply.recycle(); 1125 return null; 1126 } 1127 1128 // Metadata takes over the parcel, don't recycle it unless 1129 // there is an error. 1130 if (!data.parse(reply)) { 1131 reply.recycle(); 1132 return null; 1133 } 1134 return data; 1135 } 1136 1137 /** 1138 * Set a filter for the metadata update notification and update 1139 * retrieval. The caller provides 2 set of metadata keys, allowed 1140 * and blocked. The blocked set always takes precedence over the 1141 * allowed one. 1142 * Metadata.MATCH_ALL and Metadata.MATCH_NONE are 2 sets available as 1143 * shorthands to allow/block all or no metadata. 1144 * 1145 * By default, there is no filter set. 1146 * 1147 * @param allow Is the set of metadata the client is interested 1148 * in receiving new notifications for. 1149 * @param block Is the set of metadata the client is not interested 1150 * in receiving new notifications for. 1151 * @return The call status code. 1152 * 1153 // FIXME: unhide. 1154 * {@hide} 1155 */ 1156 public int setMetadataFilter(Set<Integer> allow, Set<Integer> block) { 1157 // Do our serialization manually instead of calling 1158 // Parcel.writeArray since the sets are made of the same type 1159 // we avoid paying the price of calling writeValue (used by 1160 // writeArray) which burns an extra int per element to encode 1161 // the type. 1162 Parcel request = newRequest(); 1163 1164 // The parcel starts already with an interface token. There 1165 // are 2 filters. Each one starts with a 4bytes number to 1166 // store the len followed by a number of int (4 bytes as well) 1167 // representing the metadata type. 1168 int capacity = request.dataSize() + 4 * (1 + allow.size() + 1 + block.size()); 1169 1170 if (request.dataCapacity() < capacity) { 1171 request.setDataCapacity(capacity); 1172 } 1173 1174 request.writeInt(allow.size()); 1175 for(Integer t: allow) { 1176 request.writeInt(t); 1177 } 1178 request.writeInt(block.size()); 1179 for(Integer t: block) { 1180 request.writeInt(t); 1181 } 1182 return native_setMetadataFilter(request); 1183 } 1184 1185 /** 1186 * Releases resources associated with this MediaPlayer object. 1187 * It is considered good practice to call this method when you're 1188 * done using the MediaPlayer. For instance, whenever the Activity 1189 * of an application is paused, this method should be invoked to 1190 * release the MediaPlayer object. In addition to unnecessary resources 1191 * (such as memory and instances of codecs) being hold, failure to 1192 * call this method immediately if a MediaPlayer object is no longer 1193 * needed may also lead to continuous battery consumption for mobile 1194 * devices, and playback failure if no multiple instances of the 1195 * same codec is supported on a device. 1196 */ 1197 public void release() { 1198 stayAwake(false); 1199 updateSurfaceScreenOn(); 1200 mOnPreparedListener = null; 1201 mOnBufferingUpdateListener = null; 1202 mOnCompletionListener = null; 1203 mOnSeekCompleteListener = null; 1204 mOnErrorListener = null; 1205 mOnInfoListener = null; 1206 mOnVideoSizeChangedListener = null; 1207 mOnTimedTextListener = null; 1208 _release(); 1209 } 1210 1211 private native void _release(); 1212 1213 /** 1214 * Resets the MediaPlayer to its uninitialized state. After calling 1215 * this method, you will have to initialize it again by setting the 1216 * data source and calling prepare(). 1217 */ 1218 public void reset() { 1219 stayAwake(false); 1220 _reset(); 1221 // make sure none of the listeners get called anymore 1222 mEventHandler.removeCallbacksAndMessages(null); 1223 } 1224 1225 private native void _reset(); 1226 1227 /** 1228 * Sets the audio stream type for this MediaPlayer. See {@link AudioManager} 1229 * for a list of stream types. Must call this method before prepare() or 1230 * prepareAsync() in order for the target stream type to become effective 1231 * thereafter. 1232 * 1233 * @param streamtype the audio stream type 1234 * @see android.media.AudioManager 1235 */ 1236 public native void setAudioStreamType(int streamtype); 1237 1238 /** 1239 * Sets the player to be looping or non-looping. 1240 * 1241 * @param looping whether to loop or not 1242 */ 1243 public native void setLooping(boolean looping); 1244 1245 /** 1246 * Checks whether the MediaPlayer is looping or non-looping. 1247 * 1248 * @return true if the MediaPlayer is currently looping, false otherwise 1249 */ 1250 public native boolean isLooping(); 1251 1252 /** 1253 * Sets the volume on this player. 1254 * This API is recommended for balancing the output of audio streams 1255 * within an application. Unless you are writing an application to 1256 * control user settings, this API should be used in preference to 1257 * {@link AudioManager#setStreamVolume(int, int, int)} which sets the volume of ALL streams of 1258 * a particular type. Note that the passed volume values are raw scalars. 1259 * UI controls should be scaled logarithmically. 1260 * 1261 * @param leftVolume left volume scalar 1262 * @param rightVolume right volume scalar 1263 */ 1264 public native void setVolume(float leftVolume, float rightVolume); 1265 1266 /** 1267 * Currently not implemented, returns null. 1268 * @deprecated 1269 * @hide 1270 */ 1271 public native Bitmap getFrameAt(int msec) throws IllegalStateException; 1272 1273 /** 1274 * Sets the audio session ID. 1275 * 1276 * @param sessionId the audio session ID. 1277 * The audio session ID is a system wide unique identifier for the audio stream played by 1278 * this MediaPlayer instance. 1279 * The primary use of the audio session ID is to associate audio effects to a particular 1280 * instance of MediaPlayer: if an audio session ID is provided when creating an audio effect, 1281 * this effect will be applied only to the audio content of media players within the same 1282 * audio session and not to the output mix. 1283 * When created, a MediaPlayer instance automatically generates its own audio session ID. 1284 * However, it is possible to force this player to be part of an already existing audio session 1285 * by calling this method. 1286 * This method must be called before one of the overloaded <code> setDataSource </code> methods. 1287 * @throws IllegalStateException if it is called in an invalid state 1288 */ 1289 public native void setAudioSessionId(int sessionId) throws IllegalArgumentException, IllegalStateException; 1290 1291 /** 1292 * Returns the audio session ID. 1293 * 1294 * @return the audio session ID. {@see #setAudioSessionId(int)} 1295 * Note that the audio session ID is 0 only if a problem occured when the MediaPlayer was contructed. 1296 */ 1297 public native int getAudioSessionId(); 1298 1299 /** 1300 * Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation 1301 * effect which can be applied on any sound source that directs a certain amount of its 1302 * energy to this effect. This amount is defined by setAuxEffectSendLevel(). 1303 * {@see #setAuxEffectSendLevel(float)}. 1304 * <p>After creating an auxiliary effect (e.g. 1305 * {@link android.media.audiofx.EnvironmentalReverb}), retrieve its ID with 1306 * {@link android.media.audiofx.AudioEffect#getId()} and use it when calling this method 1307 * to attach the player to the effect. 1308 * <p>To detach the effect from the player, call this method with a null effect id. 1309 * <p>This method must be called after one of the overloaded <code> setDataSource </code> 1310 * methods. 1311 * @param effectId system wide unique id of the effect to attach 1312 */ 1313 public native void attachAuxEffect(int effectId); 1314 1315 /* Do not change these values (starting with KEY_PARAMETER) without updating 1316 * their counterparts in include/media/mediaplayer.h! 1317 */ 1318 /* 1319 * Key used in setParameter method. 1320 * Indicates the index of the timed text track to be enabled/disabled. 1321 * The index includes both the in-band and out-of-band timed text. 1322 * The index should start from in-band text if any. Application can retrieve the number 1323 * of in-band text tracks by using MediaMetadataRetriever::extractMetadata(). 1324 * Note it might take a few hundred ms to scan an out-of-band text file 1325 * before displaying it. 1326 */ 1327 private static final int KEY_PARAMETER_TIMED_TEXT_TRACK_INDEX = 1000; 1328 /* 1329 * Key used in setParameter method. 1330 * Used to add out-of-band timed text source path. 1331 * Application can add multiple text sources by calling setParameter() with 1332 * KEY_PARAMETER_TIMED_TEXT_ADD_OUT_OF_BAND_SOURCE multiple times. 1333 */ 1334 private static final int KEY_PARAMETER_TIMED_TEXT_ADD_OUT_OF_BAND_SOURCE = 1001; 1335 1336 // There are currently no defined keys usable from Java with get*Parameter. 1337 // But if any keys are defined, the order must be kept in sync with include/media/mediaplayer.h. 1338 // private static final int KEY_PARAMETER_... = ...; 1339 1340 /** 1341 * Sets the parameter indicated by key. 1342 * @param key key indicates the parameter to be set. 1343 * @param value value of the parameter to be set. 1344 * @return true if the parameter is set successfully, false otherwise 1345 * {@hide} 1346 */ 1347 public native boolean setParameter(int key, Parcel value); 1348 1349 /** 1350 * Sets the parameter indicated by key. 1351 * @param key key indicates the parameter to be set. 1352 * @param value value of the parameter to be set. 1353 * @return true if the parameter is set successfully, false otherwise 1354 * {@hide} 1355 */ 1356 public boolean setParameter(int key, String value) { 1357 Parcel p = Parcel.obtain(); 1358 p.writeString(value); 1359 boolean ret = setParameter(key, p); 1360 p.recycle(); 1361 return ret; 1362 } 1363 1364 /** 1365 * Sets the parameter indicated by key. 1366 * @param key key indicates the parameter to be set. 1367 * @param value value of the parameter to be set. 1368 * @return true if the parameter is set successfully, false otherwise 1369 * {@hide} 1370 */ 1371 public boolean setParameter(int key, int value) { 1372 Parcel p = Parcel.obtain(); 1373 p.writeInt(value); 1374 boolean ret = setParameter(key, p); 1375 p.recycle(); 1376 return ret; 1377 } 1378 1379 /** 1380 * Gets the value of the parameter indicated by key. 1381 * @param key key indicates the parameter to get. 1382 * @param reply value of the parameter to get. 1383 */ 1384 private native void getParameter(int key, Parcel reply); 1385 1386 /** 1387 * Gets the value of the parameter indicated by key. 1388 * The caller is responsible for recycling the returned parcel. 1389 * @param key key indicates the parameter to get. 1390 * @return value of the parameter. 1391 * {@hide} 1392 */ 1393 public Parcel getParcelParameter(int key) { 1394 Parcel p = Parcel.obtain(); 1395 getParameter(key, p); 1396 return p; 1397 } 1398 1399 /** 1400 * Gets the value of the parameter indicated by key. 1401 * @param key key indicates the parameter to get. 1402 * @return value of the parameter. 1403 * {@hide} 1404 */ 1405 public String getStringParameter(int key) { 1406 Parcel p = Parcel.obtain(); 1407 getParameter(key, p); 1408 String ret = p.readString(); 1409 p.recycle(); 1410 return ret; 1411 } 1412 1413 /** 1414 * Gets the value of the parameter indicated by key. 1415 * @param key key indicates the parameter to get. 1416 * @return value of the parameter. 1417 * {@hide} 1418 */ 1419 public int getIntParameter(int key) { 1420 Parcel p = Parcel.obtain(); 1421 getParameter(key, p); 1422 int ret = p.readInt(); 1423 p.recycle(); 1424 return ret; 1425 } 1426 1427 /** 1428 * Sets the send level of the player to the attached auxiliary effect 1429 * {@see #attachAuxEffect(int)}. The level value range is 0 to 1.0. 1430 * <p>By default the send level is 0, so even if an effect is attached to the player 1431 * this method must be called for the effect to be applied. 1432 * <p>Note that the passed level value is a raw scalar. UI controls should be scaled 1433 * logarithmically: the gain applied by audio framework ranges from -72dB to 0dB, 1434 * so an appropriate conversion from linear UI input x to level is: 1435 * x == 0 -> level = 0 1436 * 0 < x <= R -> level = 10^(72*(x-R)/20/R) 1437 * @param level send level scalar 1438 */ 1439 public native void setAuxEffectSendLevel(float level); 1440 1441 /** 1442 * @param request Parcel destinated to the media player. The 1443 * Interface token must be set to the IMediaPlayer 1444 * one to be routed correctly through the system. 1445 * @param reply[out] Parcel that will contain the reply. 1446 * @return The status code. 1447 */ 1448 private native final int native_invoke(Parcel request, Parcel reply); 1449 1450 1451 /** 1452 * @param update_only If true fetch only the set of metadata that have 1453 * changed since the last invocation of getMetadata. 1454 * The set is built using the unfiltered 1455 * notifications the native player sent to the 1456 * MediaPlayerService during that period of 1457 * time. If false, all the metadatas are considered. 1458 * @param apply_filter If true, once the metadata set has been built based on 1459 * the value update_only, the current filter is applied. 1460 * @param reply[out] On return contains the serialized 1461 * metadata. Valid only if the call was successful. 1462 * @return The status code. 1463 */ 1464 private native final boolean native_getMetadata(boolean update_only, 1465 boolean apply_filter, 1466 Parcel reply); 1467 1468 /** 1469 * @param request Parcel with the 2 serialized lists of allowed 1470 * metadata types followed by the one to be 1471 * dropped. Each list starts with an integer 1472 * indicating the number of metadata type elements. 1473 * @return The status code. 1474 */ 1475 private native final int native_setMetadataFilter(Parcel request); 1476 1477 private static native final void native_init(); 1478 private native final void native_setup(Object mediaplayer_this); 1479 private native final void native_finalize(); 1480 1481 /** 1482 * @param index The index of the text track to be turned on. 1483 * @return true if the text track is enabled successfully. 1484 * {@hide} 1485 */ 1486 public boolean enableTimedTextTrackIndex(int index) { 1487 if (index < 0) { 1488 return false; 1489 } 1490 return setParameter(KEY_PARAMETER_TIMED_TEXT_TRACK_INDEX, index); 1491 } 1492 1493 /** 1494 * Enables the first timed text track if any. 1495 * @return true if the text track is enabled successfully 1496 * {@hide} 1497 */ 1498 public boolean enableTimedText() { 1499 return enableTimedTextTrackIndex(0); 1500 } 1501 1502 /** 1503 * Disables timed text display. 1504 * @return true if the text track is disabled successfully. 1505 * {@hide} 1506 */ 1507 public boolean disableTimedText() { 1508 return setParameter(KEY_PARAMETER_TIMED_TEXT_TRACK_INDEX, -1); 1509 } 1510 1511 /** 1512 * @param reply Parcel with audio/video duration info for battery 1513 tracking usage 1514 * @return The status code. 1515 * {@hide} 1516 */ 1517 public native static int native_pullBatteryData(Parcel reply); 1518 1519 @Override 1520 protected void finalize() { native_finalize(); } 1521 1522 /* Do not change these values without updating their counterparts 1523 * in include/media/mediaplayer.h! 1524 */ 1525 private static final int MEDIA_NOP = 0; // interface test message 1526 private static final int MEDIA_PREPARED = 1; 1527 private static final int MEDIA_PLAYBACK_COMPLETE = 2; 1528 private static final int MEDIA_BUFFERING_UPDATE = 3; 1529 private static final int MEDIA_SEEK_COMPLETE = 4; 1530 private static final int MEDIA_SET_VIDEO_SIZE = 5; 1531 private static final int MEDIA_TIMED_TEXT = 99; 1532 private static final int MEDIA_ERROR = 100; 1533 private static final int MEDIA_INFO = 200; 1534 1535 private class EventHandler extends Handler 1536 { 1537 private MediaPlayer mMediaPlayer; 1538 1539 public EventHandler(MediaPlayer mp, Looper looper) { 1540 super(looper); 1541 mMediaPlayer = mp; 1542 } 1543 1544 @Override 1545 public void handleMessage(Message msg) { 1546 if (mMediaPlayer.mNativeContext == 0) { 1547 Log.w(TAG, "mediaplayer went away with unhandled events"); 1548 return; 1549 } 1550 switch(msg.what) { 1551 case MEDIA_PREPARED: 1552 if (mOnPreparedListener != null) 1553 mOnPreparedListener.onPrepared(mMediaPlayer); 1554 return; 1555 1556 case MEDIA_PLAYBACK_COMPLETE: 1557 if (mOnCompletionListener != null) 1558 mOnCompletionListener.onCompletion(mMediaPlayer); 1559 stayAwake(false); 1560 return; 1561 1562 case MEDIA_BUFFERING_UPDATE: 1563 if (mOnBufferingUpdateListener != null) 1564 mOnBufferingUpdateListener.onBufferingUpdate(mMediaPlayer, msg.arg1); 1565 return; 1566 1567 case MEDIA_SEEK_COMPLETE: 1568 if (mOnSeekCompleteListener != null) 1569 mOnSeekCompleteListener.onSeekComplete(mMediaPlayer); 1570 return; 1571 1572 case MEDIA_SET_VIDEO_SIZE: 1573 if (mOnVideoSizeChangedListener != null) 1574 mOnVideoSizeChangedListener.onVideoSizeChanged(mMediaPlayer, msg.arg1, msg.arg2); 1575 return; 1576 1577 case MEDIA_ERROR: 1578 // For PV specific error values (msg.arg2) look in 1579 // opencore/pvmi/pvmf/include/pvmf_return_codes.h 1580 Log.e(TAG, "Error (" + msg.arg1 + "," + msg.arg2 + ")"); 1581 boolean error_was_handled = false; 1582 if (mOnErrorListener != null) { 1583 error_was_handled = mOnErrorListener.onError(mMediaPlayer, msg.arg1, msg.arg2); 1584 } 1585 if (mOnCompletionListener != null && ! error_was_handled) { 1586 mOnCompletionListener.onCompletion(mMediaPlayer); 1587 } 1588 stayAwake(false); 1589 return; 1590 1591 case MEDIA_INFO: 1592 if (msg.arg1 != MEDIA_INFO_VIDEO_TRACK_LAGGING) { 1593 Log.i(TAG, "Info (" + msg.arg1 + "," + msg.arg2 + ")"); 1594 } 1595 if (mOnInfoListener != null) { 1596 mOnInfoListener.onInfo(mMediaPlayer, msg.arg1, msg.arg2); 1597 } 1598 // No real default action so far. 1599 return; 1600 case MEDIA_TIMED_TEXT: 1601 if (mOnTimedTextListener != null) { 1602 if (msg.obj == null) { 1603 mOnTimedTextListener.onTimedText(mMediaPlayer, null); 1604 } else { 1605 if (msg.obj instanceof byte[]) { 1606 TimedText text = new TimedText((byte[])(msg.obj)); 1607 mOnTimedTextListener.onTimedText(mMediaPlayer, text); 1608 } 1609 } 1610 } 1611 return; 1612 1613 case MEDIA_NOP: // interface test message - ignore 1614 break; 1615 1616 default: 1617 Log.e(TAG, "Unknown message type " + msg.what); 1618 return; 1619 } 1620 } 1621 } 1622 1623 /** 1624 * Called from native code when an interesting event happens. This method 1625 * just uses the EventHandler system to post the event back to the main app thread. 1626 * We use a weak reference to the original MediaPlayer object so that the native 1627 * code is safe from the object disappearing from underneath it. (This is 1628 * the cookie passed to native_setup().) 1629 */ 1630 private static void postEventFromNative(Object mediaplayer_ref, 1631 int what, int arg1, int arg2, Object obj) 1632 { 1633 MediaPlayer mp = (MediaPlayer)((WeakReference)mediaplayer_ref).get(); 1634 if (mp == null) { 1635 return; 1636 } 1637 1638 if (mp.mEventHandler != null) { 1639 Message m = mp.mEventHandler.obtainMessage(what, arg1, arg2, obj); 1640 mp.mEventHandler.sendMessage(m); 1641 } 1642 } 1643 1644 /** 1645 * Interface definition for a callback to be invoked when the media 1646 * source is ready for playback. 1647 */ 1648 public interface OnPreparedListener 1649 { 1650 /** 1651 * Called when the media file is ready for playback. 1652 * 1653 * @param mp the MediaPlayer that is ready for playback 1654 */ 1655 void onPrepared(MediaPlayer mp); 1656 } 1657 1658 /** 1659 * Register a callback to be invoked when the media source is ready 1660 * for playback. 1661 * 1662 * @param listener the callback that will be run 1663 */ 1664 public void setOnPreparedListener(OnPreparedListener listener) 1665 { 1666 mOnPreparedListener = listener; 1667 } 1668 1669 private OnPreparedListener mOnPreparedListener; 1670 1671 /** 1672 * Interface definition for a callback to be invoked when playback of 1673 * a media source has completed. 1674 */ 1675 public interface OnCompletionListener 1676 { 1677 /** 1678 * Called when the end of a media source is reached during playback. 1679 * 1680 * @param mp the MediaPlayer that reached the end of the file 1681 */ 1682 void onCompletion(MediaPlayer mp); 1683 } 1684 1685 /** 1686 * Register a callback to be invoked when the end of a media source 1687 * has been reached during playback. 1688 * 1689 * @param listener the callback that will be run 1690 */ 1691 public void setOnCompletionListener(OnCompletionListener listener) 1692 { 1693 mOnCompletionListener = listener; 1694 } 1695 1696 private OnCompletionListener mOnCompletionListener; 1697 1698 /** 1699 * Interface definition of a callback to be invoked indicating buffering 1700 * status of a media resource being streamed over the network. 1701 */ 1702 public interface OnBufferingUpdateListener 1703 { 1704 /** 1705 * Called to update status in buffering a media stream received through 1706 * progressive HTTP download. The received buffering percentage 1707 * indicates how much of the content has been buffered or played. 1708 * For example a buffering update of 80 percent when half the content 1709 * has already been played indicates that the next 30 percent of the 1710 * content to play has been buffered. 1711 * 1712 * @param mp the MediaPlayer the update pertains to 1713 * @param percent the percentage (0-100) of the content 1714 * that has been buffered or played thus far 1715 */ 1716 void onBufferingUpdate(MediaPlayer mp, int percent); 1717 } 1718 1719 /** 1720 * Register a callback to be invoked when the status of a network 1721 * stream's buffer has changed. 1722 * 1723 * @param listener the callback that will be run. 1724 */ 1725 public void setOnBufferingUpdateListener(OnBufferingUpdateListener listener) 1726 { 1727 mOnBufferingUpdateListener = listener; 1728 } 1729 1730 private OnBufferingUpdateListener mOnBufferingUpdateListener; 1731 1732 /** 1733 * Interface definition of a callback to be invoked indicating 1734 * the completion of a seek operation. 1735 */ 1736 public interface OnSeekCompleteListener 1737 { 1738 /** 1739 * Called to indicate the completion of a seek operation. 1740 * 1741 * @param mp the MediaPlayer that issued the seek operation 1742 */ 1743 public void onSeekComplete(MediaPlayer mp); 1744 } 1745 1746 /** 1747 * Register a callback to be invoked when a seek operation has been 1748 * completed. 1749 * 1750 * @param listener the callback that will be run 1751 */ 1752 public void setOnSeekCompleteListener(OnSeekCompleteListener listener) 1753 { 1754 mOnSeekCompleteListener = listener; 1755 } 1756 1757 private OnSeekCompleteListener mOnSeekCompleteListener; 1758 1759 /** 1760 * Interface definition of a callback to be invoked when the 1761 * video size is first known or updated 1762 */ 1763 public interface OnVideoSizeChangedListener 1764 { 1765 /** 1766 * Called to indicate the video size 1767 * 1768 * @param mp the MediaPlayer associated with this callback 1769 * @param width the width of the video 1770 * @param height the height of the video 1771 */ 1772 public void onVideoSizeChanged(MediaPlayer mp, int width, int height); 1773 } 1774 1775 /** 1776 * Register a callback to be invoked when the video size is 1777 * known or updated. 1778 * 1779 * @param listener the callback that will be run 1780 */ 1781 public void setOnVideoSizeChangedListener(OnVideoSizeChangedListener listener) 1782 { 1783 mOnVideoSizeChangedListener = listener; 1784 } 1785 1786 private OnVideoSizeChangedListener mOnVideoSizeChangedListener; 1787 1788 /** 1789 * Interface definition of a callback to be invoked when a 1790 * timed text is available for display. 1791 * {@hide} 1792 */ 1793 public interface OnTimedTextListener 1794 { 1795 /** 1796 * Called to indicate an avaliable timed text 1797 * 1798 * @param mp the MediaPlayer associated with this callback 1799 * @param text the timed text sample which contains the text 1800 * needed to be displayed and the display format. 1801 * {@hide} 1802 */ 1803 public void onTimedText(MediaPlayer mp, TimedText text); 1804 } 1805 1806 /** 1807 * Register a callback to be invoked when a timed text is available 1808 * for display. 1809 * 1810 * @param listener the callback that will be run 1811 * {@hide} 1812 */ 1813 public void setOnTimedTextListener(OnTimedTextListener listener) 1814 { 1815 mOnTimedTextListener = listener; 1816 } 1817 1818 private OnTimedTextListener mOnTimedTextListener; 1819 1820 1821 /* Do not change these values without updating their counterparts 1822 * in include/media/mediaplayer.h! 1823 */ 1824 /** Unspecified media player error. 1825 * @see android.media.MediaPlayer.OnErrorListener 1826 */ 1827 public static final int MEDIA_ERROR_UNKNOWN = 1; 1828 1829 /** Media server died. In this case, the application must release the 1830 * MediaPlayer object and instantiate a new one. 1831 * @see android.media.MediaPlayer.OnErrorListener 1832 */ 1833 public static final int MEDIA_ERROR_SERVER_DIED = 100; 1834 1835 /** The video is streamed and its container is not valid for progressive 1836 * playback i.e the video's index (e.g moov atom) is not at the start of the 1837 * file. 1838 * @see android.media.MediaPlayer.OnErrorListener 1839 */ 1840 public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200; 1841 1842 /** 1843 * Interface definition of a callback to be invoked when there 1844 * has been an error during an asynchronous operation (other errors 1845 * will throw exceptions at method call time). 1846 */ 1847 public interface OnErrorListener 1848 { 1849 /** 1850 * Called to indicate an error. 1851 * 1852 * @param mp the MediaPlayer the error pertains to 1853 * @param what the type of error that has occurred: 1854 * <ul> 1855 * <li>{@link #MEDIA_ERROR_UNKNOWN} 1856 * <li>{@link #MEDIA_ERROR_SERVER_DIED} 1857 * </ul> 1858 * @param extra an extra code, specific to the error. Typically 1859 * implementation dependant. 1860 * @return True if the method handled the error, false if it didn't. 1861 * Returning false, or not having an OnErrorListener at all, will 1862 * cause the OnCompletionListener to be called. 1863 */ 1864 boolean onError(MediaPlayer mp, int what, int extra); 1865 } 1866 1867 /** 1868 * Register a callback to be invoked when an error has happened 1869 * during an asynchronous operation. 1870 * 1871 * @param listener the callback that will be run 1872 */ 1873 public void setOnErrorListener(OnErrorListener listener) 1874 { 1875 mOnErrorListener = listener; 1876 } 1877 1878 private OnErrorListener mOnErrorListener; 1879 1880 1881 /* Do not change these values without updating their counterparts 1882 * in include/media/mediaplayer.h! 1883 */ 1884 /** Unspecified media player info. 1885 * @see android.media.MediaPlayer.OnInfoListener 1886 */ 1887 public static final int MEDIA_INFO_UNKNOWN = 1; 1888 1889 /** The video is too complex for the decoder: it can't decode frames fast 1890 * enough. Possibly only the audio plays fine at this stage. 1891 * @see android.media.MediaPlayer.OnInfoListener 1892 */ 1893 public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING = 700; 1894 1895 /** MediaPlayer is temporarily pausing playback internally in order to 1896 * buffer more data. 1897 * @see android.media.MediaPlayer.OnInfoListener 1898 */ 1899 public static final int MEDIA_INFO_BUFFERING_START = 701; 1900 1901 /** MediaPlayer is resuming playback after filling buffers. 1902 * @see android.media.MediaPlayer.OnInfoListener 1903 */ 1904 public static final int MEDIA_INFO_BUFFERING_END = 702; 1905 1906 /** Bad interleaving means that a media has been improperly interleaved or 1907 * not interleaved at all, e.g has all the video samples first then all the 1908 * audio ones. Video is playing but a lot of disk seeks may be happening. 1909 * @see android.media.MediaPlayer.OnInfoListener 1910 */ 1911 public static final int MEDIA_INFO_BAD_INTERLEAVING = 800; 1912 1913 /** The media cannot be seeked (e.g live stream) 1914 * @see android.media.MediaPlayer.OnInfoListener 1915 */ 1916 public static final int MEDIA_INFO_NOT_SEEKABLE = 801; 1917 1918 /** A new set of metadata is available. 1919 * @see android.media.MediaPlayer.OnInfoListener 1920 */ 1921 public static final int MEDIA_INFO_METADATA_UPDATE = 802; 1922 1923 /** 1924 * Interface definition of a callback to be invoked to communicate some 1925 * info and/or warning about the media or its playback. 1926 */ 1927 public interface OnInfoListener 1928 { 1929 /** 1930 * Called to indicate an info or a warning. 1931 * 1932 * @param mp the MediaPlayer the info pertains to. 1933 * @param what the type of info or warning. 1934 * <ul> 1935 * <li>{@link #MEDIA_INFO_UNKNOWN} 1936 * <li>{@link #MEDIA_INFO_VIDEO_TRACK_LAGGING} 1937 * <li>{@link #MEDIA_INFO_BUFFERING_START} 1938 * <li>{@link #MEDIA_INFO_BUFFERING_END} 1939 * <li>{@link #MEDIA_INFO_BAD_INTERLEAVING} 1940 * <li>{@link #MEDIA_INFO_NOT_SEEKABLE} 1941 * <li>{@link #MEDIA_INFO_METADATA_UPDATE} 1942 * </ul> 1943 * @param extra an extra code, specific to the info. Typically 1944 * implementation dependant. 1945 * @return True if the method handled the info, false if it didn't. 1946 * Returning false, or not having an OnErrorListener at all, will 1947 * cause the info to be discarded. 1948 */ 1949 boolean onInfo(MediaPlayer mp, int what, int extra); 1950 } 1951 1952 /** 1953 * Register a callback to be invoked when an info/warning is available. 1954 * 1955 * @param listener the callback that will be run 1956 */ 1957 public void setOnInfoListener(OnInfoListener listener) 1958 { 1959 mOnInfoListener = listener; 1960 } 1961 1962 private OnInfoListener mOnInfoListener; 1963 1964} 1965