Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-jw-player`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/jw-player/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Install

bun add @capgo/capacitor-jw-player
bunx cap sync

Import

import { JwPlayer } from '@capgo/capacitor-jw-player';

API Overview

`initialize`

Initialize the JW Player

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.initialize({} as { licenseKey: string; playerUrl?: string });

`play`

Play a video

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.play({} as { mediaUrl: string; mediaType: 'video' | 'playlist'; autostart?: boolean });

`pause`

Pause the currently playing media

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.pause();

`resume`

Resume the currently paused media

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.resume();

`stop`

Stop the currently playing media

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.stop();

`seekTo`

Seek to a specific position in the currently playing media

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.seekTo({} as { time: number });

`setVolume`

Set the volume level

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.setVolume({} as { volume: number });

`getPosition`

Get the current position in the media

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.getPosition();

`getState`

Get the current player state

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.getState();

`setSpeed`

Set the playback speed

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.setSpeed({} as { speed: number });

`setPlaylistIndex`

Set the current item in the playlist by index

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.setPlaylistIndex({} as { index: number });

`loadPlaylist`

Load a playlist

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.loadPlaylist({} as { playlistUrl: string });

`loadPlaylistWithItems`

Load a playlist with items

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.loadPlaylistWithItems({} as { playlist: any[] });

`getAudioTracks`

Get available audio tracks

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.getAudioTracks();

`getCurrentAudioTrack`

Get the current audio track

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.getCurrentAudioTrack();

`setCurrentAudioTrack`

Set the current audio track

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.setCurrentAudioTrack({} as { index: number });

`getCaptions`

Get the available captions/subtitles

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.getCaptions();

`getCurrentCaptions`

Get the current captions/subtitles track

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.getCurrentCaptions();

`setCurrentCaptions`

Set the current captions/subtitles track

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.setCurrentCaptions({} as { index: number });

`currentPlaylist`

Get the current playlist

import { JwPlayer } from '@capgo/capacitor-jw-player';

await JwPlayer.currentPlaylist();

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

If you are using Getting Started to plan dashboard and API operations, connect it with Using @capgo/capacitor-jw-player for the native capability in Using @capgo/capacitor-jw-player, 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.