Documentation

API Reference

Reference for Sopplayer playback, source, volume, captions, themes, fullscreen, PiP and lifecycle APIs.

Constructor

const player = new Sopplayer(target, options);

Playback

MethodWhat it does
play()Starts playback.
pause()Pauses playback.
togglePlay()Toggles play/pause.
seek(seconds)Seeks to a clamped time.
forward(seconds)Seeks forward.
rewind(seconds)Seeks backward.

Media and presentation

MethodWhat it does
setVolume(0..1)Sets volume.
setMuted(boolean)Sets mute state.
setSpeed(rate)Sets playback speed.
setSource(url,type?)Changes media source safely.
setPoster(url)Changes poster safely.
setTrack(index)Selects a text track.
setTheme(name)Switches the visual skin.
toggleFullscreen()Toggles fullscreen.
togglePip()Toggles Picture-in-Picture.
destroy()Teardown and restore native video.

Events

Subscribe with player.on(event, callback). Common events include ready, play, pause, timeupdate, volumechange, ratechange, fullscreenchange, pipchange, trackchange and error.