Cluster Creator Kit Script Reference
    Preparing search index...

    Interface AudioStream

    アイテムの音声再生ストリームを表すハンドルです。 音声再生ストリームは動的な音声を再生するために使用します。

    音声再生ストリームのバッファに追加された AudioRecord の音声データは、追加された順番で順次再生されることが期待されます。 ネットワークの状況などの理由で、音声再生ストリームの音声の一部または全部が聞こえなくなる場合があります。

    interface AudioStream {
        isPlaying: boolean;
        volume: number;
        add(record: AudioRecord): void;
        attach(subNode: SubNode): void;
        attachToRoot(): void;
        start(): boolean;
        stop(): void;
    }
    Index

    Properties

    isPlaying: boolean

    現在音声再生ストリームが再生中であるかどうかを取得します。 このプロパティはスクリプトのトップレベルでアクセスすることはできません。

    volume: number

    音声再生ストリームの音量を表すプロパティです。 このプロパティはスクリプトのトップレベルでアクセスすることはできません。

    初期値は1で、0以上2.5以下の値をとります。

    Methods

    • 音声再生ストリームが再生中である時に呼び出した場合、音声データを音声再生ストリームのバッファの末尾に追加します。 このAPIはスクリプトのトップレベルで呼び出すことはできません。

      ストリームに追加された音声データは、 AudioStream.add を呼び出した時点でスペース内にいるプレイヤーが聞くことができます。 後から入室したプレイヤーは、入室前に追加された音声データを聞くことができない場合があります。

      音声再生ストリームが再生中ではない時に呼び出した場合、エラーになります。

      Parameters

      • record: AudioRecord

        ストリームに追加する音声データ

      Returns void

    • 空間内における音声再生ストリームの音声の再生位置となるSubNodeを指定します。 このAPIはスクリプトのトップレベルで呼び出すことはできません。

      初期状態では、音声再生ストリームの再生位置はアイテムのルート位置です。
      存在しないSubNodeが指定された場合、音声再生ストリームの再生位置はアイテムのルート位置になります。

      Parameters

      Returns void

    • 音声再生ストリームの再生位置をアイテムのルート位置にします。 このAPIはスクリプトのトップレベルで呼び出すことはできません。

      Returns void

    • 新しい音声再生ストリームを開始します。 このAPIはスクリプトのトップレベルで呼び出すことはできません。

      音声再生ストリームが再生中である時に呼び出した場合、現在再生中の音声再生ストリームは直ちに停止され、音声再生ストリームのバッファをクリアします。

      空間内のアイテムは、空間全体で合わせて最大で4個の音声再生ストリームを同時に再生中の状態にできます。 制限を超えている場合、音声再生ストリームを新たに開始することはできません。

      Returns boolean

      ストリームの開始に成功した場合は true を返します。失敗した場合は false を返します。

    • 音声再生ストリームを停止します。 このAPIはスクリプトのトップレベルで呼び出すことはできません。

      音声再生ストリームが再生中である時に呼び出した場合、現在再生中の音声再生ストリームは直ちに停止され、音声再生ストリームのバッファをクリアします。

      音声再生ストリームが再生中ではない時に呼び出した場合、何もしません。

      Returns void