Interface SocialSharingConfiguration

interface SocialSharingConfiguration {
    deeplinking: boolean;
    description: string;
    embedCode: string;
    embedDimensions: boolean;
    embedDomain: string;
    label: string;
    offset: string;
    removeDirect: boolean;
    removeEmbed: boolean;
    services: SocialSharingConfigurationServices;
    title: string;
    url: string;
}

Properties

deeplinking description embedCode embedDimensions embedDomain label offset removeDirect removeEmbed services title url

Properties

deeplinking

deeplinking: boolean

If true, direct links will include a start offset. Can be updated dynamically. Defaults to false.

description

description: string

Used to provide a description for use in the social overlay. Can be updated dynamically. Defaults to an empty string.

embedCode

embedCode: string

Used to provide a custom embed code that replaces the generated one. Can be updated dynamically. Defaults to an empty string.

embedDimensions

embedDimensions: boolean

If true, the current dimensions of the player will be provided in default embed code. Can be updated dynamically. Defaults to false.

embedDomain

embedDomain: string

This value is only used when the embed code is not set. Used to provide a custom domain if proxy is being used. Can be updated dynamically. Defaults to 'players.brightcove.net'.

label

label: string

Used to provide a label for the social overlay. Can only be updated on initialization of the plugin. Defaults to an empty string.

offset

offset: string

An offset in "hh:mm:ss" format to use for sharing URLs. Can be updated dynamically. Defaults to '00:00:00'.

removeDirect

removeDirect: boolean

If true, turns off the direct link. Can be updated dynamically. Defaults to false.

removeEmbed

removeEmbed: boolean

If true, turns off the embed code. Can be updated dynamically. Defaults to false.

services

services: SocialSharingConfigurationServices

Can be updated dynamically. See SocialSharingConfigurationServices for defaults.

title

title: string

Used to provide a title for use in the social overlay. Can be updated dynamically. Defaults to an empty string.

url

url: string

Used to provide a custom URL that replaces the generated one. Can be updated dynamically. Defaults to an empty string.

Settings

Member Visibility

Theme

On This Page

deeplinkingdescriptionembedCodeembedDimensionsembedDomainlabeloffsetremoveDirectremoveEmbedservicestitleurl