Module: VideoPlayerView

Source: components/video/VideoPlayerView.bs, line 1

Methods

(static) ReportPlayback(stateopt) → {void}

Report playback to server

Parameters:

Name	Type	Attributes	Default	Description
`state`	string	<optional>	"update"

Source: components/video/VideoPlayerView.bs, line 230

Returns:

Type:: void

(static) availSubtitleTrackIdx(tracknameToFind) → {integer}

availSubtitleTrackIdx: Returns Roku's index for requested subtitle track

Parameters:

Name	Type	Description
`tracknameToFind`	string	TrackName for subtitle we're looking to match

Source: components/video/VideoPlayerView.bs, line 256

Returns:

indicating Roku's index for requested subtitle track. Returns -1 if not found

Type:: integer

(static) bufferCheck(msg) → {void}

Check the the buffering has not hung

Parameters:

Name	Type	Description
`msg`	dynamic

Source: components/video/VideoPlayerView.bs, line 239

Returns:

Type:: void

(static) checkTimeToDisplayNextEpisode() → {void}

Checks if we need to display the Next Episode button

Source: components/video/VideoPlayerView.bs, line 205

Returns:

Type:: void

(static) getCurrentChapterIndex() → {integer}

getCurrentChapterIndex: Finds current chapter index

Source: components/video/VideoPlayerView.bs, line 44

Returns:

indicating index of current chapter within chapter data or 0 if chapter lookup fails

Type:: integer

(static) handleChapterListAction() → {void}

handleChapterListAction: Handles action to show chapter list

Source: components/video/VideoPlayerView.bs, line 35

Returns:

Type:: void

(static) handleChapterSkipAction(action) → {void}

handleChapterSkipAction: Handles user command to skip chapters in playing video

Parameters:

Name	Type	Description
`action`	string

Source: components/video/VideoPlayerView.bs, line 17

Returns:

Type:: void

(static) handleHideAction(resume) → {void}

handleHideAction: Handles action to hide OSD menu

Parameters:

Name	Type	Description
`resume`	boolean	controls whether or not to resume video playback when sub is called

Source: components/video/VideoPlayerView.bs, line 27

Returns:

Type:: void

(static) handleShowAudioMenuAction() → {void}

handleShowAudioMenuAction: Handles action to show audio selection menu

Source: components/video/VideoPlayerView.bs, line 68

Returns:

Type:: void

(static) handleShowSubtitleMenuAction() → {void}

handleShowSubtitleMenuAction: Handles action to show subtitle selection menu

Source: components/video/VideoPlayerView.bs, line 60

Returns:

Type:: void

(static) handleShowVideoInfoPopupAction() → {void}

handleShowVideoInfoPopupAction: Handles action to show video info popup

Source: components/video/VideoPlayerView.bs, line 76

Returns:

Type:: void

(static) handleVideoPlayPauseAction() → {void}

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

Source: components/video/VideoPlayerView.bs, line 52

Returns:

Type:: void

(static) hideNextEpisodeButton() → {void}

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

Source: components/video/VideoPlayerView.bs, line 198

Returns:

Type:: void

(static) init() → {void}

Source: components/video/VideoPlayerView.bs, line 8

Returns:

Type:: void

(static) loadCaption() → {void}

Set caption url to server subtitle track

Source: components/video/VideoPlayerView.bs, line 98

Returns:

Type:: void

(static) onAllowCaptionsChange() → {void}

Only setup caption items if captions are allowed

Source: components/video/VideoPlayerView.bs, line 91

Returns:

Type:: void

(static) onAudioIndexChange() → {void}

Event handler for when audioIndex changes

Source: components/video/VideoPlayerView.bs, line 126

Returns:

Type:: void

(static) onContentChange() → {void}

Event handler for when video content field changes

Source: components/video/VideoPlayerView.bs, line 168

Returns:

Type:: void

(static) onKeyEvent(key, press) → {boolean}

Parameters:

Name	Type	Description
`key`	string
`press`	boolean

Source: components/video/VideoPlayerView.bs, line 264

Returns:

Type:: boolean

(static) onNextEpisodeDataLoaded() → {void}

Source: components/video/VideoPlayerView.bs, line 174

Returns:

Type:: void

(static) onOSDAction() → {void}

onOSDAction: Process action events from OSD to their respective handlers

Source: components/video/VideoPlayerView.bs, line 84

Returns:

Type:: void

(static) onPlaybackErrorButtonSelected(msg) → {void}

Parameters:

Name	Type	Description
`msg`	dynamic

Source: components/video/VideoPlayerView.bs, line 140

Returns:

Type:: void

(static) onPlaybackErrorDialogClosed(msg) → {void}

Parameters:

Name	Type	Description
`msg`	dynamic

Source: components/video/VideoPlayerView.bs, line 133

Returns:

Type:: void

(static) onPositionChanged() → {void}

When Video Player state changes

Source: components/video/VideoPlayerView.bs, line 212

Returns:

Type:: void

(static) onState(msg) → {void}

When Video Player state changes

Parameters:

Name	Type	Description
`msg`	dynamic

Source: components/video/VideoPlayerView.bs, line 221

Returns:

Type:: void

(static) onSubtitleChange() → {void}

Event handler for when selectedSubtitle changes

Source: components/video/VideoPlayerView.bs, line 119

Returns:

Type:: void

(static) onVideoContentLoaded() → {void}

Source: components/video/VideoPlayerView.bs, line 153

Returns:

Type:: void

(static) populateChapterMenu() → {void}

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

Source: components/video/VideoPlayerView.bs, line 161

Returns:

Type:: void

(static) showNextEpisodeButton() → {void}

Runs Next Episode button animation and sets focus to button

Source: components/video/VideoPlayerView.bs, line 182

Returns:

Type:: void

(static) showPlaybackErrorDialog(errorMessage) → {void}

Parameters:

Name	Type	Description
`errorMessage`	string

Source: components/video/VideoPlayerView.bs, line 147

Returns:

Type:: void

(static) stateAllowsOSD() → {boolean}

stateAllowsOSD: Check if current video state allows showing the OSD

Source: components/video/VideoPlayerView.bs, line 247

Returns:

indicating if video state allows the OSD to show

Type:: boolean

(static) toggleCaption() → {void}

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

Source: components/video/VideoPlayerView.bs, line 105

Returns:

Type:: void

(static) updateCaption() → {void}

Removes old subtitle lines and adds new subtitle lines

Source: components/video/VideoPlayerView.bs, line 112

Returns:

Type:: void

(static) updateCount() → {void}

Update count down text

Source: components/video/VideoPlayerView.bs, line 190

Returns:

Type:: void