Class Player

Player

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

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

This class serves as an entry point to its API:

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

Implements

Constructors

constructor

Accessors

app banner data fps isLoading isPlaying isVideoSeeking mediaBannerElement mediaElement mediaPosition mediaSourceElement options timer video videoPosition volume wait

Methods

addListener createFromJSON createFromSongPath createFromSongUrl createFromText dispose endVideoSeek findBeat findBeatChange findChord findChordChange findChorus findChorusBetween findChorusChange getBeats getChords getChoruses getMaxVocalAmplitude getMedianValenceArousal getValenceArousal getVocalAmplitude removeListener requestMediaSeek requestPause requestPlay requestStageUpdate requestStop setMediaElement setMediaPosition setVideoPosition startVideoSeek

Constructors

constructor

  • new Player(options?): Player

  • Parameters

    • Optional options: PlayerOptions

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

    Returns Player

    See

    IPlayer.options

Accessors

app

  • get app(): IPlayerApp

  • リリックアプリの状態

    Lyric app status

    Returns IPlayerApp

banner

  • get banner(): IPlayerBanner

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

    A banner instance that shows the player info.

    Returns IPlayerBanner

data

  • get data(): IDataLoader

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

    Current song map and other information related to the musical piece

    Returns IDataLoader

fps

  • get fps(): number

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

    Framerate [frames per sec]

    Returns number

    See

    IPlayer.wait

  • set fps(val): void

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

    Framerate [frames per sec]

    Parameters

    • val: number

    Returns void

    See

    IPlayer.wait

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

mediaBannerElement

  • get mediaBannerElement(): HTMLElement

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

    Media banner element

    Returns HTMLElement

mediaElement

  • get mediaElement(): HTMLElement

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

    Media element

    Returns HTMLElement

    See

    IPlayer.banner

  • set mediaElement(element): void

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

    Media element

    Parameters

    • element: HTMLElement

    Returns void

    See

    IPlayer.banner

mediaPosition

  • get mediaPosition(): number

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

    Current media position [ms]

    Returns number

mediaSourceElement

  • get mediaSourceElement(): HTMLElement

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

    Media source element

    Returns HTMLElement

options

timer

  • get timer(): Timer

  • 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

  • 音量 [0-100]

    Volume [0-100]

    Returns number

  • set volume(val): void

  • 音量 [0-100]

    Volume [0-100]

    Parameters

    • val: number

    Returns void

wait

  • get wait(): number

  • 動画の描画間隔 [ms]

    A time window between rendering frames [ms]

    Returns number

    See

    IPlayer.fps

  • set wait(val): void

  • 動画の描画間隔 [ms]

    A time window between rendering frames [ms]

    Parameters

    • val: number

    Returns void

    See

    IPlayer.fps

Methods

addListener

  • addListener(listener): void

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

    Add event listener

    Parameters

    • listener: any

      イベントリスナ / Event listener

    Returns void

createFromJSON

  • createFromJSON(json, options?): Promise<Video>

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

    Generate video data from JSON

    Parameters

    • json: VideoData

      動画情報 / JSON data to be converted to a video

    • Optional options: PlayerVideoOptions

      オプション / Optional data to build the video object

    Returns Promise<Video>

    動画オブジェクト / Video object

createFromSongPath

  • createFromSongPath(songPath, options?): Promise<Video>

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

    Generate video data from song path

    Parameters

    • songPath: string

      楽曲パス / Song path

    • Optional options: PlayerVideoOptions

      オプション / Optional data to build the video object

    Returns Promise<Video>

    動画オブジェクト / Video object

createFromSongUrl

  • createFromSongUrl(songUrl, options?): Promise<Video>

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

    Generate video data from song URL

    Parameters

    • songUrl: string

      楽曲URL / Song URL

    • Optional options: PlayerVideoOptions

      オプション / Optional data to build the video object

    Returns Promise<Video>

    動画オブジェクト / Video object

createFromText

  • createFromText(text, options?): Promise<Video>

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

    Generate video data from text

    Parameters

    • text: string

      テキスト / Text to show

    • Optional options: PlayerVideoOptions

      オプション / Optional data to build the video object

    Returns Promise<Video>

    動画オブジェクト / Video object

dispose

  • dispose(): void

  • プレイヤーを破棄する

    Dispose this player

    Returns void

endVideoSeek

