Interface FreecasterPlayerProps

Freecaster player options

See

Configuring the player - Freecaster documentation

interface FreecasterPlayerProps {
    audioOnly?: boolean;
    autopause?: boolean;
    autoplay?: boolean;
    cast?: boolean;
    chaptersEnabled?: boolean;
    chaptersList?: string[];
    chaptersStyle?: "hidden" | "dot" | "full_width";
    controls?: boolean;
    floatOnScroll?: boolean;
    height?: number;
    keepAlive?: boolean;
    lang?: string;
    loop?: boolean;
    multiplay?: boolean;
    muted?: boolean;
    noads?: boolean;
    playsinline?: boolean;
    poster?: string;
    preload?: "none" | "metadata" | "auto";
    speedLabels?: string[];
    speedOptions?: number[];
    stats?: boolean;
    stretching?:
        | false
        | "none"
        | "fill"
        | "cover";
    subtitlesDefaultLang?: string;
    subtitlesLang?: string;
    subtitlesNative?: boolean;
    thumbnailsSrc?: string;
    trackersGaEnabled?: boolean;
    trackersGaTagIds?: string[];
    videoId?: string;
    volume?: number;
    watermarkEnabled?: boolean;
    width?: number;
}

Hierarchy (view full)

Properties

audioOnly? autopause? autoplay? cast? chaptersEnabled? chaptersList? chaptersStyle? controls? floatOnScroll? height? keepAlive? lang? loop? multiplay? muted? noads? playsinline? poster? preload? speedLabels? speedOptions? stats? stretching? subtitlesDefaultLang? subtitlesLang? subtitlesNative? thumbnailsSrc? trackersGaEnabled? trackersGaTagIds? videoId? volume? watermarkEnabled? width?

Properties

OptionalaudioOnly

audioOnly?: boolean

Enable/disable minimal player UI.

Default

false

Optionalautopause

autopause?: boolean

Enable/disable the automatic pause when the player is no longer visible in the viewport.

Default

true

Optionalautoplay

autoplay?: boolean

false Enable/disable the autoplay. There are limitations when used along with autoplay (See Google article for more information) You must set muted="true" in to be sure for it to work.

Default

false

Optionalcast

cast?: boolean

Enable/disable Chromecast/AirPlay.

Default

false

OptionalchaptersEnabled

chaptersEnabled?: boolean

Enable/disable chapters.

Default

false

OptionalchaptersList

chaptersList?: string[]

The list of chapters.

Default

[]

OptionalchaptersStyle

chaptersStyle?: "hidden" | "dot" | "full_width"

Specify the style to use for the timeline's cuepoints.

Default

'hidden'

Optionalcontrols

controls?: boolean

Enable/disable the control bar.

Default

true

OptionalfloatOnScroll

floatOnScroll?: boolean

When enabled, a floating video container will be displayed when the user scroll past the player.

Default

false

Optionalheight

height?: number

Set the height of the player

Default

undefined

OptionalkeepAlive

keepAlive?: boolean

Optionallang

lang?: string

The lang provided by the user (language-country (RFC 5646)).

Default

undefined

Optionalloop

loop?: boolean

If set to true, the video will start over upon ending.

Default

false

Optionalmultiplay

multiplay?: boolean

Whether the player should pause if another player begins playback.

Default

false

Optionalmuted

muted?: boolean

Enable/disable sound.

Default

false, always true when autoplay is enabled

Optionalnoads

noads?: boolean

Enable/disabled advertising.

Default

false

Optionalplaysinline

playsinline?: boolean

Enable/disable inline playback on iOS.

Default

true

Optionalposter

poster?: string

Set a specific poster.

Default

undefined

Optionalpreload

preload?: "none" | "metadata" | "auto"

Video preload strategy

Default

undefined

OptionalspeedLabels

speedLabels?: string[]

List of speed labels

Default

undefined

OptionalspeedOptions

speedOptions?: number[]

List of speed factors

Default

[0.2,0.5,1,2,10]

Optionalstats

stats?: boolean

Trackers (such as Google Analytics, Mux, Youbora, ...) will be enabled.

Default

false

Optionalstretching

stretching?:
    | false
    | "none"
    | "fill"
    | "cover"

Resize poster and video to fit player dimensions. 'fill' Fit player dimensions without maintaining aspect ratio. 'cover' Zoom and crop video to fill dimensions, maintaining aspect ratio. 'none' Display the actual size of the video file. (Black borders).

Default

false

OptionalsubtitlesDefaultLang

subtitlesDefaultLang?: string

Set an active subtitle from the desired language (2 letter ISO-639-1 code).

Default

false

OptionalsubtitlesLang

subtitlesLang?: string

Only show the specified language (2 letter ISO-639-1 code).

Default

undefined

OptionalsubtitlesNative

subtitlesNative?: boolean

Enable subtitles to be rendered by the browser supporting inline style or CSS rules within VTT file.

Default

false

OptionalthumbnailsSrc

thumbnailsSrc?: string

Set specific thumbnails.

Default

undefined

OptionaltrackersGaEnabled

trackersGaEnabled?: boolean

Enable Google Analytics (GA4) support. By default, window.dataLayer will be used to push events toward GA4.

Default

false

OptionaltrackersGaTagIds

trackersGaTagIds?: string[]

Add Google Analytics (GA4) tag IDs to track.

Default

undefined

OptionalvideoId

videoId?: string

ID of the video

Default

undefined

Optionalvolume

volume?: number

Set the volume percentage of the player. The value used must be between 0 and 1 (see MDN). If the user specifically muted the sound, it will not "force" the next time he loads the player. There are limitations when used along with autoplay: See Google article for more information.

Default

undefined

OptionalwatermarkEnabled

watermarkEnabled?: boolean

Enable/disable the watermark.

Default

false

Optionalwidth

width?: number

Set the width of the player.

Default

undefined

Settings

Member Visibility

On This Page

Properties