THEOplayer Web SDK
    Preparing search index...

    Interface View

    The View API

    interface View {
        canResize: boolean;
        enabled: boolean;
        height: number;
        label: string;
        muted: boolean;
        offset: number;
        player: ChromelessPlayer;
        position: number;
        width: number;
        x: number;
        y: number;
        remove(): void;
    }
    Index

    Properties

    canResize enabled height label muted offset player position width x y

    Methods

    remove

    Properties

    canResize: boolean

    Returns if the View can be resized.


    - Returns true if MultiViewPlayer.layout is set to 'overlay' and the position is not equal to zero.

    enabled: boolean

    Whether the view is visible or not.


    - The view at position zero is always enabled.

    height: number

    The percentage relative to the total height of the containing MultiViewPlayer.


    - Cannot be set if canResize is false.

    label: string

    The label with which the view was created.

    muted: boolean

    Whether audio is muted.


    Only one view can be unmuted at a time.
    Setting this value will give audio focus to the view.

    offset: number

    The offset in milliseconds used for improving synchronization between views.

    player: ChromelessPlayer

    (Experimental) The View's internal player.


    - This should not be used for controlling playback directly. Use the MultiViewPlayer methods and properties instead.
    - This is an experimental property. Combined with multiview, player features and APIs accessible only through this direct player API may not function as intended and may disrupt proper multiview functionality.

    position: number

    The position in MultiViewPlayer.views.


    - Only the position of an enabled view can be set to zero.

    width: number

    The percentage relative to the total width of the containing MultiViewPlayer.


    - Cannot be set if canResize is false.

    x: number

    The horizontal offset in percentage.


    - It describes the offset of the top left corner of the view relative to the top left corner of the MultiViewPlayer.
    - Cannot be set if canResize is false.

    y: number

    The vertical offset in percentage.


    - It describes the offset of the top left corner of the view relative to the top left corner of the MultiViewPlayer.
    - Cannot be set if canResize is false.

    Methods

    • Destroys the associated player and removes the view from the MultiViewPlayer.

      Returns void


      - The view at position zero cannot be removed.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods