DefaultControlDispatcher (ExoPlayer library)

java.lang.Object
- com.google.android.exoplayer2.DefaultControlDispatcher

All Implemented Interfaces:: ControlDispatcher

public class DefaultControlDispatcher
extends Object
implements ControlDispatcher

Default ControlDispatcher.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_FAST_FORWARD_MS`	The default fast forward increment, in milliseconds.
`static int`	`DEFAULT_REWIND_MS`	The default rewind increment, in milliseconds.

Constructor Summary

Constructors
Constructor	Description
`DefaultControlDispatcher()`	Creates an instance.
`DefaultControlDispatcher(long fastForwardIncrementMs, long rewindIncrementMs)`	Creates an instance with the given increments.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`dispatchFastForward(Player player)`	Dispatches a fast forward operation.
`boolean`	`dispatchNext(Player player)`	Dispatches a `Player.next()` operation.
`boolean`	`dispatchPrepare(Player player)`	Dispatches a `Player.prepare()` operation.
`boolean`	`dispatchPrevious(Player player)`	Dispatches a `Player.previous()` operation.
`boolean`	`dispatchRewind(Player player)`	Dispatches a rewind operation.
`boolean`	`dispatchSeekTo(Player player, int windowIndex, long positionMs)`	Dispatches a `Player.seekTo(int, long)` operation.
`boolean`	`dispatchSetPlaybackParameters(Player player, PlaybackParameters playbackParameters)`	Dispatches a `Player.setPlaybackParameters(PlaybackParameters)` operation.
`boolean`	`dispatchSetPlayWhenReady(Player player, boolean playWhenReady)`	Dispatches a `Player.setPlayWhenReady(boolean)` operation.
`boolean`	`dispatchSetRepeatMode(Player player, int repeatMode)`	Dispatches a `Player.setRepeatMode(int)` operation.
`boolean`	`dispatchSetShuffleModeEnabled(Player player, boolean shuffleModeEnabled)`	Dispatches a `Player.setShuffleModeEnabled(boolean)` operation.
`boolean`	`dispatchStop(Player player, boolean reset)`	Dispatches a `Player.stop()` operation.
`long`	`getFastForwardIncrementMs()`	Returns the fast forward increment in milliseconds.
`long`	`getRewindIncrementMs()`	Returns the rewind increment in milliseconds.
`boolean`	`isFastForwardEnabled()`	Returns `true` if fast forward is enabled, `false` otherwise.
`boolean`	`isRewindEnabled()`	Returns `true` if rewind is enabled, `false` otherwise.
`void`	`setFastForwardIncrementMs(long fastForwardMs)`	Deprecated. Create a new instance instead and pass the new instance to the UI component.
`void`	`setRewindIncrementMs(long rewindMs)`	Deprecated. Create a new instance instead and pass the new instance to the UI component.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_FAST_FORWARD_MS
```
public static final int DEFAULT_FAST_FORWARD_MS
```
    The default fast forward increment, in milliseconds.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_REWIND_MS
```
public static final int DEFAULT_REWIND_MS
```
    The default rewind increment, in milliseconds.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DefaultControlDispatcher
```
public DefaultControlDispatcher()
```
    Creates an instance.
  - DefaultControlDispatcher
```
public DefaultControlDispatcher(long fastForwardIncrementMs,
                                long rewindIncrementMs)
```
    Creates an instance with the given increments.
    
    Parameters:
    
    fastForwardIncrementMs - The fast forward increment in milliseconds. A non-positive value disables the fast forward operation.
    
    rewindIncrementMs - The rewind increment in milliseconds. A non-positive value disables the rewind operation.
- Method Detail
  - dispatchPrepare
```
public boolean dispatchPrepare(Player player)
```
    Description copied from interface: ControlDispatcher
    
    Dispatches a Player.prepare() operation.
    
    Specified by:
    
    dispatchPrepare in interface ControlDispatcher
    
    Parameters:
    
    player - The Player to which the operation should be dispatched.
    
    Returns:
    
    True if the operation was dispatched. False if suppressed.
  - dispatchSetPlayWhenReady
```
public boolean dispatchSetPlayWhenReady(Player player,
                                        boolean playWhenReady)
```
    Description copied from interface: ControlDispatcher
    
    Dispatches a Player.setPlayWhenReady(boolean) operation.
    
    Specified by:
    
    dispatchSetPlayWhenReady in interface ControlDispatcher
    
    Parameters:
    
    player - The Player to which the operation should be dispatched.
    
    playWhenReady - Whether playback should proceed when ready.
    
    Returns:
    
    True if the operation was dispatched. False if suppressed.
  - dispatchSeekTo
```
public boolean dispatchSeekTo(Player player,
                              int windowIndex,
                              long positionMs)
