オーディオ
PlayCanvasは、ブラウザーのWeb Audio APIを通してオーディオを再生します。Soundコンポーネントを持つエンティティは音源です。そのエンティティが出せるサウンドを保持し、エンティティの位置からそれらを再生します。Audio Listenerコンポーネントを持つエンティティはシーンの耳にあたり、通常はカメラです。
Positional Sound
上の例を読み込んでから、その中をクリックしてください。ブラウザーは、ユーザーがページを操作するまでオーディオをオフにしています。ロボットの足音はロボットの位置から鳴るので、ロボットがカメラの周りを歩くにつれて、片方の耳からもう片方の耳へ移り、距離に応じて減衰します。各環境での使い方で、同じものを各環境でどう設定するかを比べられます。
オーディオの仕組み
- オーディオアセット は、サウンドを保持します。オーディオファイルは読み込み時にすべてデコードされるので、再生を指示した瞬間に鳴ります。
- Soundコンポーネント は、エンティティを音源にします。その音量とピッチは、エンティティが再生するすべてのサウンドに適用されます。
- サウンドスロット は、Soundコンポーネントが持つ、名前の付いたサウンドです。各スロットは、1つのオーディオアセット、またはその一部を、独自の音量とピッチで再生し、ループや自動再生もできます。
- サウンドインスタンス は、再生中のサウンドです。スロットは再生のたびにインスタンスを作成し、そのインスタンスに対して、一時停止、シーク、フェード、イベントの受け取りができます。
- ポジショナルオーディオ は、エンティティがオーディオリスナーから見てどこにあるかに応じて、サウンドをスピーカーの間でパンし、距離に応じて減衰させます。
- マスター音量 は、アプリケーション内のすべてのサウンドの音量に掛けられます。エフェクト(フィルターやリバーブなど)は、スロットの出力に追加するWeb Audioノードで実現します。
ウェブ上のオーディオ機能はすべて、1つのルールに左右されます。ユーザーがページを操作するまで、ページは音を出せません。PlayCanvasは、最初のクリックまたはタップでオーディオを開始します。これが音楽や、読み込み時に再生するサウンドにとって何を意味するかは、自動再生とユーザー操作で説明しています。
各環境での使い方
Soundコンポーネントはどこでも同じですが、環境によって公開されている範囲が異なります。その環境にマークアップやUIが用意されていない機能には、コードからエンジンのコンポーネントを通してアクセスできます。
| Engine | Editor | React | Web Components | |
|---|---|---|---|---|
| サウンドを読み込む | audioアセット | オーディオファイルをアップロードする | コードからaudioアセット | <pc-asset> |
| エンティティを音源にする | entity.addComponent('sound') | Soundコンポーネント | エンジンAPI | <pc-sound> |
| 音源にサウンドを与える | entity.sound.addSlot() | Soundコンポーネントのスロット | エンジンAPI | <pc-sound-slot> |
| 再生、一時停止、停止 | entity.sound.play() | スクリプトから | エンジンAPI | エンジンAPI |
| リスナーを配置する | entity.addComponent('audiolistener') | Audio Listenerコンポーネント | エンジンAPI | <pc-audio-listener> |
| マスター音量とエフェクト | app.systems.sound | スクリプトから | エンジンAPI | エンジンAPI |
注記
PlayCanvas Reactには、サウンド用の独自のコンポーネントがまだありません。その<Application>にはエンジンのサウンドシステムが含まれているので、自作の小さなコンポーネントから、エンティティにSoundコンポーネントを追加します。このセクションの各ページで、その方法を示しています。
このセクションの内容
- はじめに - サウンドの読み込み、Soundコンポーネントの追加、最初のサウンドの再生。
- オーディオアセット - フォーマット、サウンドが使うメモリの量、ループ、長い音楽、オーディオスプライト。
- サウンドの再生 - スロット、ループ、ワンショットサウンドのオーバーラップ、ファイルの一部の再生、音量とピッチ。
- 再生の制御 - サウンドインスタンス、一時停止、シーク、イベント、フェード、クロスフェード。
- ポジショナルオーディオ - オーディオリスナー、距離モデル、パンニング。
- 音量とミキシング - マスター音量、ミュート、音楽と効果音のミキシング、ダッキング。
- エフェクトと解析 - Web Audioノードによるフィルター、エコー、リバーブと、ビジュアライザー向けのサウンドの読み取り。
- 自動再生とユーザー操作 - オーディオがクリックを待つ理由と、それを踏まえた設計の方法。
- トラブルシューティング - 何も聞こえないときや、想定外の音が聞こえるときに確認すること。
関連情報
- SoundコンポーネントとAudio Listenerコンポーネント - エディターでのこれらのコンポーネントのリファレンス
- オーディオアセット - エディターでのオーディオアセットのプレビュー
<pc-sound>、<pc-sound-slot>、<pc-audio-listener>- Web Componentsのリファレンス- Basic Audio - エディターでサウンドとリスナーを設定するチュートリアル
- SoundComponent、SoundSlot、SoundInstance - エンジンのAPIリファレンス