Interface PlayerOptions

Player の初期化オプション

Player initialization options

interface PlayerOptions {
    app?: PlayerAppOptions;
    fontFamilies?: (string | FontInfo)[];
    lyricsFetchTimeout?: number;
    mediaBannerPosition?: PlayerBannerPosition;
    mediaElement?: string | HTMLElement;
    throttleInterval?: number;
    timer?: Timer;
    valenceArousalEnabled?: boolean;
    vocalAmplitudeEnabled?: boolean;


リリックアプリの情報; このプロパティがセットされていると、再生メディアをURLのクエリパラメタから取得したり、アプリのホストとの接続を試みたりします。

Lyric app options. When this property is set, the player parses query string to gain initial media information and tries communicating with the app host.

fontFamilies?: (string | FontInfo)[]

読み込むフォントの一覧を指定できます。 null が指定されると、利用可能なすべてのフォントが読み込まれます。

A list of font families to load. When null is set, all available fonts are loaded.

lyricsFetchTimeout?: number

歌詞テキストの読み込みを諦めるタイムアウト時刻です。指定しないか 0 を指定した場合はタイムアウトしません。

Timeout for fetching lyrics text [ms].

mediaBannerPosition?: PlayerBannerPosition

音源メディアの関連情報を表示する位置; 指定がなければ embed と見なされ、メディア直下に表示されます。

Banner position.

mediaElement?: string | HTMLElement

音源メディアの配置先となるDOM要素; 音源を埋め込むコンテナとして利用されるDOM要素です。

A HTML element to host media elements.

throttleInterval?: number


An interval for emitting throttled events [ms].

timer?: Timer

Player の音源の再生状態を管理する Timer インスタンスです。

A timer instance that controls the player status.

valenceArousalEnabled?: boolean


Whether to load valence arousal data or not

vocalAmplitudeEnabled?: boolean


Whether to load vocal amplitude data or not