jellyfin-roku api docs

Module: VideoPlayerView

Source:

Methods

<static> ReportPlayback( [state])

Report playback to server

Parameters:
Name Type Argument Default Description
state string <optional>
 "update"
Source:
Returns:
Type
void

<static> bufferCheck(msg)

Check the the buffering has not hung

Parameters:
Name Type Description
msg dynamic
Source:
Returns:
Type
void

<static> checkTimeToDisplayNextEpisode()

Checks if we need to display the Next Episode button

Source:
Returns:
Type
void

<static> getCurrentChapterIndex()

getCurrentChapterIndex: Finds current chapter index

Source:
Returns:
  • indicating index of current chapter within chapter data or 0 if chapter lookup fails
Type
integer

<static> handleChapterListAction()

handleChapterListAction: Handles action to show chapter list

Source:
Returns:
Type
void

<static> handleChapterSkipAction(action)

handleChapterSkipAction: Handles user command to skip chapters in playing video

Parameters:
Name Type Description
action string
Source:
Returns:
Type
void

<static> handleHideAction(resume)

handleHideAction: Handles action to hide pause menu

Parameters:
Name Type Description
resume boolean

controls whether or not to resume video playback when sub is called
Source:
Returns:
Type
void

<static> handleShowSubtitleMenuAction()

handleShowSubtitleMenuAction: Handles action to show subtitle selection menu

Source:
Returns:
Type
void

<static> handleShowVideoInfoPopupAction()

handleShowVideoInfoPopupAction: Handles action to show video info popup

Source:
Returns:
Type
void

<static> handleVideoPlayPauseAction()

handleVideoPlayPauseAction: Handles action to either play or pause the video content

Source:
Returns:
Type
void

<static> hideNextEpisodeButton()

Runs hide Next Episode button animation and sets focus back to video

Source:
Returns:
Type
void

<static> init()

Source:
Returns:
Type
void

<static> loadCaption()

Set caption url to server subtitle track

Source:
Returns:
Type
void

<static> onAllowCaptionsChange()

Only setup caption items if captions are allowed

Source:
Returns:
Type
void

<static> onContentChange()

Event handler for when video content field changes

Source:
Returns:
Type
void

<static> onKeyEvent(key, press)

Parameters:
Name Type Description
key string
press boolean
Source:
Returns:
Type
boolean

<static> onNextEpisodeDataLoaded()

Source:
Returns:
Type
void

<static> onPauseMenuAction()

onPauseMenuAction: Process action events from pause menu to their respective handlers

Source:
Returns:
Type
void

<static> onPlaybackErrorButtonSelected(msg)

Parameters:
Name Type Description
msg dynamic
Source:
Returns:
Type
void

<static> onPlaybackErrorDialogClosed(msg)

Parameters:
Name Type Description
msg dynamic
Source:
Returns:
Type
void

<static> onPositionChanged()

When Video Player state changes

Source:
Returns:
Type
void

<static> onState(msg)

When Video Player state changes

Parameters:
Name Type Description
msg dynamic
Source:
Returns:
Type
void

<static> onSubtitleChange()

Event handler for when selectedSubtitle changes

Source:
Returns:
Type
void

<static> onVideoContentLoaded()

Source:
Returns:
Type
void

<static> populateChapterMenu()

populateChapterMenu: ' Parse chapter data from API and appeand to chapter list menu

Source:
Returns:
Type
void

<static> showNextEpisodeButton()

Runs Next Episode button animation and sets focus to button

Source:
Returns:
Type
void

<static> showPlaybackErrorDialog(errorMessage)

Parameters:
Name Type Description
errorMessage string
Source:
Returns:
Type
void

<static> toggleCaption()

Toggles visibility of custom subtitles and sets captionTask's player state

Source:
Returns:
Type
void

<static> updateCaption()

Removes old subtitle lines and adds new subtitle lines

Source:
Returns:
Type
void

<static> updateCount()

Update count down text

Source:
Returns:
Type
void