Player | textalive-app-api

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

IPlayer

Constructors

constructor

new Player(options?: PlayerOptions): Player

- Defined in textalive-app-api.d.ts:3081
see
IPlayer.options

Parameters
- Optional options: PlayerOptions
  
  プレイヤーの初期化オプション / player options
Returns Player

Accessors

app

get app(): IPlayerApp

Implementation of IPlayer.app
- Defined in textalive-app-api.d.ts:2966
TextAlive アプリの状態

TextAlive app status

Returns IPlayerApp

banner

get banner(): IPlayerBanner

Implementation of IPlayer.banner
- Defined in textalive-app-api.d.ts:3064
TextAlive Player の情報を表示する IPlayerBanner インスタンスです。

A banner instance that shows the player info.

Returns IPlayerBanner

data

get data(): IDataLoader

Implementation of IPlayer.data
- Defined in textalive-app-api.d.ts:2975
読み込まれている音楽地図などの情報

Current video materials

Returns IDataLoader

fps

get fps(): number
set fps(val: number): void

Implementation of IPlayer.fps
- Defined in textalive-app-api.d.ts:3028
フレームレート [フレーム数/秒]

Framerate [frames per sec]

Returns number
Implementation of IPlayer.fps
- Defined in textalive-app-api.d.ts:3029
フレームレート [フレーム数/秒]

Framerate [frames per sec]

Parameters
- val: number
Returns void

isLoading

get isLoading(): boolean

Implementation of IPlayer.isLoading
- Defined in textalive-app-api.d.ts:3042
動画（楽曲情報や歌詞など）が読み込み中か否か

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

Returns boolean

isPlaying

get isPlaying(): boolean

Implementation of IPlayer.isPlaying
- Defined in textalive-app-api.d.ts:3046
動画再生中か否か

Whether the video is being played or not

Returns boolean

isVideoSeeking

get isVideoSeeking(): boolean

Implementation of IPlayer.isVideoSeeking
- Defined in textalive-app-api.d.ts:3051
動画シーク中か否か
- 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
Returns boolean

mediaBannerElement

get mediaBannerElement(): HTMLElement

Implementation of IPlayer.mediaBannerElement
- Defined in textalive-app-api.d.ts:3008
音源などに関するバナーの配置先となるDOM要素

Media banner element

Returns HTMLElement

mediaElement

get mediaElement(): HTMLElement
set mediaElement(element: HTMLElement): void

Implementation of IPlayer.mediaElement
- Defined in textalive-app-api.d.ts:2997
音源メディアの配置先となるDOM要素

Media element

Returns HTMLElement
Implementation of IPlayer.mediaElement
- Defined in textalive-app-api.d.ts:2998
音源メディアの配置先となるDOM要素

Media element

Parameters
- element: HTMLElement
Returns void

mediaPosition

get mediaPosition(): number

Implementation of IPlayer.mediaPosition
- Defined in textalive-app-api.d.ts:3013
現在の音源メディアの再生位置 [ms]

Current media position [ms]

Returns number

mediaSourceElement

get mediaSourceElement(): HTMLElement

Implementation of IPlayer.mediaSourceElement
- Defined in textalive-app-api.d.ts:3003
音源メディアの直接の配置先となるDOM要素

Media source element

Returns HTMLElement

options

get options(): PlayerOptions

Implementation of IPlayer.options
- Defined in textalive-app-api.d.ts:2961
プレイヤーの初期化オプション

Player options

Returns PlayerOptions

timer

get timer(): Timer

Implementation of IPlayer.timer
- Defined in textalive-app-api.d.ts:3069
TextAlive Player の音源の再生状態を管理する Timer インスタンスです。

A timer instance that controls the player status.

Returns Timer

video

get video(): Video

Implementation of IPlayer.video
- Defined in textalive-app-api.d.ts:2982
動画オブジェクト

Current video object

Returns Video

videoPosition

get videoPosition(): number

Implementation of IPlayer.videoPosition
- Defined in textalive-app-api.d.ts:3018
現在の動画の再生位置 [ms]

Current video position [ms]

Returns number

volume

get volume(): number
set volume(val: number): void

Implementation of IPlayer.volume
- Defined in textalive-app-api.d.ts:3075
音量 [0-100]

Volume [0-100]

Returns number
Implementation of IPlayer.volume
- Defined in textalive-app-api.d.ts:3074
音量 [0-100]

Volume [0-100]

Parameters
- val: number
Returns void

wait

get wait(): number
set wait(val: number): void

Implementation of IPlayer.wait
- Defined in textalive-app-api.d.ts:3023
動画の描画間隔 [ms]

A time window between rendering frames [ms]

