VideoCore

Interact with the built-in players (Denshi, Online Streaming) in Seanime.

VideoCore is the built-in video player used by the Denshi desktop app and the online streaming web player.

Permissions

playback permission is required

{
  //...
  "plugin": {
    "permissions": {
      "scopes": ["playback"]
    }
  }
}

Code methods

addEventListener

addEventListener(eventId, callback)

Registers a listener for playback events.

Parameters:

• eventId: String - The identifier of the event to listen for (e.g., "video-paused", "video-seeked", "video-loaded").

• callback: Function - The function to execute when the event triggers. Receives the event object.

Example:

ctx.videoCore.addEventListener("video-loaded", (event) => {
    console.log("Playback info received by video player", event)
})

ctx.videoCore.addEventListener("video-loaded-metadata", (event) => {
    console.log("Metadata loaded, initializing modules", event)
})

ctx.videoCore.addEventListener("video-can-play", (event) => {
    console.log("First frame is ready", event)
})

removeEventListener

removeEventListener(eventId)

Removes a previously registered event listener.

Parameters:

• eventId: String - The identifier of the event to remove.

Example:

ctx.videoCore.removeEventListener("video-paused")

playEpisodeFromPlaylist

playEpisodeFromPlaylist(which)

Instructs the media player to play a specific episode from the current playlist.

The playlist can be a custom playlist or the list of episodes for the current media being played.

Parameters:

• which: "previous" | "next" | string (The AniDB Episode ID)

Example:

ctx.videoCore.playEpisodeFromPlaylist("next")

pause

pause()

Pauses the current playback.

Example:

ctx.videoCore.pause()

resume

resume()

Resumes playback if it is currently paused.

Example:

ctx.videoCore.resume()

seek

seek(seconds)

Seeks the video by a relative amount of seconds.

Parameters:

• seconds: Number - The number of seconds to seek forward (positive) or backward (negative).

Example:

// Skip forward 10 seconds
ctx.videoCore.seek(10)

seekTo

seekTo(seconds)

Seeks to a specific timestamp in the video.

Parameters:

• seconds: Number - The absolute timestamp to seek to.

Example:

// Go to the 1-minute mark
ctx.videoCore.seekTo(60)

terminate

terminate()

Stops playback and terminates the media player instance.

Example:

ctx.videoCore.terminate()

setFullscreen

setFullscreen(fullscreen)

Toggles or sets the fullscreen state of the player.

Parameters:

• fullscreen: Boolean - true to enter fullscreen, false to exit.

Example:

ctx.videoCore.setFullscreen(true)

setPip

setPip(enabled)

Toggles or sets the Picture-in-Picture (PiP) state of the player.

Parameters:

• enabled: Boolean - true to enable PiP, false to disable.

Example:

ctx.videoCore.setPip(true)

showMessage

showMessage(message, duration)

Displays a temporary OSD message on the media player.

Parameters:

• message: String - The text to display.

• duration: Number - Duration in milliseconds, default is 2000.

Example:

ctx.videoCore.showMessage("Hello World", 2000)

getTextTracks

getTextTracks()

Asynchronously retrieves the list of available subtitle/caption tracks.

Example:

const tracks = ctx.videoCore.getTextTracks()
for(const track of tracks) {
    console.log(track.type) // "subtitles" or "captions"
    console.log(track.index)
}

setSubtitleTrack

setSubtitleTrack(trackNumber)

Selects a specific subtitle track.

Parameters:

• trackNumber: Number - The ID/index of the subtitle track to select.

Example:

ctx.videoCore.setSubtitleTrack(1)

setMediaCaptionTrack

setMediaCaptionTrack(trackIndex)

Selects a specific media caption track.

Parameters:

• trackIndex: Number - The index of the caption track to select.

Example:

ctx.videoCore.setMediaCaptionTrack(0)

addExternalSubtitleTrack

addExternalSubtitleTrack(track)

Adds an external subtitle file as a track and selects it.

If "Convert Soft Subs to ASS" is enabled, the track will be converted to ASS, else it will be converted to WebVTT.

Parameters:

• track: Object - A VideoSubtitleTrack object

Example:

ctx.videoCore.addExternalSubtitleTrack({
    url: "https://example.com/subs.ass",
    label: "English (ASS)",
    language: "en",
    type: "ass".
})

ctx.videoCore.addExternalSubtitleTrack({
    label: "English (VTT)",
    language: "eng",
    content: "WEBVTT\n\n00:00:00.000 --> 00:00:50.000\nHello World",
    type: "vtt",
})

setAudioTrack

setAudioTrack(trackNumber)

Selects a specific audio track.

Parameters:

• trackNumber: Number - The ID/index of the audio track to select.

Example:

ctx.videoCore.setAudioTrack(2)

getPlaybackStatus

getPlaybackStatus()

Synchronously retrieves the current status of the playback

Example:

const status = ctx.videoCore.getPlaybackStatus()
if (status.paused) {
    // ...
}

getPlaybackState

getPlaybackState()

Synchronously retrieves the comprehensive state object of the player.

Example:

const state = ctx.videoCore.getPlaybackState()
console.log(state.clientId, state.playerType, state.playbackInfo)

getCurrentMedia

getCurrentMedia()

Synchronously retrieves information about the media currently being played.

Example:

const media = ctx.videoCore.getCurrentMedia()
console.log(media.id)

getPlaylist

getPlaylist()

Asynchronously retrieves the current playlist.

Example:

const playlist = await ctx.videoCore.getPlaylist()
console.log(playlist.nextEpisode)

pullStatus

pullStatus()

Asynchronously forces a status update from the player and returns the result.

Example:

const status = await ctx.videoCore.pullStatus()

getCurrentPlaybackInfo

getCurrentPlaybackInfo()

Synchronously retrieves the current playback information

Example:

const info = ctx.videoCore.getCurrentPlaybackInfo()

getCurrentClientId

getCurrentClientId()

Synchronously retrieves the unique identifier of the connected client/player.

Returns: String

Example:

const clientId = ctx.videoCore.getCurrentClientId()

getCurrentPlayerType

getCurrentPlayerType()

Synchronously retrieves the type of player currently active (e.g., "native", "web").

Returns: String

Example:

const type = ctx.videoCore.getCurrentPlayerType()

getCurrentPlaybackType

getCurrentPlaybackType()

Synchronously retrieves the type of playback being performed (e.g., "torrent", "debrid", "file", "onlinestream").

Returns: String

Example:

const type = ctx.videoCore.getCurrentPlaybackType()

State Request Methods

The following methods are used to request specific state updates from the media player. These functions trigger an event listener response with the requested data.

sendGetFullscreen

sendGetFullscreen() Requests the current fullscreen state.

sendGetPip

sendGetPip() Requests the current Picture-in-Picture state.

sendGetAnime4K

sendGetAnime4K() Requests the current Anime4K configuration/state.

sendGetSubtitleTrack

sendGetSubtitleTrack() Requests the currently selected subtitle track.

sendGetAudioTrack

sendGetAudioTrack() Requests the currently selected audio track.

sendGetMediaCaptionTrack

sendGetMediaCaptionTrack() Requests the currently selected media caption track.

sendGetPlaybackState

sendGetPlaybackState() Requests the full playback state.