メインコンテンツまでスキップ

はじめに

サウンドの再生には、3つのものが必要です。サウンドを保持するオーディオアセット、エンティティを音源にするSoundコンポーネント、そして、サウンドに名前を付けてアセットを再生する、そのコンポーネントのスロットです。このページでは、この3つをすべて用意して、ベルを鳴らします。

アプリケーションのセットアップ​

エディター、React、Web Componentsでは、サウンドはそのまま使えます。AppBaseから構築するエンジンアプリには、登録した機能だけが含まれるので、サウンドマネージャー、Soundコンポーネントシステム、オーディオファイルを読み込むハンドラーを与えます。

const options = new AppOptions();
options.soundManager = new SoundManager();
options.componentSystems = [SoundComponentSystem, AudioListenerComponentSystem];
options.resourceHandlers = [AudioHandler];

AudioListenerComponentSystemが必要になるのは、ポジショナルオーディオを使う場合だけです。システムとハンドラーの完全な一覧については、バンドルサイズとツリーシェイキングを参照してください。

サウンドを再生する​

ファイルをaudioアセットとして読み込み、エンティティにSoundコンポーネントを追加し、アセットを再生するスロットを追加して、そのスロットを名前で再生します。

// オーディオファイルを読み込みます
const asset = new Asset('bell', 'audio', {
url: 'https://developer.playcanvas.com/assets/bell.mp3'
});
app.assets.add(asset);
app.assets.load(asset);

// エンティティを音源にし、アセットを再生するスロットを与えます
const bell = new Entity('bell');
bell.addComponent('sound', { positional: false });
bell.sound.addSlot('ring', { asset: asset.id });
app.root.addChild(bell);

// スロットを再生します
bell.sound.play('ring');

アセットの読み込みを待つ必要はありません。アセットの読み込みが終わる前に再生したスロットは、アセットが届いた時点で再生が始まります。

Soundコンポーネントは、デフォルトでポジショナルです。エンティティの位置からサウンドを再生し、オーディオリスナーからの距離に応じて減衰させます。このページの例では、これをオフにしています。音楽やインターフェースのサウンドなど、カメラがどこにあっても同じように聞こえるべきサウンドには、この設定が適しています。

最初のクリック​

ブラウザーは、ユーザーがページを操作するまで、ページが音を出すことを許可しません。それまでオーディオシステムはロックされており、再生したものはすべて保留されます。PlayCanvasは、ページ内のどこかで最初にクリック、タップ、またはマウスボタンの押下が行われた時点で、オーディオのロックを解除します。

クリックに応じて再生するサウンドは、影響を受けません。そのクリック自体がオーディオのロックを解除するからです。BGMのように読み込み時に再生するサウンドは、読み込み時ではなく、最初のクリックの時点で始まります。詳しくは、自動再生とユーザー操作を参照してください。

例​

このエンジンアプリは、ベルのサウンドを読み込み、1つのスロットを持つSoundコンポーネントを球体に与え、キャンバスをクリックするたびにベルを鳴らします。

ライブサンプル
import {
AppBase,
AppOptions,
Asset,
AudioHandler,
CameraComponentSystem,
Color,
createGraphicsDevice,
DEVICETYPE_WEBGPU,
Entity,
FILLMODE_FILL_WINDOW,
LightComponentSystem,
RenderComponentSystem,
RESOLUTION_AUTO,
SoundComponentSystem,
SoundManager,
StandardMaterial
} from 'playcanvas';

// 使用するコンポーネントシステムとリソースハンドラーを指定してアプリケーションを作成します
const canvas = document.getElementById('application');
const device = await createGraphicsDevice(canvas, {
deviceTypes: [DEVICETYPE_WEBGPU]
});
device.maxPixelRatio = Math.min(window.devicePixelRatio, 2);

const options = new AppOptions();
options.graphicsDevice = device;
options.soundManager = new SoundManager();
options.componentSystems = [
RenderComponentSystem,
CameraComponentSystem,
LightComponentSystem,
SoundComponentSystem
];
options.resourceHandlers = [AudioHandler];

const app = new AppBase(canvas);
app.init(options);
app.setCanvasFillMode(FILLMODE_FILL_WINDOW);
app.setCanvasResolution(RESOLUTION_AUTO);
window.addEventListener('resize', () => app.resizeCanvas());
app.start();

app.scene.ambientLight = new Color(0.35, 0.35, 0.4);

// オーディオアセットであるベルを読み込みます
const asset = new Asset('bell', 'audio', {
url: 'https://developer.playcanvas.com/assets/bell.mp3'
});
await new Promise((resolve) => {
asset.ready(resolve);
app.assets.add(asset);
app.assets.load(asset);
});

const camera = new Entity('camera');
camera.addComponent('camera', {
clearColor: new Color(0.11, 0.12, 0.17)
});
camera.setPosition(0, 0, 4);
app.root.addChild(camera);

const light = new Entity('light');
light.addComponent('light');
light.setEulerAngles(48, 38, 0);
app.root.addChild(light);

// ベルは、Soundコンポーネントと、アセットを再生する1つのスロットを持つ球体です
const material = new StandardMaterial();
material.diffuse = new Color(0.95, 0.7, 0.2);
material.update();

const bell = new Entity('bell');
bell.addComponent('render', { type: 'sphere', material });
bell.addComponent('sound', { positional: false });
bell.sound.addSlot('ring', { asset: asset.id });
app.root.addChild(bell);

// クリックするとベルを鳴らし、鳴ったことがわかるように球体を膨らませます
let swell = 0;
canvas.addEventListener('click', () => {
bell.sound.play('ring');
swell = 1;
});
app.on('update', (dt) => {
swell = Math.max(0, swell - dt * 3);
bell.setLocalScale(1 + swell * 0.3, 1 + swell * 0.3, 1 + swell * 0.3);
});

const label = document.createElement('div');
label.style.cssText = 'position: absolute; left: 12px; bottom: 10px; color: #ccc; font: 14px sans-serif; pointer-events: none;';
label.textContent = 'Click to ring the bell.';
document.body.appendChild(label);

次のことを試してみてください。

  • スロットのオプションにpitch: 0.5を追加すると、1オクターブ低いベルが鳴ります。
  • すばやくクリックしてみてください。スロットは、オーバーラップに設定しないかぎり一度に1つのサウンドしか再生しないので、クリックのたびに直前のベルの音が途中で切れます。スロットのオプションにoverlap: trueを追加すると、ベルの音が重なっていきます。サウンドの再生を参照してください。
  • positional: falseを削除します。この時点では何も変わりません。オーディオリスナーのないアプリケーションはワールドの原点で音を聞き、ベルもそこにあるからです。次に、bell.setPosition(3, 0, 0)でベルを動かすと、右から聞こえます。

関連情報​