Skip to main content

Media Keys Behaviorv4.0.221

This document is about the behavior when a user:

  • Presses the Play/Pause (⏯️) or Previous track (⏪) button on their keyboard
  • Uses other controls such as Chromes built-in controls next to the user avatar to control the playback

These behaviors are controlled by the browserMediaControlsBehavior prop.
The underlying Web API used is the Media Session API.

Modes​

prevent-media-session (default)​

tsx
import {Player} from '@remotion/player';
 
export const MyComp: React.FC = () => {
  return (
    <Player
      browserMediaControlsBehavior={{
        mode: 'prevent-media-session',
      }}
      {...otherProps}
    />
  );
};
tsx
import {Player} from '@remotion/player';
 
export const MyComp: React.FC = () => {
  return (
    <Player
      browserMediaControlsBehavior={{
        mode: 'prevent-media-session',
      }}
      {...otherProps}
    />
  );
};

In this mode, Remotion will not act on the user's media keys, but map any keybord action to a no-op.
This prevents that the Player is paused but the audio tags get resumed by pressing the Play/Pause button on the keyboard, which was a problem prior to Remotion v4.0.221.

register-media-session​

tsx
import {Player} from '@remotion/player';
 
export const MyComp: React.FC = () => {
  return (
    <Player
      browserMediaControlsBehavior={{
        mode: 'register-media-session',
      }}
      {...otherProps}
    />
  );
};
tsx
import {Player} from '@remotion/player';
 
export const MyComp: React.FC = () => {
  return (
    <Player
      browserMediaControlsBehavior={{
        mode: 'register-media-session',
      }}
      {...otherProps}
    />
  );
};

In this mode, Remotion will use the Media Session API to register handlers:

  • When the user presses the Play/Pause button on the keyboard
    • Toggle the Remotion Player's state
  • When the user presses the Previous track button on the keyboard
    • Seek to the beginning of the video
  • When the user presses the Fast Forward button on the keyboard
    • Seek 10 seconds forward
  • When the user presses the Rewind button on the keyboard
    • Seek 10 seconds backward

Also, Remotion will react to seeking events and inform the device about the current playback position and duration.

do-nothing​

tsx
import {Player} from '@remotion/player';
 
export const MyComp: React.FC = () => {
  return (
    <Player
      browserMediaControlsBehavior={{
        mode: 'do-nothing',
      }}
      {...otherProps}
    />
  );
};
tsx
import {Player} from '@remotion/player';
 
export const MyComp: React.FC = () => {
  return (
    <Player
      browserMediaControlsBehavior={{
        mode: 'do-nothing',
      }}
      {...otherProps}
    />
  );
};

Reverts to the behavior prior to Remotion v4.0.221.
Remotion will not react to any media keys, leaving the browser to handle the media keys.
This leads to the problem that the user can resume any media tag by pressing the Play/Pause button on the keyboard, without the Remotion Player also resuming.

When using multiple <Player>'s​

Remotion's register-media-session handler is supposed to only work with 1 Player mounted.
It is not defined which Player reacts to the media keys.

Whe working with multiple Players, set one to do-nothing mode and the other to register-media-session mode to explicitly set the Media Keys for only 1 Player.

If you want all Players to react to the media keys, you need to use do-nothing mode and implement this behavior yourself with the Player API.

In the Remotion Studio​

The behavior is set to register-media-session as of v4.0.221 and previously it behaved like do-nothing.