Class Player

リリックアプリの状態

Lyric app status

Player の情報を表示する IPlayerBanner インスタンスです。

A banner instance that shows the player info.

読み込み済みの音楽地図など楽曲に関する情報

Current song map and other information related to the musical piece

フレームレート [フレーム数/秒]

Framerate [frames per sec]

フレームレート [フレーム数/秒]

Framerate [frames per sec]

動画（楽曲情報や歌詞など）が読み込み中か否か

Whether the video (song, lyrics, etc.) is being loaded or not

動画再生中か否か

Whether the video is being played or not

動画シーク中か否か

• true のとき 1) PlayerEventListener.onTimeUpdate イベントは発火せず 2) IPlayer.mediaPosition は描画タスクをトリガーせずに更新され続けます
• シークバーの実装で利用されます

Whether the seeking operation is ongoing on or not

• When this property is true, 1) PlayerEventListener.onTimeUpdate event is not emitted and 2) IPlayer.mediaPosition is updated without rendering a new frame
• Intended to be used by a seekbar implementation

音源などに関するバナーの配置先となるDOM要素

Media banner element

音源メディアの配置先となるDOM要素

Media element

音源メディアの配置先となるDOM要素

Media element

現在の音源メディアの再生位置 [ms]

Current media position [ms]

音源メディアの直接の配置先となるDOM要素

Media source element

プレイヤーの初期化オプション

Player options

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

A timer instance that controls the player status.

動画オブジェクト

Current video object

現在の動画の再生位置 [ms]

Current video position [ms]

音量 [0-100]

Volume [0-100]

音量 [0-100]

Volume [0-100]

動画の描画間隔 [ms]

A time window between rendering frames [ms]

動画の描画間隔 [ms]

A time window between rendering frames [ms]

イベントリスナを登録する

Add event listener

解決済みのカードデータから動画データを生成する

Generate video data from resolved card data represented as JsonDataEntry.

カードURLから解決済みデータを取得して動画データを生成する

Fetch resolved card data from a URL and generate video data.

動画情報を表すデータ（VideoData）から動画データを生成する

Generate video data from JSON

楽曲パス（URLから http:// などのプロトコル部分を除いたもの）に基づいて音楽地図などを読み込み、動画データを生成する

Generate video data from song path

楽曲URLをTextAlive APIでカードデータへ解決し、音楽地図などを読み込んで動画データを生成する

Resolve a song URL through the TextAlive API and generate video data. Unsupported public URLs fall back to the direct provider path.

テキストからダミーの音楽地図情報と動画データを生成する

Generate video data from text

プレイヤーを破棄する

Dispose this player

動画のシーク操作を終える

• IPlayer.isVideoSeeking を false にします
• シーク操作終了後は Timer が PlayerEventListener.onTimeUpdate を呼ぶようになります

End video seeking operation

• This will set IPlayer.isVideoSeeking false
• After calling this method, position updates by Timer trigger PlayerEventListener.onTimeUpdate again

現在読み込まれているデータを JsonDataEntry としてエキスポートする

Export the currently loaded data (song, analysis, lyrics) as a JsonDataEntry object that can be serialised to JSON and later supplied to IPlayer.createFromCardData. Returns null when no video / song data has been loaded yet.

指定された位置のビート情報を取得する

Find beat that overlaps with the specified timing

指定された時区間のビート情報の変化を取得する

Look for beat transitions in the specified time range

指定された位置のコード進行を取得する

Find chord that overlaps with the specified timing

指定された時区間のコード進行の変化を取得する

Look for chord progressions in the specified time range

指定された位置のサビ情報を取得する

Find a chorus part that overlaps with the specified timing

指定された時区間のサビ情報の変化を取得する

Look for chorus part transitions in the specified time range

楽曲中のビートに関する情報を取得する

Get beats in the current song

楽曲中のコード進行に関する情報を取得する

Get chord info in the current song

楽曲中のサビに関する情報を取得する

Get chorus parts in the current song

楽曲中の最大声量を取得する

• 取得するには、あらかじめプレイヤー初期化オプション PlayerOptions.vocalAmplitudeEnabled を true にセットしておく必要があります

Get maximum vocal amplitude

• Constructor option PlayerOptions.vocalAmplitudeEnabled needs to be true

V/A空間中の座標遷移の中央値を取得する

• 取得するには、あらかじめプレイヤー初期化オプション PlayerOptions.valenceArousalEnabled を true にセットしておく必要があります

Get median valence arousal value throughout the song

• Constructor option PlayerOptions.valenceArousalEnabled needs to be true

指定された位置のV/A空間中の座標を取得する

• 取得するには、あらかじめプレイヤー初期化オプション PlayerOptions.valenceArousalEnabled を true にセットしておく必要があります

Get valence arousal value at the specified timing

• Constructor option PlayerOptions.valenceArousalEnabled needs to be true

指定された位置の声量を取得する

• 取得するには、あらかじめプレイヤー初期化オプション PlayerOptions.vocalAmplitudeEnabled を true にセットしておく必要があります
• 返値は 0 以上 IPlayer.getMaxVocalAmplitude で取得できる最大値以下の値

Get vocal amplitude at the specified timing

• Constructor option PlayerOptions.vocalAmplitudeEnabled needs to be true
• Return value ranges from 0 to the maximum value that can be retrieved by IPlayer.getMaxVocalAmplitude

イベントリスナを削除する

Remove event listener

楽曲の再生位置を指定する

Seek specified position in the current media

楽曲の再生を一時停止する

Pause playing music

楽曲の再生を開始する

Start playing music

動画の現在のフレームを強制的に再描画する

Force rendering current frame

楽曲の再生を停止する（一時停止したうえで先頭に巻き戻しする）

Stop playing music (pause and then seek the beginning)

動画の再生位置を指定する

Try setting video position

動画のシーク操作を始める

• IPlayer.isVideoSeeking を true にします
• シーク操作開始後は Timer が PlayerEventListener.onTimeUpdate を呼ばなくなります

Start video seeking operation

• This will set IPlayer.isVideoSeeking true
• After calling this method, Timer does not trigger PlayerEventListener.onTimeUpdate