Skip to content

Latest commit

 

History

History
105 lines (70 loc) · 2.72 KB

README.md

File metadata and controls

105 lines (70 loc) · 2.72 KB
Raw

flussonic-mse-player

flussonic-mse-player is a JavaScript library for playing video relies on flussonic backend, HTML5 video and MediaSource Extensions

Installation

npm install --save @flussonic/flussonic-mse-player

Usage

Webpack:

import FlussonicMsePlayer from '@flussonic/flussonic-mse-player'
...
const player = new FlussonicMsePlayer(element, url, opts)

example

Script tag:

Since the library include via script tag it is accesible at window.FlussonicMsePlayer

<script type="text/javascript" src="../../dist/FlussonicMsePlayer.js"></script>
var FlussonicMsePlayer = window.FlussonicMsePlayer
var player = new FlussonicMsePlayer(element, url, opts)

example

Static Methods:

  • isSupported() - return true if browser is supported Media Source Extension

  • replaceHttpByWS(url: string) - return new url where replaced http(s):// by ws(s)://

Construction:

const player = new FlussonicMsePlayer(element, url, opts)

element -

url - url of a stream

opts is plain object it can include methods:

  • onProgress(utc: number) - triggered every 100ms while a stream is playing and gives current playback time

  • onMediaInfo(info: MediaInfo) - triggered then metadata of the stream is available. metadata include a common information of the stream such as width, height, information about mbr streams and so on. After this callback triggered you can use getVideoTracks()/getAudioTracks() methods.

  • bufferMode: 'segments'|'sequence' - SourceBuffer Object Append Mode. Default value is 'sequence'.

  • errorsBeforeStop: number - Amount of errors will be happened before invoke the stop() method.

Methods:

  • play() - start playing

  • pause() - send pause command by websocket

  • stop() - close websocket connection; detach mediaSource from given HTMLMediaElement; invoke the HTMLMediaElement stop method

  • seek(utc: number) - send seek command by websocket

  • setTracks(tracks: Array) -

Types:

MediaInfo {
  height: number,
  width: number,
  streams: Array<StreamInfo>,
}

StreamInfo {
  bitrate
: number,
  codec
:
 string,
  content
:
 string,
  
fps
:
 number,
  height
:
 number,
  length_size
:
 number,
  level
:
 string,
  pixel_height
:
 number,
  pixel_width
:
 number,
  profile
:
"Baseline"

  sar_height
:
 number,

  sar_width
:
 number,

  size
:
 string,
  track_id
:
 string,
  width
:
 number
}

Track: string