Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

Latest commit

 

History

History
76 lines (63 loc) · 2.02 KB

README.md

File metadata and controls

76 lines (63 loc) · 2.02 KB

@vgrid/clappr-rtmp

var player = new Clappr.Player({
  source: 'rtmp://source_here',
  parentId: "#player-wrapper",
  plugins: {
    playback: [RTMP]
  },
  rtmpConfig: {
    swfPath: 'dist/assets/RTMP.swf',
    scaling:'stretch',
    playbackType: 'live',
    bufferTime: 1,
    startLevel: 0,
    switchRules: {
      DroppedFramesRule: {
        downSwitchByOne: 10,
        downSwitchByTwo: 20,
        downSwitchToZero: 24
      },
      InsufficientBandwidthRule: {
        bitrateMultiplier: 1.15
      },
      InsufficientBufferRule: {
        minBufferLength: 2
      },
      SufficientBandwidthRule: {
        bandwidthSafetyMultiple: 1.15,
        minDroppedFps: 2
      }
    }
  }
});

Configuration

The plugin accepts several optional configuration options, such as:

  • swfPath (default //cdn.jsdelivr.net/clappr.rtmp/latest/assets/RTMP.swf) - Path to the SWF responsible for the playback.
  • scaling (default letterbox) - Scaling behavior.
  • playbackType (default live if the source contains live on its URL, vod otherwise).
  • bufferTime (default 0.1) - How long to buffer before start playing the media.
  • startLevel (default -1) - Initial quality level index.
  • autoSwitch (default false) - Whether video should autoSwitch quality
  • useAppInstance (default false) - Set it to true if your source url contains the app instance (not required if the app instance is _definst_).
  • proxyType (default none) - Determines which fallback methods are tried if an initial connection attempt to Flash Media Server fails.
  • switchRules (default system defined) - Rules defined to autoSwitch video quality based in some conditions.

Building

Requirements

  1. AirSDK
  2. Webpack

Compile SWF

cd src
sh build_player.sh

Download JS dependencies

npm install

Build the final dist

webpack