AudioPlayer
audioPlayerは音声プレイヤーを扱うクラスです。audioPlayerを介して音声プレイヤーを操作することができます。
Methods
clear()
clear() : void
仕様
プレイヤーそのものを削除します。
引数
なし
戻り値
なし
focus()
focus() : void
仕様
プレイヤーをフォーカスします。
引数
なし
戻り値
なし
mute()
mute() : void
仕様
プレイヤーをミュートにします。
引数
なし
戻り値
なし
unmute()
unmute() : void
仕様
プレイヤーのミュートを解除します。
引数
なし
戻り値
なし
isMuted()
isMuted() : boolean
仕様
プレイヤーがミュート状態かどうかを返します。
引数
なし
戻り値
boolean (ミュート状態ならtrue, ミュート状態でなければfalse)
play()
play() : void
仕様
プレイヤーを再生します。
webの仕様によりplayメソッドが効かない場合があります。
詳細はMDN: メディアとウェブの自動再生ガイドを参照してください。
引数
なし
戻り値
なし
isPlaying()
isPlaying() : boolean
仕様
プレイヤーが再生中かどうかを返します。
引数
なし
戻り値
boolean (プレイヤーが再生中ならtrue, 再生中でなければfalse)
pause()
pause() : void
仕様
プレイヤーを一時停止状態にします。
引数
なし
戻り値
なし
isPaused()
isPaused() : boolean
仕様
プレイヤーが一時停止中かどうかを返します。
引数
なし
戻り値
boolean (プレイヤーが一時停止中ならtrue, 一時停止中でなければfalse)
isEnded()
isEnded() : boolean
仕様
再生が完了しているかどうかを返します。
引数
なし
戻り値
boolean (再生が完了している場合はtrue, 完了していない場合はfalse)
hide()
hide() : void
仕様
プレイヤーを非表示にします。
引数
なし
戻り値
なし
show()
show() : void
仕様
hideメソッドによって非表示になったプレイヤーを表示します。
引数
なし
戻り値
なし
on()
on(type, fn) : void
仕様
指定したイベントに対してイベントリスナーを登録します。
指定できるイベントはAudioPlayerEventsにあるイベントです。
引数
| 引数 | 型 |
|---|---|
| type | AudioPlayerEvents |
| fn | (event: AudioPlayerEvents) => void |
戻り値
なし
off()
off(type, fn) : void
仕様
指定したイベントに登録されているイベントリスナーを削除します。
指定できるイベントはAudioPlayerEventsにあるイベントです。
引数
| 引数 | 型 |
|---|---|
| type | AudioPlayerEvents |
| fn | (event: AudioPlayerEvents) => void |
戻り値
なし
offの引数として渡す関数は、「offした時に実行される関数」ではなく、「onで登録した関数」です。
また、イベントリスナーに登録・解除する関数は同じ参照元でないといけません。
// OK
const fn = () => console.log('pause');
player.videoPlayer.on(Millvi.VideoPlayerEvents.Pause, fn)
player.videoPlayer.off(Millvi.VideoPlayerEvents.Pause, fn)
// NG
player.videoPlayer.on(Millvi.VideoPlayerEvents.Pause, () => console.log('pause'))
player.videoPlayer.off(Millvi.VideoPlayerEvents.Pause, () => console.log('pause'))
one()
one(type, fn) : void
仕様
指定したイベントに対して一度だけ実行されるイベントリスナーを登録します。
指定できるイベントはAudioPlayerEventsにあるイベントです。
引数
| 引数 | 型 |
|---|---|
| type | AudioPlayerEvents |
| fn | (event: AudioPlayerEvents) => void |
戻り値
なし
trigger()
trigger(type, param?) : void
仕様
指定したイベントに登録されているイベントリスナーを実行します。
イベントリスナー実行時の引数としてparamを設定するとができます。
指定できるイベントはAudioPlayerEventsにあるイベントです。
引数
| 引数 | 型 | 説明 |
|---|---|---|
| type | AudioPlayerEvents | - |
| param | any | 省略可 |
戻り値
なし
showMessage()
showMessage() : void
仕様
プレイヤーにメッセージを表示します。
メッセージが表示されている間は音声を再生できなくなります。
circleタイプのaudioPlayerでは使用できません。
引数
なし
戻り値
なし
hideMessage()
hideMessage() : void
仕様
プレイヤーに表示されているメッセージを非表示にします。
circleタイプのaudioPlayerでは使用できません。
引数
なし
戻り値
なし
Property
volume
volume : number
プレイヤーの音量
volumeは0から1の間で設定してください
現在の音量を取得
Millvi.MillviPlayer.audioPlayer.volume
音量を設定
Millvi.MillviPlayer.audioPlayer.volume = 0.5
currentTime
currentTime : number
現在の再生時間(秒)
現在の再生時間を取得
Millvi.MillviPlayer.audioPlayer.currentTime
再生時間を設定(指定した再生時間に遷移)
Millvi.MillviPlayer.audioPlayer.currentTime = 60
duration
duration : number
プレイヤーの総再生時間
総再生時間を取得
Millvi.MillviPlayer.audioPlayer.duration
playbackRate
playbackRate : number
倍速設定
現在の倍速設定を取得
const playbackRate = Millvi.MillviPlayer.audioPlayer.playbackRate
指定した速度に設定
Millvi.MillviPlayer.audioPlayer.playbackRate = 1.5