Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 2.14 KB

configuration.md

File metadata and controls

53 lines (32 loc) · 2.14 KB
Raw

Table of Contents

FloatingConfigObject

When a viewer scrolls the player out of view, a floating player would pop-up and position itself following the configuration. This allows the viewer to engage with both the video content and the site content.

Type: Object

Parameters

  • position ("bottom-left" | "bottom-right" | "top-left" | "top-right") The position where the floating player will be displayed (optional, default 'bottom-right')
  • dismissible boolean When set to true, viewer will be able to dismiss the floating player so that it doesn’t appear anymore while he scrolls the current page (optional, default true)
  • draggable boolean When set to true, viewer will be able to drag the floating player. Uncheck if you want to have a fixed location for the floating player (optional, default true)
  • height number The height of the floating player in pixels (optional, default 225)
  • width number The width of the floating player in pixels (optional, default 400)
  • marginX number The margin, in pixels, from the selected edge, on the X-Axis (optional, default 20)
  • marginY number The margin, in pixels, from the selected edge, on the Y-Axis (optional, default 20)

EventType

Type: Object

FLOATING_PLAYER_STATE_CHANGED

Fired when the player started / stopped floating due to visibility change

FLOATING_PLAYER_DISMISSED

Fired when the player stopped floating due to end user dismissal