Interface PlayerAppListener

リリックアプリ関連のイベント

Lyric app-related events

interface PlayerAppListener {
    onAppLoad?(app, error?): void;
    onAppMediaChange?(songUrl, videoPromise?): void;
    onAppParameterUpdate?(name, value): void;
    onAppReady?(app): void;
}

Methods

onAppLoad? onAppMediaChange? onAppParameterUpdate? onAppReady?

Methods

Optional onAppLoad

  • onAppLoad(app, error?): void

  • TextAlive App API サーバとの接続時に呼ばれる

    Parameters

    • app: IPlayerApp

      TextAlive App API サーバに関する情報 / TextAlive app API server info

    • Optional error: string

      エラーメッセージ / Error message

    Returns void

Optional onAppMediaChange

  • onAppMediaChange(songUrl, videoPromise?): void

  • リリックアプリの再生すべき楽曲URLが変更されたときに呼ばれる

    Called when a media URL to play is updated

    Parameters

    • songUrl: string

      楽曲URL / Song URL

    • Optional videoPromise: Promise<IVideo>

      動画オブジェクトと Timer の準備が整ったときに解決される Promise オブジェクト / A promise to resolve after the video object and Timer gets ready

    Returns void

Optional onAppParameterUpdate

  • onAppParameterUpdate(name, value): void

  • リリックアプリのパラメタが更新されたときに呼ばれる

    Called when a parameter value of this lyric app is updated

    Parameters

    • name: string

      パラメタ名 / Parameter name

    • value: ParameterValue

      パラメタ値 / Parameter value

    Returns void

Optional onAppReady

  • onAppReady(app): void

  • リリックアプリ ホストとの接続時に呼ばれる

    Called when connection to a lyric app host is established

    Parameters

    • app: IPlayerApp

      リリックアプリのホストに関する情報 / Lyric app host info

    Returns void

Settings

Member Visibility

Theme

On This Page

onAppLoadonAppMediaChangeonAppParameterUpdateonAppReady