Returns number
Implementation of IPlayer.wait
- Defined in textalive-app-api.d.ts:3024
動画の描画間隔 [ms]

A time window between rendering frames [ms]

Parameters
- val: number
Returns void

Methods

addListener

addListener(listener: PlayerListener): void

Implementation of IPlayer.addListener
- Defined in textalive-app-api.d.ts:3087
イベントリスナを登録する

Add event listener

Parameters
- listener: PlayerListener
  
  イベントリスナ / Event listener
Returns void

createFromJSON

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

Implementation of IPlayer.createFromJSON
- Defined in textalive-app-api.d.ts:3118
動画情報を表すデータ（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: string, options?: PlayerVideoOptions): Promise<Video>

Implementation of IPlayer.createFromSongPath
- Defined in textalive-app-api.d.ts:3104
楽曲パス（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: string, options?: PlayerVideoOptions): Promise<Video>

Implementation of IPlayer.createFromSongUrl
- Defined in textalive-app-api.d.ts:3099
楽曲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: string, options?: PlayerVideoOptions): Promise<Video>

Implementation of IPlayer.createFromText
- Defined in textalive-app-api.d.ts:3113
テキストからダミーの音楽地図情報と動画データを生成する

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

Implementation of IPlayer.dispose
- Defined in textalive-app-api.d.ts:3219
プレイヤーを破棄する

Dispose this player

Returns void

endVideoSeek

endVideoSeek(): void

Implementation of IPlayer.endVideoSeek
- Defined in textalive-app-api.d.ts:3208
動画のシーク操作を終える
- 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
Returns void

findBeat

findBeat(time: number, options?: FindTimedObjectOptions): IBeat

Implementation of IPlayer.findBeat
- Defined in textalive-app-api.d.ts:3143
指定された位置のビート情報を取得する

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）

findChord

findChord(time: number, options?: FindTimedObjectOptions): IChord

Implementation of IPlayer.findChord
- Defined in textalive-app-api.d.ts:3151
指定された位置のコード進行を取得する

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）

findChorus

findChorus(time: number, options?: FindTimedObjectOptions): IRepetitiveSegment

Implementation of IPlayer.findChorus
- Defined in textalive-app-api.d.ts:3131
指定された位置のサビ情報を取得する

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）

findChorusBetween

findChorusBetween(startTime: number, endTime: number): IRepetitiveSegment

Implementation of IPlayer.findChorusBetween
- Defined in textalive-app-api.d.ts:3135
Parameters
- startTime: number
- endTime: number
Returns IRepetitiveSegment

getBeats

getBeats(): IBeat[]

Implementation of IPlayer.getBeats
- Defined in textalive-app-api.d.ts:3139
楽曲中のビートに関する情報を取得する

Get beats in the current song

Returns IBeat[]
ビート情報（見つからなければ空の配列）

getChords

getChords(): IChord[]

Implementation of IPlayer.getChords
- Defined in textalive-app-api.d.ts:3147
楽曲中のコード進行に関する情報を取得する

Get chord info in the current song

Returns IChord[]
コード進行の情報（見つからなければ空の配列）

getChoruses

getChoruses(): IRepetitiveSegment[]

Implementation of IPlayer.getChoruses
- Defined in textalive-app-api.d.ts:3127
楽曲中のサビに関する情報を取得する

Get chorus parts in the current song

Returns IRepetitiveSegment[]
サビ情報（見つからなければ空の配列）

getMaxVocalAmplitude

getMaxVocalAmplitude(): number

Implementation of IPlayer.getMaxVocalAmplitude
- Defined in textalive-app-api.d.ts:3160
楽曲中の最大声量を取得する
- 取得するには、あらかじめプレイヤー初期化オプション PlayerOptions.vocalAmplitudeEnabled を true にセットしておく必要があります
Get maximum vocal amplitude
- Constructor option PlayerOptions.vocalAmplitudeEnabled needs to be true
Returns number
最大声量

getMedianValenceArousal

getMedianValenceArousal(): ValenceArousalValue

Implementation of IPlayer.getMedianValenceArousal
- Defined in textalive-app-api.d.ts:3168
V/A空間中の座標遷移の中央値を取得する
- 取得するには、あらかじめプレイヤー初期化オプション PlayerOptions.valenceArousalEnabled を true にセットしておく必要があります
Get median valence arousal value throughout the song
- Constructor option PlayerOptions.valenceArousalEnabled needs to be true
Returns ValenceArousalValue
座標値

getValenceArousal

getValenceArousal(time: number): ValenceArousalValue

