Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@playkit-js/playkit-js-smartswitch

kaltura46AGPL-3.00.2.6

  • playkit-js-smartSwitch

kaltura, NPAW, QOE, QOS, player, playkit-js, html5 player

readme

PlayKit JS SmartSwitch - SmartSwitch plugin for the [PlayKit JS Player]

  • playkit-js-smartSwitch

Build Status code style: prettier

Kaltura Player CDN Balancer JS plugin for NPAW Smart Switch

The playkit-smartswitch plugin is built upon Kaltura Player and Youbora CDN Balancer solution.

NPAN Referance:

cdn-balancer

js-cdn-balancer-integration

Plugin Flow

The Kaltura Player triggers an API call towards the Youbora smart-switch service with the given playback URL, the API will return an ordered list of CDNs. Then the Kaltura Player smart-switch plugin will pick the first CDN and will use that CDN new playback url for the playback.

Error Handling

SmartSwitch errors are handled internally by the plugin and playback will start with the original playback url

Registering to Events

TBD

Plugin Config

  • Make sure your player id is configured to bundle the playkit-smartswitch: "playkit-smartswitch":"{latest}"

default config

"smartswitch": {
    "accountCode": "",
    "application": "default",
    "responseTimeoutSec": 10,
    "optionalParams": {},
    "domainUrl": "https://api.gbnpaw.com",
    "followRedirects": false
  }

Example: "playkit-smartswitch":"0.2.0"

Example - (optionalParams below are for example purpose only)

"plugins": { 
     "smartswitch": {
        "domainUrl": "https://api.gbnpaw.com"
        "accountCode": "YOUR_ACCOUNT", // Replace with your YOUBORA account.
        "application": "KLTR test",
        "responseTimeoutSec": 15,
        "followRedirects": true,
         "optionalParams": {
          "protocol": "hls",
          "extended": true,
          "originCode": "default",
          "live": false,
          "nva": "",
          "nvb": "",
          "token": "",
          "dynamicRules": {}
        }
    }
}

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

0.2.6 (2023-05-17)

Bug Fixes

  • FEC-13123: replace travis with github actions (#28) (45a88a4)

0.2.5 (2023-04-10)

0.2.4 (2023-04-10)

0.2.3 (2023-04-09)

0.2.2 (2023-04-09)

0.2.1 (2023-04-05)

Build System

0.2.0 (2022-03-23)

Bug Fixes

  • FEC-12045: CDN balancer service called twice (#8) (86a263b)

Features

  • FEC-12037: [SmartSwitch] Mediacorp Multi CDN POC add mainfest redirect config (#7) (e2d6a0e)

0.1.1 (2022-02-16)

Bug Fixes

  • FEC-11899: [Smart Switch] Handle new format of Smart Switch CDN Balancer API responses (#4) (026b33b)
  • FEC-11919: [Smart Switch] Add sample page (#5) (42bcdb7)
  • FEC-11958: [SmartSwitch] - expose alternative URL (#6) (6beae08)
  • protect the lib response (#3) (18cf01d)

Build System

  • FEC-10700: Improvement for CI/CD (#2) (dc55f56)
  • FEC-11389: reduce builds from travis (bd4bb3b)

0.1.0 (2021-06-02)

Features

  • FEC-11226: Client-Side CDN Switching using NPAW Smart Switch (#1) (cb7831e)