Class SongleTimer

constructor

• new SongleTimer(options?): SongleTimer

• Parameters

  • Optional options: SongleTimerOptions

  Returns SongleTimer

wait

isPlaying

• get isPlaying(): boolean

• 再生中かどうか

  Whether the music source is being played or not

  Returns boolean

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

songlePlayer

• get songlePlayer(): SonglePlayer

• Songleのプレイヤーインスタンスです。

  Returns SonglePlayer

  See

  https://api.songle.jp/references/javascript#Player

withSync

• get withSync(): boolean

• Songle Sync の機能が有効化されているか否か

  Whether Songle Sync feature is enabled or not

  Returns boolean

  See

  https://api.songle.jp/sync

dispose

• dispose(): void

• この Timer を破棄する

  Dispose this Timer instance

  Returns void

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>

pause

• pause(): void

• 再生を一時停止する

  Pause music playback

  Returns void

play

• play(): void

• 再生を開始する

  Start music playback

  Returns void

seek

• seek(time): void

• 再生位置を指定する

  Seek specified position in the current music playback

  Parameters

  • time: number

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

  Returns void

stop

• stop(): void

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

  Stop music playback (pause and then seek the beginning)

  Returns void