The View API

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

Properties

canResize: boolean

Returns if the View can be resized.

Remarks


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

enabled: boolean

Whether the view is visible or not.

Remarks


- The view at position zero is always enabled.

height: number

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

Remarks


- Cannot be set if canResize is false.

label: string

The label with which the view was created.

muted: boolean

Whether audio is muted.

position: number

The position in MultiViewPlayer.views.

Remarks


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

Remarks


- Cannot be set if canResize is false.

x: number

The horizontal offset in percentage.

Remarks


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

Remarks


- 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

    Remarks


    - The view at position zero cannot be removed.

Generated using TypeDoc