npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@goboss/roku-video-player-sdk

v2.0.1

Published

GoBOSS player SDK for Roku — HLS/DASH playback with ads, DRM, subtitles, chapters, QR and analytics.

Readme

@goboss/roku-video-player-sdk

GoBOSS video player SDK for Roku (BrightScript / SceneGraph) — HLS/DASH streaming with server-side ads, subtitles, chapters/key moments, scrub previews, QR overlays, and the GoBOSS analytics pipeline.

Heads up: BossPlayer is tenant-gated. It validates a GoBOSS player key against the GoBOSS API before playback starts. You need a player key from the GoBOSS dashboard to use it.

Features

  • Adaptive streaming — HLS and DASH with quality selection
  • DRM — Widevine / PlayReady (FairPlay configs are accepted and ignored on Roku)
  • TV controls — play/pause, seek, quality, subtitles, chapters, audio, next-episode card
  • Server-side ads (SSAI) — MediaTailor ad-break tracking and skip-ad flow
  • QR overlays — QR encoding off the render thread
  • Casting — Roku as receiver (deep-link launch args: contentId / mediaType)
  • Analytics — session start/heartbeat/end plus control-surface events
  • Series / episodic — Skip Intro, skip segments, Next Episode auto-advance, episode tray

Installation

Published as @goboss/roku-video-player-sdk.

Component scripts use fixed pkg:/source/boss/… paths. From the root of your Roku channel, run one command to merge the SDK code and assets into the channel:

npx --yes --package @goboss/roku-video-player-sdk goboss-roku-install

To install into another channel directory, pass -- --target <channel-root> after the command. The -- keeps npm from consuming the installer option. The installer requires that directory to contain a Roku manifest; it merges SDK image/font assets without removing other channel files. Requires Node.js 16.7 or newer.

The installer adds the SDK files only. Continue with the Quick start below to add <BossPlayer> and configure your GoBOSS player key. The UI loads the bundled spinner/control images, Inter fonts, and Noto Sans subtitle fonts from the channel package.

The published package is minified: comments are removed and internal names are shortened. BossPlayer fields, component names, and pkg:/ paths are unchanged. Playback still requires a GoBOSS player key. Minification makes the shipped scripts harder to read and risky to edit by hand; a later install overwrites source/boss and components/boss.

Changelog / compatibility

1.0.19

Host-visible changes in this drop (after 1.0.12). 1.0.13 was published on npm as an intermediate patch; this line continues at 1.0.19 (do not renumber to 1.0.13).

New / changed

  • Mute control — bottom-tray mute/unmute icon (mute.png / unmute.png) on content chrome only — hidden during trailers and ads (product). Host field muted sets initial state and can be written live (e.g. autoplay-muted trailers); viewer toggles update muted and emit playerDidChangeMute { isMuted } plus /events mute. Choice persists across startPlayback (new src / next episode / Retry) on the same player instance.
  • Mute analytics contract (breaking for mute counters) — Viewer mute/unmute is eventType: "mute" with { isMuted } on analyticsEvent and POST /events. It is not reported as volume_change. Host writes to player.muted apply audio only — no mute / volume_change analytics and no playerDidChangeMute. volume_change remains for volume level changes (setVolume) only. Dashboards that counted mute via volume_change must switch to mute.
  • Stall + cadence extras (analytics owners) — stall fires once per stuck stretch (re-arms when the playhead moves), not every ~5 s while stuck — downstream stall counts will drop vs earlier Roku builds. heartbeat, watch_progress, and quartile milestones now include the same rendition / bitrate / volume / speed extras as play/pause.
  • isTrailer — host boolean for trailer chrome (center + seekbar only) and forces ads off for the session, overriding /init features.ads. Stamps isTrailer on host analyticsEvent only (GoBOSS /session/start does not store it yet). Trailer Back emits playerDidDismiss like normal Back. Startup errors emit the appropriate playback/network error delegate followed by playerDidDismiss with reason: "playbackError", errorKind, and message. The startup watchdog allows active buffering up to 15 seconds; stream loading still waits for successful /init. See Feature toggles and Ads.
  • Multi-format fallback — unsupported Stereo/Dolby/4K/Atmos switches fall back to Stereo (sources[0]), not the previously selected format. Cover is released when already on sources[0] so a fatal error is not stuck under the start cover.
  • seriesTitle chrome — when set, top chrome shows series title on the primary line and demotes title (episode) to the muted second line (was episode-only on the primary line). Still used for the Episodes tray heading.
  • Playback speed menu label — default rate is labeled 1x (not Normal), matching the 0.5x…2x ladder.

Still applies from earlier 1.0.x

The useHlsPrep and defaultKeyMomentsOpen XML fields remain removed. Remove any host assignments to player.useHlsPrep or player.defaultKeyMomentsOpen; there is no replacement for the initial-open option. Key moments remain available through the player UI when enableKeyMoments is enabled. HLS plays through Roku's native URL path.

For token-gated AES HLS, configure both drmConfig.authToken and drmConfig.authHeader. The SDK applies the named header through ContentNode.HttpHeaders and Video.ifHttpAgent for playlist, segment, and key requests. Ensure the CDN's AES key endpoint accepts that header. The removed HLS-prep rewrite used to add token= to #EXT-X-KEY URI attributes; no longer rewrites key URIs. Do not rely on the manifest query being copied to absolute key URLs.

Chrome restyle (host-visible)

Transport chrome remains a visible restyle for every host app:

  • Resting glass disc on every control (back, center play/±10, bottom icons), not only behind play/pause during ads.
  • Brighter focus fill and brighter seekbar track.
  • Seekbar raised ~52 px on 1080p (origin moved from y≈980 to y≈928) so larger focus discs clear the knob.

Quick start

<children>
    <BossPlayer id="player" />
</children>
player = m.top.findNode("player")
player.playerKey = "bsp_your_player_key"   ' from the GoBOSS dashboard (required)
player.title = "Episode 3"
player.videoId = "s01e03"
player.startTime = 0

' Assign src last — it starts the entitlement check and the load.
player.src = "https://cdn.example.com/master.m3u8"
player.setFocus(true)

The player shows a loading state while it validates the player key, then starts playback. If the key is missing, empty, or rejected, it shows an error state instead.

BossPlayer fields

Full field docs also live inline in components/boss/BossPlayer.xml.

Required

| Field | Type | Description | |---|---|---| | playerKey | string | GoBOSS player key — gates playback & features | | src | string | HLS (.m3u8) or DASH (.mpd) URL. Assign last — starts load |

Identity / theming

| Field | Type | Default | Description | |---|---|---|---| | title | string | — | Title shown in the player UI | | videoId | string | — | Stable content ID for analytics (derived from src when empty) | | watermark | string | — | Watermark text stamped on the video (BossPlayer.watermark only — drmConfig.watermarkText is not applied yet) | | themeColor | color | 0x6366F1FF | General UI accent (settings menus). Seekbar / chapter focus use playerThemeColor; ad chrome uses adAccentColor | | adAccentColor | string | — | Overrides init config.adAccentColor when set. Init null → #ead81a | | playerThemeColor | string | — | Overrides init config.playerThemeColor when set. Init null → #ffffff | | chapterTitle | string | — | Overrides init config.chapterMarkers.title. Default "Key Moments" | | enableThumbnailPreview | boolean | true | Overrides init config.thumbnailPreview. Scrubber preview on/off |

Networking / resume

| Field | Type | Default | Description | |---|---|---|---| | headers | assocarray | — | Extra HTTP headers for manifest/segment fetches { name: value } | | tagPlaybackUrls | boolean | true | Stamp sid / vid (and token= when drmConfig.authToken is set) onto playback URLs. Set false if the CDN rejects those query params. | | startTime | float | 0 | Resume / deep-link start on the content clock (seconds). Mapped to stream PlayStart after ad breaks load. Exit-during-ad: pass playerDidDismiss.dismissedAt to resume at the start of that break | | watchProgressIntervalMs | integer | 30000 | Watch-progress analytics cadence |

Content metadata

| Field | Type | Description | |---|---|---| | chapters | array | Chapter markers | | keyMoments | array | Key-moment markers | | subtitles | array | Sidecar subtitle tracks | | subtitleStyle | assocarray | { size, background, color } for SDK-drawn cues only — see below | | thumbnails | assocarray | Scrub preview config | | drmConfig | assocarray | License URLs plus authToken / authHeader. Playback headers need both — see DRM / token-gated playback. |

subtitleStyle.size is "small" | "medium" | "large" (Roku system font ladder).
subtitleStyle.background is "none" | "dim" | "solid".
color is "#rrggbb" or "0xRRGGBBAA".
Only sidecar VTT/SRT cues are styled; manifest / CEA-608/708 tracks use the viewer’s system caption settings.

Ads (AWS MediaTailor SSAI)

| Field | Type | Default | Description | |---|---|---|---| | adTrackingUrl | string | — | Ad-break tracking URL (avails / non-linear) | | overlayAdUrl | string | — | Overlay ad tracking URL (defaults to adTrackingUrl) | | enableSkipAd | boolean | false | Fallback skippability when avails lack per-ad metadata | | skipAdAfterSeconds | float | 5 | Seconds before the fallback Skip Ad button activates |

SSAI polling, overlay updates, and ad chrome (chip / QR / skip) run only when /init returns ads: true. A host adTrackingUrl alone is not enough — tenants whose plan excludes ads do not fire beacons or show SSAI UI.

Exception — isTrailer / enableAds: when the host sets isTrailer = true or enableAds = false, the SDK forces ads off for that session even if /init returned ads: true (no chip / QR / skip / seekbar markers; derived adTrackingUrl is cleared). Use isTrailer only for real trailers (it also simplifies chrome). Use enableAds = false for paid / signed-in catalog titles that must not show free-browse SSAI UI. Prefer a backend content-type or init feature when available. Each host analyticsEvent includes isTrailer for channel telemetry. GoBOSS analytics does not persist this flag yet (sdkSessionStartSchema strips unknown keys), so there is no server-side ad-fill exclusion until analytics-service adds schema + model + reporting filter.

Content clock / resume: seekbar and playerDidUpdateCurrentTime use content duration/time (ads excluded from the movie clock). Completed mid-roll markers disappear. Rewind into a watched break skips it (no full re-play). Exit during an ad: playerDidDismiss reports dismissedAt at that break’s content cue and exitedDuringAdBreak: true — restore via startTime to resume at the start of that break. See docs/Ad-Integration-QA.md and docs/SSAI-Host-Guidelines.md.

Pre-roll + mid-roll regression fixture: feed the following tracking response through BossParseAvails. MediaTailor's zeroed clocks and mid-roll pod clock use ISO-8601 durations:

{
  "avails": [
    {
      "startTimeInSeconds": 0,
      "startTime": "PT0S",
      "durationInSeconds": 30,
      "ads": [{ "startTimeInSeconds": 0, "startTime": "PT0S", "durationInSeconds": 30 }]
    },
    {
      "startTimeInSeconds": 0,
      "startTime": "PT0S",
      "durationInSeconds": 30,
      "ads": [{ "startTimeInSeconds": 0, "startTime": "PT10M30S", "durationInSeconds": 30 }]
    }
  ]
}

Expected: two distinct breaks at stream times 0–30 and 630–660, with content times 0 and 600. The pre-roll remains a pre-roll (the first-play gate waits for its ad chrome); the mid-roll cue does not overlap it or shift content time by an extra 30 seconds. Verify the pre-roll badge / Skip / CTA and mid-roll seekbar marker in playback. Negative case: when both avail and pod clocks are zero, an HLS cue at 630 seconds alone must not move that avail from time 0.

Clock parsing cases: "PT10M30S" resolves to 630, "PT0S" resolves to 0, and a full ISO timestamp such as "2026-10-27T18:17:47Z" is rejected as a stream offset.

Avail withdrawal check: after a non-empty snapshot, send an explicit empty "avails": [] response. Pending adbreak-avail-* records and their markers should be removed; active/completed breaks remain. An empty first response should keep the existing discovery wait in place while MediaTailor continues deciding the initial pods.

Entitlement features (/init)

After a valid player key, /init feature flags overwrite the host enable* defaults (except quality, which always stays on):

| API key | Effect on Roku | |---|---| | subtitles | enableSubtitles | | chapterMarkers | enableKeyMoments (only false disables) | | skipSegments | Gates Skip Intro / skipSegments chips (must be true) | | playbackSpeed | enablePlaybackSpeed | | multipleAudio | allowMultipleAudio | | multipleResolution | Ignored — quality menu always available | | ads | Gates SSAI polling / overlay UI (see above). Overridden off when host isTrailer is true or enableAds is false | | chromecast | Ignored — phone/web sender flag. Roku is the cast receiver via deep-link launch args (BossCasting / startTime); there is no Chromecast sender API on the platform |

