Options
Menu

Interface PlayerOptions

TextAlive Player の初期化オプション

see

IPlayer

Hierarchy

  • PlayerOptions

Index

Properties

Optional app

app: PlayerAppOptions | boolean

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

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

Optional fontFamilies

fontFamilies: (string | FontInfo)[]

読み込むフォントの一覧を指定できます。 TextAlive 動画が読み込まれると、このオプションに限らず、動画中で利用されているフォントがすべて読み込まれます。 null が指定されると、利用可能なすべてのフォントが読み込まれます。

A list of font families to load. When a video is loaded, fonts used in the video override the list. When null is set, all available fonts are loaded.

see

IFontLoader.listAvailableFonts

Optional lyricsFetchTimeout

lyricsFetchTimeout: undefined | number

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

Timeout for fetching lyrics text [ms].

Optional mediaBannerPosition

mediaBannerPosition: PlayerBannerPosition

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

Banner position.

Optional mediaElement

mediaElement: HTMLElement | string

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

A HTML element to host media elements.

Optional throttleInterval

throttleInterval: undefined | number

時刻のアップデートイベントが発行されすぎるのを防ぐために使われるスロットリング機構の発行間隔です。

An interval for emitting throttled events [ms].

see

PlayerEventListener.onThrottledTimeUpdate

Optional timer

timer: Timer

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

A timer instance that controls the player status.

Optional valenceArousalEnabled

valenceArousalEnabled: undefined | false | true

V/A空間の座標値を取得するか否か

Whether to load valence arousal data or not

Optional vocalAmplitudeEnabled

vocalAmplitudeEnabled: undefined | false | true

声量情報を取得するか否か

Whether to load vocal amplitude data or not