Akashic Engine
    Preparing search index...

    Interface AudioPlayer

    サウンド再生を行うインターフェース。

    本クラスのインスタンスは、 AudioSystem#createPlayer() によって明示的に、 または AudioAsset#play() によって暗黙的に生成される。 ゲーム開発者は本クラスのインスタンスを直接生成すべきではない。

    interface AudioPlayer {
        currentAudio: undefined | AudioAsset;
        onPlay: Trigger<AudioPlayerEvent>;
        onStop: Trigger<AudioPlayerEvent>;
        played: Trigger<AudioPlayerEvent>;
        stopped: Trigger<AudioPlayerEvent>;
        volume: number;
        canHandleStopped(): boolean;
        changeVolume(volume: number): void;
        play(audio: AudioAsset): void;
        stop(): void;
    }
    Index

    Properties

    currentAudio onPlay onStop played stopped volume

    Methods

    canHandleStopped changeVolume play stop

    Properties

    currentAudio: undefined | AudioAsset

    再生中のオーディオアセット。 再生中のものがない場合、 undefined 。

    onPlay: Trigger<AudioPlayerEvent>

    play() が呼び出された時に通知される Trigger 。

    onStop: Trigger<AudioPlayerEvent>

    stop() が呼び出された時に通知される Trigger 。

    played: Trigger<AudioPlayerEvent>

    play() が呼び出された時に通知される Trigger 。

    非推奨である。将来的に削除される。代わりに onPlay を利用すること。

    stopped: Trigger<AudioPlayerEvent>

    stop() が呼び出された時に通知される Trigger 。

    非推奨である。将来的に削除される。代わりに onStop を利用すること。

    volume: number

    音量。

    0 (無音) 以上 1.0 (最大) 以下の数値である。 この値は参照のためにのみ公開されている。ゲーム開発者はこの値を変更してはならない。 音量を変更したい場合、 changeVolume() メソッドを用いること。

    Methods

    • 音声の終了を検知できるか否か。 通常、ゲーム開発者がこのメソッドを利用する必要はない。

      Returns boolean

    • 音量を変更する。

      Parameters

      • volume: number

        音量。0以上1.0以下でなければならない

      Returns void

    • AudioAsset を再生する。

      再生後、 this.onPlay がfireされる。

      Parameters

      • audio: AudioAsset

        再生するオーディオアセット

      Returns void

    • 再生を停止する。

      停止後、 this.onStop がfireされる。 再生中でない場合、何もしない(onStop もfireされない)。

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods