リファレンス p5.MediaElement

p5.MediaElement

オーディオとビデオを扱うためのクラスです。

p5.MediaElementp5.Elementを拡張し、 オーディオとビデオを扱うためのメソッドを提供します。p5.MediaElementオブジェクトは createVideocreateAudiocreateCaptureを呼び出すことで作成されます。

実例

シンタックス

p5.MediaElement(elt)

パラメーター

elt
String:

ラップされるDOMノード

フィールド

src

メディア要素のソースへのパスを文字列として表します。

メソッド

play

メディア要素からオーディオまたはビデオを再生します。

stop

メディア要素を停止し、その現在の時間を0に設定します。

media.play()を呼び出すと、オーディオ/ビデオの再生が最初から再開されます。

pause

メディア要素を一時停止します。

media.play()を呼び出すと、一時停止した瞬間からオーディオ/ビデオの再生が再開されます。

loop

オーディオ/ビデオをループで繰り返し再生します。

noLoop

オーディオ/ビデオのループ再生を停止します。

メディアは再生が終了すると停止します。

autoplay

オーディオ/ビデオが読み込まれたら自動再生するように設定します。

パラメータshouldAutoplayはオプションです。引数なしで media.autoplay()を呼び出すと、メディアは自動的に再生されます。 media.autoplay(true)のようにtrueを渡すと、 メディアは自動的に再生されます。media.autoPlay(false)のように falseを渡すと、自動再生されません。

volume

オーディオ/ビデオの音量を設定します。

引数なしでmedia.volume()を呼び出すと、現在の音量を 0(オフ)から1(最大)の範囲の数値として返します。

パラメータvalはオプションです。0(オフ)から1(最大)の範囲の 数値で音量を設定します。例えば、media.volume(0.5)を呼び出すと、 音量が最大の半分に設定されます。

speed

オーディオ/ビデオの再生速度を設定します。

パラメータvalはオプションです。再生速度を設定する数値です。 1は通常速度で再生、0.5は半分の速度、2は2倍の速度で再生します。 -1は通常速度で逆再生します。

media.speed()を呼び出すと、現在の速度を数値として返します。

注意:すべてのブラウザが逆再生をサポートしているわけではありません。 サポートしていても、再生がスムーズでない場合があります。

time

メディア要素の再生時間を設定します。

パラメータtimeはオプションです。再生開始時にジャンプする 時間を秒単位で指定する数値です。

引数なしでmedia.time()を呼び出すと、オーディオ/ビデオが 再生された秒数を返します。

注意:ループするメディアが再開すると、時間は0にリセットされます。

duration

オーディオ/ビデオの長さを秒単位で返します。

onended

オーディオ/ビデオの再生が終了したときに呼び出される関数を設定します。

要素がコールバック関数の引数として渡されます。

注意:メディアがループしている場合、この関数は呼び出されません。

connect

要素のオーディオを出力に送ります。

パラメータaudioNodeは、AudioNodeまたは p5.soundライブラリのオブジェクトを指定できます。

myElement.connect()のように要素が提供されない場合、 要素はメイン出力に接続されます。すべての接続は .disconnect()メソッドで解除されます。

注意:このメソッドはp5.sound.jsアドオンライブラリと一緒に使用することを想定しています。

disconnect

メイン出力を含むすべてのWeb Audioルーティングを切断します。

これは、例えばオーディオエフェクトを通して出力を再ルーティングしたい場合に 便利です。

showControls

デフォルトの HTMLMediaElement コントロールを表示します。

注意:コントロールはWebブラウザによって異なります。

hideControls

デフォルトの HTMLMediaElement コントロールを非表示にします。

addCue

オーディオ/ビデオの再生中に特定の時間に関数を呼び出すようにスケジュールします。

最初のパラメータtimeは、関数を実行する時間を秒単位で指定します。 この値はcallbackの最初の引数として渡されます。

2番目のパラメータcallbackは、指定されたキュー時間に呼び出す関数です。

3番目のパラメータvalueはオプションで、任意の型の値を指定できます。 valuecallbackに渡されます。

media.addCue()を呼び出すと、文字列としてIDが返されます。これは 後でキューを削除する際に便利です。

removeCue

IDに基づいてコールバックを削除します。

clearCues

media.addCue()でスケジュールされたすべての関数を削除します。

Notice any errors or typos? Please let us know. Please feel free to edit src/dom/dom.js and open a pull request!

関連するリファレンス