Skip to content
Capgo - Live Updates for Capacitor Apps Capgo

Getting Started

Install

Section titled “Install”
Terminal window
bun add @capgo/capacitor-media-session
bunx cap sync

Import

Section titled “Import”
import { MediaSession } from '@capgo/capacitor-media-session';

API Overview

Section titled “API Overview”

setMetadata

Section titled “setMetadata”

Sets metadata of the currently playing media.

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


await MediaSession.setMetadata({} as MetadataOptions);

setPlaybackState

Section titled “setPlaybackState”

Updates the playback state of the media session.

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


await MediaSession.setPlaybackState({} as PlaybackStateOptions);

setActionHandler

Section titled “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

Section titled “setPositionState”

Updates position state for the active media session.

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


await MediaSession.setPositionState({} as PositionStateOptions);

Type Reference

Section titled “Type Reference”

MetadataOptions

Section titled “MetadataOptions”
export interface MetadataOptions {
  album?: string;
  artist?: string;
  artwork?: MediaImage[];
  title?: string;
}

PlaybackStateOptions

Section titled “PlaybackStateOptions”
export interface PlaybackStateOptions {
  playbackState: MediaSessionPlaybackState;
}

ActionHandlerOptions

Section titled “ActionHandlerOptions”
export interface ActionHandlerOptions {
  action: MediaSessionAction;
}

ActionHandler

Section titled “ActionHandler”
export type ActionHandler = (details: ActionDetails) => void;

PositionStateOptions

Section titled “PositionStateOptions”
export interface PositionStateOptions {
  duration?: number;
  playbackRate?: number;
  position?: number;
}

MediaImage

Section titled “MediaImage”
export interface MediaImage {
  src: string;
  sizes?: string;
  type?: string;
}

MediaSessionPlaybackState

Section titled “MediaSessionPlaybackState”
export type MediaSessionPlaybackState = 'none' | 'paused' | 'playing';

MediaSessionAction

Section titled “MediaSessionAction”
export type MediaSessionAction =
  | 'play'
  | 'pause'
  | 'seekbackward'
  | 'seekforward'
  | 'previoustrack'
  | 'nexttrack'
  | 'seekto'
  | 'stop';

Source Of Truth

Section titled “Source Of Truth”

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Keep going from Getting Started

Section titled “Keep going from Getting Started”

If you are using Getting Started to plan dashboard and API operations, connect it with Using @capgo/capacitor-media-session for the native capability in Using @capgo/capacitor-media-session, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, API Keys for the implementation detail in API Keys, and Devices for the implementation detail in Devices.