Implementation of IPlayer.getValenceArousal
- Defined in textalive-app-api.d.ts:3164
指定された位置のV/A空間中の座標を取得する
- 取得するには、あらかじめプレイヤー初期化オプション PlayerOptions.valenceArousalEnabled を true にセットしておく必要があります
Get valence arousal value at the specified timing
- Constructor option PlayerOptions.valenceArousalEnabled needs to be true
Parameters
- time: number
  
  位置 [ms] / Position [ms]
Returns ValenceArousalValue
座標値

getVocalAmplitude

getVocalAmplitude(time: number): number

Implementation of IPlayer.getVocalAmplitude
- Defined in textalive-app-api.d.ts:3156
指定された位置の声量を取得する
- 取得するには、あらかじめプレイヤー初期化オプション 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
Parameters
- time: number
  
  位置 [ms] / Position [ms]
Returns number
声量

removeListener

removeListener(listener: PlayerListener): boolean

Implementation of IPlayer.removeListener
- Defined in textalive-app-api.d.ts:3091
イベントリスナを削除する

Remove event listener

Parameters
- listener: PlayerListener
  
  イベントリスナ / Event listener
Returns boolean
削除の成否 / Whether the listener was successfully removed or not

requestMediaSeek

requestMediaSeek(position: number): boolean

Implementation of IPlayer.requestMediaSeek
- Defined in textalive-app-api.d.ts:3200
楽曲の再生位置を指定する

Seek specified position in the current media

Parameters
- position: number
  
  再生位置 [ms] / Media position [ms]
Returns boolean

requestPause

requestPause(): boolean

Implementation of IPlayer.requestPause
- Defined in textalive-app-api.d.ts:3196
楽曲の再生を一時停止する

Pause playing music

Returns boolean
一時停止の成否

requestPlay

requestPlay(): boolean

Implementation of IPlayer.requestPlay
- Defined in textalive-app-api.d.ts:3188
楽曲の再生を開始する

Start playing music

Returns boolean
開始の成否

requestStageUpdate

requestStageUpdate(): Promise<number>

Implementation of IPlayer.requestStageUpdate
- Defined in textalive-app-api.d.ts:3214
動画の現在のフレームを強制的に再描画する

Force rendering current frame

Returns Promise<number>
動画の現在位置 [ms] / Video position [ms]

requestStop

requestStop(): boolean

Implementation of IPlayer.requestStop
- Defined in textalive-app-api.d.ts:3192
楽曲の再生を停止する（一時停止したうえで先頭に巻き戻しする）

Stop playing music (pause and then seek the beginning)

Returns boolean
停止の成否

setMediaElement

setMediaElement(element: HTMLElement): void

- Defined in textalive-app-api.d.ts:3175
deprecated
Use of Player.setMediaElement is deprecated - set value with IPlayer.mediaElement property instead.

Parameters
- element: HTMLElement
Returns void

setMediaPosition

setMediaPosition(position: number): Promise<void>

- Defined in textalive-app-api.d.ts:3184
deprecated
Use of Player.setMediaPosition is deprecated - request setting media position with IPlayer.requestMediaSeek instead.

Parameters
- position: number
Returns Promise<void>

setVideoPosition

setVideoPosition(position: number): Promise<number>

Implementation of IPlayer.setVideoPosition
- Defined in textalive-app-api.d.ts:3180
動画の再生位置を指定する

Try setting video position

Parameters
- position: number
  
  再生位置 [ms] / Video position [ms]
Returns Promise<number>

startVideoSeek

startVideoSeek(): void

Implementation of IPlayer.startVideoSeek
- Defined in textalive-app-api.d.ts:3204
動画のシーク操作を始める
- 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
Returns void

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Optional options: PlayerOptions

Returns Player

Accessors

app

Returns IPlayerApp

banner

Returns IPlayerBanner

data

Returns IDataLoader

fps

Returns number

Parameters

val: number

Returns void

isLoading

Returns boolean

isPlaying

Returns boolean

isVideoSeeking

Returns boolean

mediaBannerElement

Returns HTMLElement

mediaElement

Returns HTMLElement

Parameters

element: HTMLElement

Returns void

mediaPosition

Returns number

mediaSourceElement

Returns HTMLElement

options

Returns PlayerOptions

timer

Returns Timer

video

Returns Video

videoPosition

Returns number

volume

Returns number

Parameters

val: number

Returns void

wait

Returns number

Parameters

val: number

Returns void

Methods

addListener

Parameters

listener: PlayerListener

Returns void

createFromJSON

Parameters

json: VideoData

Optional options: PlayerVideoOptions

Returns Promise<Video>

createFromSongPath

Parameters

songPath: string

Optional options: PlayerVideoOptions

Returns Promise<Video>

createFromSongUrl

Parameters

songUrl: string

Optional options: PlayerVideoOptions

Returns Promise<Video>

createFromText

Parameters