```
    Description copied from interface: ControlDispatcher
    
    Dispatches a Player.seekTo(int, long) operation.
    
    Specified by:
    
    dispatchSeekTo in interface ControlDispatcher
    
    Parameters:
    
    player - The Player to which the operation should be dispatched.
    
    windowIndex - The index of the window.
    
    positionMs - The seek position in the specified window, or C.TIME_UNSET to seek to the window's default position.
    
    Returns:
    
    True if the operation was dispatched. False if suppressed.
  - dispatchPrevious
```
public boolean dispatchPrevious(Player player)
```
    Description copied from interface: ControlDispatcher
    
    Dispatches a Player.previous() operation.
    
    Specified by:
    
    dispatchPrevious in interface ControlDispatcher
    
    Parameters:
    
    player - The Player to which the operation should be dispatched.
    
    Returns:
    
    True if the operation was dispatched. False if suppressed.
  - dispatchNext
```
public boolean dispatchNext(Player player)
```
    Description copied from interface: ControlDispatcher
    
    Dispatches a Player.next() operation.
    
    Specified by:
    
    dispatchNext in interface ControlDispatcher
    
    Parameters:
    
    player - The Player to which the operation should be dispatched.
    
    Returns:
    
    True if the operation was dispatched. False if suppressed.
  - dispatchRewind
```
public boolean dispatchRewind(Player player)
```
    Description copied from interface: ControlDispatcher
    
    Dispatches a rewind operation.
    
    Specified by:
    
    dispatchRewind in interface ControlDispatcher
    
    Parameters:
    
    player - The Player to which the operation should be dispatched.
    
    Returns:
    
    True if the operation was dispatched. False if suppressed.
  - dispatchFastForward
```
public boolean dispatchFastForward(Player player)
```
    Description copied from interface: ControlDispatcher
    
    Dispatches a fast forward operation.
    
    Specified by:
    
    dispatchFastForward in interface ControlDispatcher
    
    Parameters:
    
    player - The Player to which the operation should be dispatched.
    
    Returns:
    
    True if the operation was dispatched. False if suppressed.
  - dispatchSetRepeatMode
```
public boolean dispatchSetRepeatMode(Player player,
                                     @RepeatMode
                                     int repeatMode)
```
    Description copied from interface: ControlDispatcher
    
    Dispatches a Player.setRepeatMode(int) operation.
    
    Specified by:
    
    dispatchSetRepeatMode in interface ControlDispatcher
    
    Parameters:
    
    player - The Player to which the operation should be dispatched.
    
    repeatMode - The repeat mode.
    
    Returns:
    
    True if the operation was dispatched. False if suppressed.
  - dispatchSetShuffleModeEnabled
```
public boolean dispatchSetShuffleModeEnabled(Player player,
                                             boolean shuffleModeEnabled)
```
    Description copied from interface: ControlDispatcher
    
    Dispatches a Player.setShuffleModeEnabled(boolean) operation.
    
    Specified by:
    
    dispatchSetShuffleModeEnabled in interface ControlDispatcher
    
    Parameters:
    
    player - The Player to which the operation should be dispatched.
    
    shuffleModeEnabled - Whether shuffling is enabled.
    
    Returns:
    
    True if the operation was dispatched. False if suppressed.
  - dispatchStop
```
public boolean dispatchStop(Player player,
                            boolean reset)
```
    Description copied from interface: ControlDispatcher
    
    Dispatches a Player.stop() operation.
    
    Specified by:
    
    dispatchStop in interface ControlDispatcher
    
    Parameters:
    
    player - The Player to which the operation should be dispatched.
    
    reset - Whether the player should be reset.
    
    Returns:
    
    True if the operation was dispatched. False if suppressed.
  - dispatchSetPlaybackParameters
```
public boolean dispatchSetPlaybackParameters(Player player,
                                             PlaybackParameters playbackParameters)
```
    Description copied from interface: ControlDispatcher
    
    Dispatches a Player.setPlaybackParameters(PlaybackParameters) operation.
    
    Specified by:
    
    dispatchSetPlaybackParameters in interface ControlDispatcher
    
    Parameters:
    
    player - The Player to which the operation should be dispatched.
    
    playbackParameters - The playback parameters.
    
    Returns:
    
    True if the operation was dispatched. False if suppressed.
  - isRewindEnabled
```
public boolean isRewindEnabled()
```
    Description copied from interface: ControlDispatcher
    
    Returns true if rewind is enabled, false otherwise.
    
    Specified by:
    
    isRewindEnabled in interface ControlDispatcher
  - isFastForwardEnabled
```
public boolean isFastForwardEnabled()
```
    Description copied from interface: ControlDispatcher
    
    Returns true if fast forward is enabled, false otherwise.
    
    Specified by:
    
    isFastForwardEnabled in interface ControlDispatcher
  - getRewindIncrementMs
```
public long getRewindIncrementMs()
```
    Returns the rewind increment in milliseconds.
  - getFastForwardIncrementMs
```
public long getFastForwardIncrementMs()
```
    Returns the fast forward increment in milliseconds.
  - setRewindIncrementMs
```
@Deprecated
public void setRewindIncrementMs(long rewindMs)
```
    Deprecated.
    Create a new instance instead and pass the new instance to the UI component. This makes sure the UI gets updated and is in sync with the new values.
  - setFastForwardIncrementMs
```
@Deprecated
public void setFastForwardIncrementMs(long fastForwardMs)
```
    Deprecated.
    Create a new instance instead and pass the new instance to the UI component. This makes sure the UI gets updated and is in sync with the new values.

Class DefaultControlDispatcher

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FAST_FORWARD_MS

DEFAULT_REWIND_MS

Constructor Detail

DefaultControlDispatcher

DefaultControlDispatcher

Method Detail

dispatchPrepare

dispatchSetPlayWhenReady

dispatchSeekTo

dispatchPrevious

dispatchNext

dispatchRewind

dispatchFastForward

dispatchSetRepeatMode

dispatchSetShuffleModeEnabled

dispatchStop

dispatchSetPlaybackParameters

isRewindEnabled

isFastForwardEnabled

getRewindIncrementMs

getFastForwardIncrementMs

setRewindIncrementMs

setFastForwardIncrementMs