Options
Menu

Class Player

TextAlive Player

TextAlive API を用いてプログラミングするときのエントリーポイント:

  • TextAlive の主要クラスの一つです
  • 楽曲の音楽地図、歌詞テキスト、歌詞の発声タイミングなどを読み込む機能を持ちます
  • 楽曲再生時の映像演出のプログラミングに必要な API を提供します

This class serves as an entry point to its API:

  • One of the primary classes of TextAlive
  • Song map, lyrics text, and its vocalized timing information are loaded within this class instance
  • APIs useful for visual performance synchronized with music playback are provided through this class

Hierarchy

  • Player

Implements

Index

Constructors

constructor

  • Parameters

    • Optional options: PlayerOptions

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

    Returns Player

Accessors

app

  • TextAlive アプリの状態

    TextAlive app status

    Returns IPlayerApp

banner

  • get banner(): IPlayerBanner
  • TextAlive Player の情報を表示する IPlayerBanner インスタンスです。

    A banner instance that shows the player info.

    Returns IPlayerBanner

data

  • 読み込まれている音楽地図などの情報

    Current video materials

    Returns IDataLoader

fps

  • get fps(): number
  • set fps(val: number): any
  • フレームレート [フレーム数/秒]

    Framerate [frames per sec]

    Returns number

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

    Framerate [frames per sec]

    Parameters

    • val: number

    Returns any

isLoading

  • get isLoading(): boolean
  • 動画(楽曲情報や歌詞など)が読み込み中か否か

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

    Returns boolean

isPlaying

  • get isPlaying(): boolean
  • 動画再生中か否か

    Whether the video is being played or not

    Returns boolean

isVideoSeeking

  • get isVideoSeeking(): boolean
  • 動画シーク中か否か

    Whether the seeking operation is ongoing on or not

    Returns boolean

mediaBannerElement

  • get mediaBannerElement(): HTMLElement
  • 音源などに関するバナーの配置先となるDOM要素

    Media banner element

    Returns HTMLElement

mediaElement

  • get mediaElement(): HTMLElement
  • set mediaElement(element: HTMLElement): any
  • 音源メディアの配置先となるDOM要素

    Media element

    Returns HTMLElement

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

    Media element

    Parameters

    • element: HTMLElement

    Returns any

mediaPosition

  • get mediaPosition(): number
  • 現在の音源メディアの再生位置 [ms]

    Current media position [ms]

    Returns number

mediaSourceElement

  • get mediaSourceElement(): HTMLElement
  • 音源メディアの直接の配置先となるDOM要素

    Media source element

    Returns HTMLElement

options

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

    Player options

    Returns PlayerOptions

timer

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

    A timer instance that controls the player status.

    Returns Timer

video

  • get video(): Video
  • 動画オブジェクト

    Current video object

    Returns Video

videoPosition

  • get videoPosition(): number
  • 現在の動画の再生位置 [ms]

    Current video position [ms]

    Returns number

volume

  • get volume(): number
  • set volume(val: number): any
  • 音量 [0-100]

    Volume [0-100]

    Returns number

  • 音量 [0-100]

    Volume [0-100]

    Parameters

    • val: number

    Returns any

wait

  • get wait(): number
  • set wait(val: number): any
  • 動画の描画間隔 [ms]

    A time window between rendering frames [ms]

    Returns number

  • 動画の描画間隔 [ms]

    A time window between rendering frames [ms]

    Parameters

    • val: number

    Returns any

Methods

addListener

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

    Add event listener

    Parameters

    Returns void

createFromJSON

  • 動画情報を表すデータ(VideoData)から動画データを生成する

    Generate video data from JSON

    Parameters

    Returns Promise<Video>

    動画オブジェクト / Video object

createFromSongPath

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

    Generate video data from song path

    Parameters

    Returns Promise<Video>

    動画オブジェクト / Video object

createFromSongUrl

  • 楽曲URLに基づいて音楽地図などを読み込み、動画データを生成する

    Generate video data from song URL

    Parameters

    Returns Promise<Video>

    動画オブジェクト / Video object

createFromText

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

    Generate video data from text

    Parameters

    Returns Promise<Video>

    動画オブジェクト / Video object

dispose

  • dispose(): void
  • プレイヤーを破棄する

    Dispose this player

    Returns void

endVideoSeek

  • endVideoSeek(): void

findBeat

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

    Find beat that overlaps with the specified timing

    see

    IDataLoader.findBeat

    Parameters

    Returns IBeat

    ビート情報(見つからなければ null

findChord

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

    Find chord that overlaps with the specified timing

    see

    IDataLoader.findChord

    Parameters

    Returns IChord

    コード進行(見つからなければ null

findChorus

findChorusBetween

getBeats

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

    Get beats in the current song

    see

    IDataLoader.getBeats

    Returns IBeat[]

    ビート情報(見つからなければ空の配列)

getChords

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

    Get chord info in the current song

    see

    IDataLoader.getChords

    Returns IChord[]

    コード進行の情報(見つからなければ空の配列)

getChoruses

getMaxVocalAmplitude

  • getMaxVocalAmplitude(): number

getMedianValenceArousal

getValenceArousal

getVocalAmplitude

  • getVocalAmplitude(time: number): number

removeListener

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

    Remove event listener

    Parameters

    Returns boolean

    削除の成否 / Whether the listener was successfully removed or not

requestMediaSeek

  • requestMediaSeek(position: number): boolean
  • 楽曲の再生位置を指定する

    Seek specified position in the current media

    Parameters

    • position: number

    Returns boolean

requestPause

  • requestPause(): boolean
  • 楽曲の再生を一時停止する

    Pause playing music

    Returns boolean

    一時停止の成否

requestPlay

  • requestPlay(): boolean
  • 楽曲の再生を開始する

    Start playing music

    Returns boolean

    開始の成否

requestStageUpdate

  • requestStageUpdate(): Promise<number>
  • 動画の現在のフレームを強制的に再描画する

    Force rendering current frame

    Returns Promise<number>

    動画の現在位置 [ms] / Video position [ms]

requestStop

  • requestStop(): boolean
  • 楽曲の再生を停止する(一時停止したうえで先頭に巻き戻しする)

    Stop playing music (pause and then seek the beginning)

    Returns boolean

    停止の成否

setMediaElement

  • setMediaElement(element: HTMLElement): void

setMediaPosition

  • setMediaPosition(position: number): Promise<void>

setVideoPosition

  • setVideoPosition(position: number): Promise<number>
  • 動画の再生位置を指定する

    Try setting video position

    Parameters

    • position: number

    Returns Promise<number>

startVideoSeek

  • startVideoSeek(): void