Skip to content

Most visited

Recently visited

navigation
Added in API level 1

MediaController

public class MediaController
extends FrameLayout

java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ android.widget.FrameLayout
         ↳ android.widget.MediaController


A view containing controls for a MediaPlayer. Typically contains the buttons like "Play/Pause", "Rewind", "Fast Forward" and a progress slider. It takes care of synchronizing the controls with the state of the MediaPlayer.

The way to use this class is to instantiate it programmatically. The MediaController will create a default set of controls and put them in a window floating above your application. Specifically, the controls will float above the view specified with setAnchorView(). The window will disappear if left idle for three seconds and reappear when the user touches the anchor view.

Functions like show() and hide() have no effect when MediaController is created in an xml layout. MediaController will hide and show the buttons according to these rules:

Summary

Nested classes

interface MediaController.MediaPlayerControl

 

Inherited XML attributes

From class android.widget.FrameLayout
From class android.view.ViewGroup
From class android.view.View

Inherited constants

From class android.view.ViewGroup
From class android.view.View

Inherited fields

From class android.view.View

Public constructors

MediaController(Context context, AttributeSet attrs)
MediaController(Context context, boolean useFastForward)
MediaController(Context context)

Public methods

boolean dispatchKeyEvent(KeyEvent event)

Dispatch a key event to the next view on the focus path.

CharSequence getAccessibilityClassName()

Return the class name of this object to be used for accessibility purposes.

void hide()

Remove the controller from the screen.

boolean isShowing()
void onFinishInflate()

Finalize inflating a view from XML.

boolean onTouchEvent(MotionEvent event)

Implement this method to handle touch screen motion events.

boolean onTrackballEvent(MotionEvent ev)

Implement this method to handle trackball motion events.

void setAnchorView(View view)

Set the view that acts as the anchor for the control view.

void setEnabled(boolean enabled)

Set the enabled state of this view.

void setMediaPlayer(MediaController.MediaPlayerControl player)
void setPrevNextListeners(View.OnClickListener next, View.OnClickListener prev)
void show(int timeout)

Show the controller on screen.

void show()

Show the controller on screen.

Inherited methods

From class android.widget.FrameLayout
From class android.view.ViewGroup
From class android.view.View
From class java.lang.Object
From interface android.view.ViewParent
From interface android.view.ViewManager
From interface android.graphics.drawable.Drawable.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.accessibility.AccessibilityEventSource

Public constructors

MediaController

Added in API level 1
MediaController (Context context, 
                AttributeSet attrs)

Parameters
context Context
attrs AttributeSet

MediaController

Added in API level 1
MediaController (Context context, 
                boolean useFastForward)

Parameters
context Context
useFastForward boolean

MediaController

Added in API level 1
MediaController (Context context)

Parameters
context Context

Public methods

dispatchKeyEvent

Added in API level 1
boolean dispatchKeyEvent (KeyEvent event)

Dispatch a key event to the next view on the focus path. This path runs from the top of the view tree down to the currently focused view. If this view has focus, it will dispatch to itself. Otherwise it will dispatch the next node down the focus path. This method also fires any key listeners.

Parameters
event KeyEvent: The key event to be dispatched.
Returns
boolean True if the event was handled, false otherwise.

getAccessibilityClassName

Added in API level 23
CharSequence getAccessibilityClassName ()

Return the class name of this object to be used for accessibility purposes. Subclasses should only override this if they are implementing something that should be seen as a completely new class of view when used by accessibility, unrelated to the class it is deriving from. This is used to fill in AccessibilityNodeInfo.setClassName.

Returns
CharSequence

hide

Added in API level 1
void hide ()

Remove the controller from the screen.

isShowing

Added in API level 1
boolean isShowing ()

Returns
boolean

onFinishInflate

Added in API level 1
void onFinishInflate ()

Finalize inflating a view from XML. This is called as the last phase of inflation, after all child views have been added.

Even if the subclass overrides onFinishInflate, they should always be sure to call the super method, so that we get called.

onTouchEvent

Added in API level 1
boolean onTouchEvent (MotionEvent event)

Implement this method to handle touch screen motion events.

If this method is used to detect click actions, it is recommended that the actions be performed by implementing and calling performClick(). This will ensure consistent system behavior, including:

  • obeying click sound preferences
  • dispatching OnClickListener calls
  • handling ACTION_CLICK when accessibility features are enabled

Parameters
event MotionEvent: The motion event.
Returns
boolean True if the event was handled, false otherwise.

onTrackballEvent

Added in API level 1
boolean onTrackballEvent (MotionEvent ev)

Implement this method to handle trackball motion events. The relative movement of the trackball since the last event can be retrieve with MotionEvent.getX() and MotionEvent.getY(). These are normalized so that a movement of 1 corresponds to the user pressing one DPAD key (so they will often be fractional values, representing the more fine-grained movement information available from a trackball).

Parameters
ev MotionEvent: The motion event.
Returns
boolean True if the event was handled, false otherwise.

setAnchorView

Added in API level 1
void setAnchorView (View view)

Set the view that acts as the anchor for the control view. This can for example be a VideoView, or your Activity's main view. When VideoView calls this method, it will use the VideoView's parent as the anchor.

Parameters
view View: The view to which to anchor the controller when it is visible.

setEnabled

Added in API level 1
void setEnabled (boolean enabled)

Set the enabled state of this view. The interpretation of the enabled state varies by subclass.

Parameters
enabled boolean: True if this view is enabled, false otherwise.

setMediaPlayer

Added in API level 1
void setMediaPlayer (MediaController.MediaPlayerControl player)

Parameters
player MediaController.MediaPlayerControl

setPrevNextListeners

Added in API level 1
void setPrevNextListeners (View.OnClickListener next, 
                View.OnClickListener prev)

Parameters
next View.OnClickListener
prev View.OnClickListener

show

Added in API level 1
void show (int timeout)

Show the controller on screen. It will go away automatically after 'timeout' milliseconds of inactivity.

Parameters
timeout int: The timeout in milliseconds. Use 0 to show the controller until hide() is called.

show

Added in API level 1
void show ()

Show the controller on screen. It will go away automatically after 3 seconds of inactivity.

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.