Skip to content

JS API

The FigureVideoTwicpics class extends the FigureVideo class and adds support for TwicPics API.

Options

domain

  • Type: string
  • Default: ''

Use this option to configure your Twicpics domain.

path

  • Type: string
  • Default: ''

Use this option to configure your Twicpics path.

transform

  • Type: string
  • Default: ''

Use this option to add transforms to the video with TwicPics URL API.

step

  • Type: number
  • Default: 50

The step used to round up video size calculation. Default to 50, which means that a size of 320×380 will be rounded to 350×400.

mode

  • Type: string
  • Default: 'cover'

The mode used to resize and crop the video. It can be any key of the transformations API of TwicPics which accepts a size as value.

Getter

domain

  • Return: string

A getter to override in a child class in order to define the main host on which the video should be served by Twicpics. It will be used to replace the host of the video source.

path

  • Return: string

A getter to override in a child class in order to define the path on which the video should be server by Twicpics. It will be used to prefix the pathname of the video source.