Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-media-session
Tutorial
by github.com/Cap-go

Media Session

Control media playback from lock screen and notification center

Downloads/week

11.5k

GitHub Stars

5

Guide

Tutorial on Media Session

Using @capgo/capacitor-media-session

Capacitor plugin to expose media session controls of the device.

Install

bun add @capgo/capacitor-media-session
bunx cap sync

What This Plugin Exposes

  • setMetadata - Sets metadata of the currently playing media.
  • setPlaybackState - Updates the playback state of the media session.
  • setActionHandler - Registers a handler for a media session action.
  • setPositionState - Updates position state for the active media session.

Example Usage

setMetadata

Sets metadata of the currently playing media.

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setMetadata({} as MetadataOptions);

setPlaybackState

Updates the playback state of the media session.

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setPlaybackState({} as PlaybackStateOptions);

setActionHandler

Registers a handler for a media session action.

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setActionHandler({} as ActionHandlerOptions, {} as ActionHandler | null);

setPositionState

Updates position state for the active media session.

import { MediaSession } from '@capgo/capacitor-media-session';

await MediaSession.setPositionState({} as PositionStateOptions);

Full Reference