findBeat

  • findBeat(time, options?): IBeat

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

    Find beat that overlaps with the specified timing

    Parameters

    • time: number

      位置 [ms] / Position [ms]

    • Optional options: FindTimedObjectOptions

      取得オプション / Optional parameters for finding beat

    Returns IBeat

    ビート情報（見つからなければ null） / Beat info (null if not found)

    See

    IDataLoader.findBeat

findBeatChange

  • findBeatChange(startTime, endTime): TimedObjectsInRange<IBeat>

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

    Look for beat transitions in the specified time range

    Parameters

    • startTime: number

      時区間の開始位置 [ms] / Start position [ms]

    • endTime: number

      時区間の終了位置 [ms] / End position [ms]

    Returns TimedObjectsInRange<IBeat>

    ビート情報の変化 / Beat transitions

    See

    IDataLoader.findBeatChange

findChord

  • findChord(time, options?): IChord

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

    Find chord that overlaps with the specified timing

    Parameters

    • time: number

      位置 [ms] / Position [ms]

    • Optional options: FindTimedObjectOptions

      探索オプション / Optional parameters for finding chord

    Returns IChord

    コード進行（見つからなければ null） / Chord info (null if not found)

    See

    IDataLoader.findChord

findChordChange

  • findChordChange(startTime, endTime): TimedObjectsInRange<IChord>

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

    Look for chord progressions in the specified time range

    Parameters

    • startTime: number

      時区間の開始位置 [ms] / Start position [ms]

    • endTime: number

      時区間の終了位置 [ms] / End position [ms]

    Returns TimedObjectsInRange<IChord>

    コード進行の変化 / Chord progressions

    See

    IDataLoader.findChordChange

findChorus

  • findChorus(time, options?): IRepetitiveSegment

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

    Find a chorus part that overlaps with the specified timing

    Parameters

    • time: number

      位置 [ms] / Position [ms]

    • Optional options: FindTimedObjectOptions

      取得オプション / Optional parameters for finding a chorus part

    Returns IRepetitiveSegment

    サビ情報（見つからなければ null） / Chorus part info (null if not found)

    See

    IDataLoader.findChorus

findChorusBetween

findChorusChange

getBeats

  • getBeats(): IBeat[]

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

    Get beats in the current song

    Returns IBeat[]

    ビート情報（見つからなければ空の配列） / Beats (empty array if not found)

    See

    IDataLoader.getBeats

getChords

  • getChords(): IChord[]

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

    Get chord info in the current song

    Returns IChord[]

    コード進行の情報（見つからなければ空の配列） / Chord info (empty array if not found)

    See

    IDataLoader.getChords

getChoruses

getMaxVocalAmplitude

getMedianValenceArousal

getValenceArousal

getVocalAmplitude

removeListener

  • removeListener(listener): boolean

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

    Remove event listener

    Parameters

    • listener: any

      イベントリスナ / Event listener

    Returns boolean

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

requestMediaSeek

  • requestMediaSeek(position): boolean

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

    Seek specified position in the current media

    Parameters

    • position: number

      再生位置 [ms] / Media position [ms]

    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): void

  • Parameters

    • element: HTMLElement

    Returns void

    Deprecated

    Use of Player.setMediaElement is deprecated - set value with IPlayer.mediaElement property instead.

setMediaPosition

  • setMediaPosition(position): Promise<void>

  • Parameters

    • position: number

    Returns Promise<void>

    Deprecated

    Use of Player.setMediaPosition is deprecated - request setting media position with IPlayer.requestMediaSeek instead.

setVideoPosition

  • setVideoPosition(position): Promise<number>

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

    Try setting video position

    Parameters

    • position: number

      再生位置 [ms] / Video position [ms]

    Returns Promise<number>

startVideoSeek

Settings

Member Visibility

Theme

On This Page

constructorappbannerdatafpsisLoadingisPlayingisVideoSeekingmediaBannerElementmediaElementmediaPositionmediaSourceElementoptionstimervideovideoPositionvolumewaitaddListenercreateFromJSONcreateFromSongPathcreateFromSongUrlcreateFromTextdisposeendVideoSeekfindBeatfindBeatChangefindChordfindChordChangefindChorusfindChorusBetweenfindChorusChangegetBeatsgetChordsgetChorusesgetMaxVocalAmplitudegetMedianValenceArousalgetValenceArousalgetVocalAmplituderemoveListenerrequestMediaSeekrequestPauserequestPlayrequestStageUpdaterequestStopsetMediaElementsetMediaPositionsetVideoPositionstartVideoSeek