@movingimage-evp/player-sdk
    Preparing search index...

    Interface PlayerParameters

    Defines the parameters required to create a new embedded player.

    interface PlayerParameters {
        aspectRatio?: string;
        channelId?: string;
        height?: string;
        playerId: string;
        playoutUrl?: string;
        startAt?: number;
        title?: string;
        videoId: string;
        width?: string;
    }
    Index

    Properties

    aspectRatio? channelId? height? playerId playoutUrl? startAt? title? videoId width?

    Properties

    aspectRatio?: string

    The aspect ratio to use for the player iframe.

    '16:9'
    channelId?: string

    The id of the channel this video belongs to.

    undefined
    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.

    undefined
    playerId: string

    The ID of the player configuration to use.

    playoutUrl?: string

    The base URL of the playout player.

    'https://e.video-cdn.net/watch'
    startAt?: number

    The time in seconds to start the video at.

    0
    title?: string

    The title of the embed code.

    'mi video player'
    videoId: string

    The ID of the video to embed.

    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.

    undefined

    Settings

    Member Visibility

    On This Page

    Properties