Interface Screen

Broadcaster が Spot を訪問すると開始される 生放送 (Live) を 画面に描画します.

ScreenBuilder を使ってインスタンスを作成してください.

interface Screen {
    area?: Readonly<CommonArea>;
    container?: E;
    customLiveContext?: Partial<LiveContext>;
    nowOnAir?: Live;
    onLiveStart: Trigger<Live>;
    vars?: unknown;
    addSpot(spot: Spot): void;
    startLive(broadcaster: Broadcaster): void;
}

Properties

area? container? customLiveContext? nowOnAir? onLiveStart vars?

Methods

addSpot startLive

Properties

Optional Readonlyarea

area?: Readonly<CommonArea>

生放送スクリーンの領域座標.

container に値が登録されているとき値を返します.

Optionalcontainer

container?: E

Live を描画するエンティティ.

生放送時の描画内容は本エンティティの子に格納されます.

OptionalcustomLiveContext

customLiveContext?: Partial<LiveContext>

Live を開始する際、この値でデフォルトの LiveContext に上書きします.

Optional ReadonlynowOnAir

nowOnAir?: Live

現在放送中の Live インスタンスを取得します.

放送中でない場合 undefined を返します.

ReadonlyonLiveStart

onLiveStart: Trigger<Live>

生放送が始まった際に発火するトリガ.

Optionalvars

vars?: unknown

ライブラリ利用者が自由に使えるフィールドです.

Methods

addSpot

  • addSpot(spot): void

  • Spot を登録します.

    Parameters

    • spot: Spot

      訪問時に生放送を開始するスポット

    Returns void

startLive

  • startLive(broadcaster): void
  • Internal

    Broadcaster が Spot を訪問したため、登録された生放送を開始します.

    Broadcaster は Spot に滞在している必要があります.

    本メソッドは Spot 到着時に自動で呼び出されるため、 ライブラリ利用者が実行する必要はありません.

    Parameters

    • broadcaster: Broadcaster

      Spot を訪問した Broadcaster

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods