@skylineos/clsp-player
Advanced tools
Skyline Technology Solutions' CLSP Video Player. Stream video in near-real-time in modern browsers.
An html5 CLSP video player. CLSP is a proprietary near-real-time video streaming protocol only available via Skyline's SFS solutions.
All other desktop browsers are currently not supported.
@todo
The highest h.264 keyframe/iframe segment frequency this player currently supports is 2 per second (this is different from frames per second).
The network protocol is handled by specifying the following URI format:
[clsp protocol] :// [sfs-host] : [port-number-of-web-socket] / [stream-name]
clsp protocol: clsp or clspssfs-host: the host (or ip address) of the Skyline SFSport-number-of-web-socket: optional, @see Default Portstream-name: the stream name as defined on the Skyline SFSExample stream url:
clsp://sfs.somecity.com/CityFeedVideo0652
Note that many Skyline SFS production LTS deployments use a default port of 9001. To accomodate for this, you do not necessarilly need to append the port 9001 to every clsp url. You can use the utility method utils.setDefaultStreamPort, which is documented below.
Control stream access via hash tokens.
The MD5 hash authentication method provides authentication as well as stream access time.
[clsp-hash protocol]://[sfs-host]:[port-number-of-web-socket]/[stream-name]
?start=[time-epoch-seconds]
&end=[time-epoch-seconds]
&token=[hash-token]
clsp-hash protocol: clsp-hash or clsps-hashsfs-host: the host (or ip address) of the Skyline SFSport-number-of-web-socket: required, @see Default Portstream-name: the stream name as defined on the Skyline SFSstart: contains the earliest time you want the stream to become available.end: contains the latest time you want the stream to become available.token: contains the entire url sans token, md5 + secretThe token is created by appending a shared secret to the url. That new string is used to create an MD5 hash. The shared secret must first be set up on the Skyline SFS and the stream-requesting application. You will need to work with Skyline to configure and use hash token support.
| protocol / SFS version | >= v5.2.0 | < v5.2.0 |
|---|---|---|
clsp | 80 | 9001 |
clsps | 443 | 443 |
Note that many Skyline SFS production LTS deployments use a default port of 9001. To accomodate for this, you do not necessarilly need to append the port 9001 to every clsp url. You can use the utility method utils.setDefaultStreamPort, which is documented below.
yarn add @skylineos/clsp-player
Note that installation /use via yarn is recommended as it is what we use for development, testing, and dependency management.
npm i @skylineos/clsp-player
<script> tagNOTE: See demos/simple-dist/ and demos/advanced-dist/ for full examples.
A CLSP object is attached to window, which contains the classes and utils you need to create players.
<head> Tag<head>
<!-- load CLSP Player styles -->
<link
rel="stylesheet"
href="/path/to/dist/clsp-player.css"
>
<head>
<script> Tag<!-- load CLSP Player in `head` or `body` -->
<script src="/path/to/dist/clsp-player.min.js"></script>
<!-- use CLSP Player at end of `body` -->
<script>
var videoElementId = 'my-video';
var urls = [
'clsps://bd-demo-sfs1.skyvdn.com/testpattern',
'clsps://bd-demo-sfs1.skyvdn.com/testpattern',
];
// If you are using a Skyline SFS that uses a default CLSP stream port that
// isn't `80` (e.g. SFS < v5.2.0), you may set the window-level default port
// for `clsp` streams:
window.CLSP.utils.setDefaultStreamPort('clsp', 9001);
// Construct the player collection
var iovCollection = window.CLSP.IovCollection.asSingleton();
// Instantiate the iov instance for the target video element
var iov = iovCollection.create(videoElementId)
// do something with the iov instance
await iov.changeSrc(urls[0]);
// Or instantiate a tour
var tour = window.CLSP.TourController.factory(
iovCollection,
videoElementId,
{
intervalDuration: 10,
},
);
tour.addUrls(urls);
tour.start();
</script>
<video> tagWe recommend wrapping the video tag in a container element (e.g. div) that the CLSP Player can mutate as needed. The CLSP Player needs to perform some actions on the video element as well as its container.
Note that for clsp streams, the src tag must have a type attribute with a value of video/mp4; codecs='avc1.42E01E'.
This tells the browser exactly what codec to use to decode and play the video. H.264 baseline 3.0 is a least common denominator codec supported on all browsers (according to the MSE development page).
<div class="video-container">
<div class="clsp-container-fit">
<video
id="my-video"
muted
playsinline
>
<source
src="clsps://bd-demo-sfs1.skyvdn.com/testpattern"
type="video/mp4; codecs='avc1.42E01E'"
/>
</video>
</div>
</div>
import or requireNOTE: See demos/simple-src/ and demos/advanced-src/ for full examples.
import {
IovCollection,
TourController,
utils,
} from '@skylineos/clsp-player';
const videoElementId = 'my-video';
const urls = [
'clsps://bd-demo-sfs1.skyvdn.com/testpattern',
'clsps://bd-demo-sfs1.skyvdn.com/testpattern',
];
try {
// If you are using a Skyline SFS that uses a default CLSP stream port that
// isn't `80` (e.g. SFS < v5.2.0), you may set the window-level default port
// for `clsp` streams:
utils.setDefaultStreamPort('clsp', 9001);
// Construct the player collection
const iovCollection = IovCollection.asSingleton();
// Instantiate the iov instance for the target video element
const iov = iovCollection.create(videoElementId);
// do something with the iov instance
await iov.changeSrc(urls[0]);
// Or instantiate a tour
const tour = TourController.factory(
iovCollection,
videoElementId,
{
intervalDuration: 10,
},
);
tour.addUrls(urls);
tour.start();
}
catch (error) {
// do something with the error
console.error(error);
}
@import '/path/to/node_modules/@skylineos/clsp-player/dist/clsp-player.css';
// or import it from src
@import '/path/to/node_modules/@skylineos/clsp-player/src/styles/clsp-player.scss';
<video> tagWe recommend wrapping the video tag in a container element (e.g. div) that the CLSP Player can mutate as needed. The CLSP Player needs to perform some actions on the video element as well as its container.
<!-- The outer container used for your styling -->
<div class="video-container">
<!-- The inner container used by CLSP for styling and other operations -->
<div class="clsp-container-fit">
<video id="my-video"></video>
</div>
</div>
FAQs
Skyline Technology Solutions' CLSP Video Player. Stream video in near-real-time in modern browsers.
The npm package @skylineos/clsp-player receives a total of 520 weekly downloads. As such, @skylineos/clsp-player popularity was classified as not popular.
We found that @skylineos/clsp-player demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."