Interface PlayerParameters

Defines the parameters required to create a new embedded player.

interface PlayerParameters {
    channelId?: string;
    height?: string;
    playerId: string;
    playoutUrl?: string;
    videoId: string;
    width?: string;
}

Properties

channelId? height? playerId playoutUrl? videoId width?

Properties

OptionalchannelId

channelId?: string

The id of the channel this video belongs to.

Default

undefined

Optionalheight

height?: string

The height of the player iframe. If both height and width are unset, the player will default to 100% width and a 16:9 aspect ratio.

Default

undefined

playerId

playerId: string

The ID of the player configuration to use.

OptionalplayoutUrl

playoutUrl?: string

The base URL of the playout player.

Default

'https://e.video-cdn.net/watch'

videoId

videoId: string

The ID of the video to embed.

Optionalwidth

width?: string

The width of the player iframe. If both height and width are unset, the player will default to 100% width and a 16:9 aspect ratio.

Default

undefined

Settings

Member Visibility

On This Page

Properties