Init config chrome

Same GoBOSS /init config contract as the web player. Host string props override when non-empty. Roku ignores fullscreen, orientation, and aspectRatio (always fullscreen TV surface).

| Config key | Effect on Roku | |---|---| | adAccentColor | Ad badge / progress / cue markers / Skip Ad outline (null → #ead81a) | | playerThemeColor | Content seekbar fill + chapter focus (null → #ffffff) | | chapterMarkers.title | Key Moments panel heading | | keyMomentsTray / keyMomentsPosition | Tray side: "right" | "bottom" (also read from chapterMarkers). Host field overrides when set | | thumbnailPreview | Scrubber thumbnail preview on/off (default true) |

Series / episodic

| Field | Type | Default | Description | |---|---|---|---| | skipSegments | array | — | Skippable segments { title, startTime, endTime } (seconds or "HH:MM:SS") | | introStartTime | float | -1 | Content-relative intro start (seconds) | | introEndTime | float | -1 | Content-relative intro end — Skip Intro seeks here | | hasNextEpisode | boolean | false | Whether another episode is available | | outroStartTime | float | -1 | Content-relative outro start — reveals Next Episode card | | nextEpisodeLabel | string | "Next Episode" | Label on the Next Episode card | | nextEpisodeAutoAdvanceSeconds | float | 5 | Countdown before auto-advance (≤0 = no auto-advance) | | nextEpisodeThumbnailUrl | string | — | Thumbnail on the Next Episode card | | episodes | array | — | Episode tray rows { episodeId, title, src, thumbnail?, description? } | | currentEpisodeId | string | — | Currently playing episode id | | seriesTitle | string | — | Series name. When non-empty: top chrome primary line = series, muted second line = title (episode); also the Episodes tray heading. When empty, chrome shows title alone |

Times are content-relative (original episode timeline), so they stay correct with spliced ad breaks.
skipSegments takes precedence over introStartTime / introEndTime.
Use startTime / endTime for segment bounds (end is a BrightScript keyword).

Feature toggles / tray

| Field | Type | Default | Description | |---|---|---|---| | isTrailer | boolean | false | Trailer mode: simplified chrome (center + seekbar; no bottom icons / duration — mute included in the hidden row) and forces ads off for the session, overriding /init features.ads. Host-owned — set only for real trailers. If src remains empty for 0.5 s, the player sets exitRequested; assigning a non-empty source before then cancels the exit, so hosts may pulse src = "" before a replacement URL. Set isTrailer before src. Host analyticsEvent includes isTrailer; GoBOSS /session/start does not persist it yet | | enableAds | boolean | true | Host SSAI gate. false forces ads off for the session (chrome / markers / polling), overriding /init features.ads, without trailer chrome. Use for paid / signed-in catalog titles | | muted | boolean | false | Start muted / host mute control. Mute icon is content-only (not trailers/ads) — set this for muted autoplay trailers. Viewer toggles update this field and fire mute analytics + playerDidChangeMute; host writes do not. Survives new src, next episode, and Retry on the same player | | enableKeyMoments | boolean | true | Show key moments. Set false to hide the chapters control | | enableSubtitles | boolean | true | Show subtitle menu | | enableQuality | boolean | true | Show quality menu | | enablePlaybackSpeed | boolean | true | Show Settings → Playback Speed (0.5x…2x; default labeled 1x, not Normal). Roku may not apply variable rate to all streams | | allowMultipleAudio | boolean | true | Show audio-track menu | | enableSources | boolean | true | When sources.length > 1, expose format entries under Settings → Quality | | sources | array | — | Multi-format streams { label, url, key? } (e.g. Stereo / Dolby / 4K / Atmos). Unsupported switches fall back to Stereo (sources[0]), not the previously selected format | | activeSourceIndex | integer | 0 | Currently selected sources index | | keyMomentsTray | string | — | Placement: "right" | "bottom". Empty uses /init config.keyMomentsTray or config.keyMomentsPosition, then "right" | | chaptersDisplayMode | string | — | Alias for keyMomentsTray ("right" | "bottom"). Empty defers the same way |

keyMomentsTray / chaptersDisplayMode no longer honor "none" or "false" — those values resolve to "right", matching web (right | bottom only). The chapters control is offered whenever enableKeyMoments is true and there is at least one moment. Hosts that used keyMomentsTray = "none" to hide key moments should set enableKeyMoments = false (or pass empty keyMoments / chapters) instead.

Host control

| Field | Type | Default | Description | |---|---|---|---| | control | string | "none" | Write "play", "pause", or "stop" to drive playback; resets to "none" |

Setting visible = false only hides the player and releases focus; it does not stop playback or end the analytics session. Use control = "stop" when the host intends to stop playback (for example, on player exit). Showing the player again preserves the active session.

Output fields (observe these)

BrightScript cannot pass closures across SceneGraph boundaries, so callbacks are observable fields.

| Field | Type | Description | |---|---|---| | delegateEvent | assocarray | { event, args } — lifecycle / UI delegate stream | | analyticsEvent | assocarray | Every analytics event for a host telemetry sink | | nextEpisodeRequested | boolean | true when Next Episode is selected or countdown fires | | episodeSelected | assocarray | { episode, index } from the Episodes tray | | exitRequested | boolean | true when the viewer backs out or a trailer URL remains empty for 0.5 s | | sourceSelected | assocarray | { index, label, url, key?, source } when the viewer (or fallback) picks a format | | loadedKeyMoments | array | Key moments once parsed from the manifest |

delegateEvent names

playerDidStartPlaying, playerDidResumePlaying, playerDidPause, playerDidFinishPlaying, playerDidDismiss, playerDidStartSeeking, playerDidFinishSeeking, playerDidUpdateCurrentTime, playerDidStartBuffering, playerDidFinishBuffering, playerDidChangeQuality, playerDidChangeSubtitle, playerDidDisableSubtitle, playerDidChangeMute, playerDidChangeAudioTrack, playerDidChangePlaybackSpeed, playerDidChangeSource, playerDidSelectKeyMoment, playerDidEncounterPlaybackError, playerDidEncounterNetworkError.

playerDidChangeMute args: { isMuted } (boolean). playerDidChangeSource args: { fromSource, toSource, index }.

player.observeField("delegateEvent", "onPlayerDelegate")
player.observeField("analyticsEvent", "onPlayerAnalytics")
player.observeField("nextEpisodeRequested", "onNextEpisode")
player.observeField("exitRequested", "onPlayerExit")

sub onPlayerDelegate()
    ev = m.player.delegateEvent
    if ev = invalid then return
    print "delegate: "; ev.event
end sub

Skip Intro / Next Episode (series)

player.playerKey = "bsp_..."
player.introStartTime = 0
player.introEndTime = 78                 ' Skip Intro shows 0s–78s, seeks to 78s
player.hasNextEpisode = true
player.outroStartTime = 1230             ' Next Episode card appears at 1230s
player.nextEpisodeLabel = "S2 · E5"
player.nextEpisodeAutoAdvanceSeconds = 5
player.src = "https://cdn.example.com/episode-04.m3u8"

player.observeField("nextEpisodeRequested", "onNextEpisode")
sub onNextEpisode()
    if m.player.nextEpisodeRequested = true then loadNextEpisode()
end sub

DRM / token-gated playback

Playback/manifest auth and license POSTs share drmConfig, but they do not share the same header rule. DemoChannel already copies authHeader from the sample — hosts that token-gate a CDN or playlist need the same recipe.

player.drmConfig = {
    authToken: "your-token"
    authHeader: "x-api-key"            ' required for playlist / segment headers (web parity)
    widevineLicenseUrl: "https://..."
    playreadyLicenseUrl: "https://..."
    fairplayLicenseUrl: "https://..."   ' accepted for shared configs; ignored on Roku
}
player.tagPlaybackUrls = true          ' default — stamp sid/vid (+ token=) on playback URLs

Roku selects Widevine, then PlayReady. A FairPlay-only config logs a warning rather than failing silently.

Playback / manifest headers (breaking, web parity): getRequestHeaders emits an auth header only when both authToken and authHeader are set (<authHeader>: <authToken>). Previously a non-empty authToken always produced Authorization: Bearer <token> on playlist and segment fetches. Token-gating a CDN with Bearer alone now sends no auth header and typically 403s. Set drmConfig.authHeader to your CDN header name ("x-api-key", or "Authorization" if the edge still expects that name).

License POSTs still Bearer-default: when authToken is set and authHeader is empty, loadStream applies Authorization: Bearer … via ContentNode DrmHttpHeaders and Video.drmHttpAgent. If authHeader is set, license requests use that named header instead (raw token, no Bearer prefix). Widevine serviceCert is optional and left unset until you have a certificate.

tagPlaybackUrls (default true) appends analytics sid / vid and, when authToken is present, token= on the URL handed to the Video node and SDK fetches. Set false if the CDN rejects those query parameters.

Note: drmConfig.watermarkText and drmConfig.allowedDomains are accepted on BossDrm but are not applied by BossPlayer yet — use BossPlayer.watermark for on-screen text; domain allowlisting does not fail-close. Omit them from partner configs until wired.

Analytics

Every player analytics event is also emitted on analyticsEvent:

player.observeField("analyticsEvent", "onAnalytics")

sub onAnalytics()
    ev = m.player.analyticsEvent
    if ev <> invalid then print ev.eventType; " "; ev
end sub

The SDK also posts session traffic (/session/start, /session/heartbeat, /session/end) and the GoBOSS control-surface /events vocabulary.

Cadences

| Event / API | Driven by | Default | |---|---|---| | heartbeat → POST /session/heartbeat | /init → heartbeatIntervalSeconds (clamped 10–300) | 30 s of content play (pauses, ads, seeks, buffering do not count). Payload extras: rendition, bitrate, volume, speed | | watch_progress + streaming_time | watchProgressIntervalMs host field | 30000 ms wall clock while content is playing. Same extras as heartbeat | | Quartiles (first_quartile …) | Internal 5 s poll | Once per milestone. Same extras as heartbeat | | stall | Internal 5 s poll | Once per stall (latched until playhead advances) — not every ~5 s while stuck. Same extras. Stall event counts drop vs older Roku SDKs that re-fired each poll |

streaming_time is not the heartbeat. Init only controls /session/heartbeat.

/events subset

Lifecycle per watch: POST /init → POST /session/start (client sessionId) → /events with that sessionId → POST /session/end on finish/exit/src swap. A next-episode (or any new src) ends the prior session, mints a new sessionId, and runs /init + /session/start again.

Posted after /session/start succeeds: play, pause, seek, quality_change, buffering_start / buffering_end, speed_change, subtitle_change / subtitle_disable, audio_track_change, key_moments, fast_forward / fast_backward, mute.

Mute vs volume: Viewer tray mute posts mute with { isMuted: true|false }. Host player.muted = … does not post analytics or playerDidChangeMute. Do not treat volume_change as mute — that event is only for volume level changes and still reaches hosts via analyticsEvent (not /events).

Subtitle language: subtitle_change sends a display name when known (en → English, ta → Tamil, …); unknown codes stay as-is.

Errors: player_error / network_error send string code + message (API schema). Integer codes are rejected by the backend. After a successful /init, errors are queued behind /session/start so CMS receives them with a real sessionId. They only POST ungated when entitlement never unlocked (e.g. invalid key).

Everything else (ended, complete, quartiles, stall, volume_change, watch_progress, ad breaks, …) reaches the host via analyticsEvent and/or the session endpoints only.

Remote controls

| Remote | Action | |---|---| | OK / Play | Play / Pause. OK on Mute toggles mute (playerDidChangeMute) | | ← / → | Move focus. When the seekbar is focused, seek ±10 seconds instead | | Back | Exit player (exitRequested + playerDidDismiss) — same on trailers | | Up / Down | Move focus across controls / menus |

Left and Right change the playhead only while the seekbar is focused. On Play, the ±10 second icons, Settings, and every other control they only move focus. OK on the ±10 second icons still seeks.

Package layout

source/boss/         plain BrightScript modules (no SceneGraph dependency)
components/boss/     SceneGraph components and Task nodes
images/              spinner + controls/*.png (required at pkg:/images/…)
fonts/               Inter-*.ttf, NotoSansTamil-Regular.ttf (required at pkg:/fonts/…)

Requirements

  • Minimum Roku OS 11.0 (continue for / continue while)
  • A valid GoBOSS player key from the GoBOSS dashboard

This package never ships a player key. Pass player.playerKey from your channel (demo keys belong in host / .env config only — keep production keys out of the SDK).

Publishing

npm publish from this folder minifies source/ and components/ into the tarball, then restores the readable tree. build/minify-map.json maps each shortened function name and minified line back to this repo for crash logs. If a pack is interrupted, run npm run pack:restore.

License

MIT © GoBOSS