Class BasicTimer

Basic timer

もっともシンプルな Timer の実装:

音源を再生しません
デバッグ時などに有用です

The simplest Timer implementation:

No audio elements are embedded (thus no sound playback)
Useful for debugging

Implements

Timer

Index

Constructors

Accessors

isPlaying position wait

Methods

dispose initialize pause play seek stop

Constructors

constructor

new BasicTimer(): BasicTimer
Returns BasicTimer
- Defined in textalive-app-api.d.ts:25

Accessors

isPlaying

get isPlaying(): boolean
再生中かどうか

Whether the music source is being played or not

Returns boolean
Implementation of Timer.isPlaying
- Defined in textalive-app-api.d.ts:22

position

get position(): number
現在の再生位置 [ms]

Timer 実装クラスはこの値をリアルタイムに計算して返さなくてはなりません。他にも再生位置を返す API が以下の2種類用意されていますが、実装手法の違いにより、この API が常に最も精確な値を返します。
- IPlayer.mediaPosition は Timer 実装クラスによって定期的に更新されます
- IPlayer.videoPosition は Player が定期的に呼び出す IRenderingUnit.animate が成功してから更新されます
この API を利用するアプリでは、動画のシーク操作に対応するために PlayerEventListener.onVideoSeekStart PlayerEventListener.onVideoSeek PlayerEventListener.onVideoSeekEnd イベントを適切にハンドルする必要があります。

Current playback position [ms]

Timer implementations need to calculate this property value in real time. While there are two other APIs to retrieve the current playback position as follows, this one returns the most precise value.
- IPlayer.mediaPosition is updated by Timer implementations periodically
- IPlayer.videoPosition is updated by Player after the periodic call to IRenderingUnit.animate
Applications utilizing this API need to handle PlayerEventListener.onVideoSeekStart PlayerEventListener.onVideoSeek PlayerEventListener.onVideoSeekEnd events appropriately so that the applications respond to the video seeking operation.
Returns number
Implementation of Timer.position
- Defined in textalive-app-api.d.ts:24

wait

get wait(): number
再生位置情報の更新間隔 [ms]

Interval for updating playback position [ms]

Returns number
Implementation of Timer.wait
- Defined in textalive-app-api.d.ts:19
set wait(val): void
再生位置情報の更新間隔 [ms]

Interval for updating playback position [ms]
Parameters
- val: number
Returns void
Implementation of Timer.wait
- Defined in textalive-app-api.d.ts:20

Methods

dispose

dispose(): void
この Timer を破棄する

Dispose this Timer instance

Returns void
Implementation of Timer.dispose
- Defined in textalive-app-api.d.ts:37

initialize

initialize(__namedParameters): Promise<void>
Timer の初期化（動画データの読み込みプロセスで一度だけ呼ばれます）

Initialize this Timer instance (called during the video data loading process)
Parameters
- __namedParameters: TimerInitOptions
  初期化オプション / Options for initalization process
Returns Promise<void>
Implementation of Timer.initialize
- Defined in textalive-app-api.d.ts:27

pause

pause(): void
再生を一時停止する

Pause music playback

Returns void
Implementation of Timer.pause
- Defined in textalive-app-api.d.ts:33

play

play(): void
再生を開始する

Start music playback

Returns void
Implementation of Timer.play
- Defined in textalive-app-api.d.ts:29

seek

seek(time): void
再生位置を指定する

Seek specified position in the current music playback
Parameters
- time: number
  再生位置 [ms] / Media position [ms]
Returns void
Implementation of Timer.seek
- Defined in textalive-app-api.d.ts:35

stop

stop(): void
再生を停止する（一時停止したうえで先頭に巻き戻しする）

Stop music playback (pause and then seek the beginning)

Returns void
Implementation of Timer.stop
- Defined in textalive-app-api.d.ts:31