Cluster Creator Kit Script Reference
    Preparing search index...

    Interface VoiceRecorderHandlePlayer

    プレイヤーのボイス入力を録音するハンドルです。

    PlayerScript.voiceRecorderHandle で取得することができます。

    ボイス入力は Opus でエンコードされた 48kHz のモノラル音声として録音されます。 録音されたデータは AudioRecord オブジェクトとして取得できます。

    interface VoiceRecorderHandle {
        isRecording: boolean;
        onVoiceRecord(
            callback: (audioRecord: AudioRecord, isPartial: boolean) => void,
        ): void;
        start(option?: VoiceRecorderOption, encoder?: VoiceEncoderOption): void;
        stop(): void;
    }
    Index

    Properties

    isRecording: boolean

    現在ボイス入力の録音中かどうかを取得します。

    Methods

    • 録音された音声データを取得できるコールバックを登録します。 複数回呼ばれた場合、最後の登録のみが有効です。

      ボイス入力の録音は start で開始し、 stop で停止します。

      ボイス入力の録音中、以下の条件がすべて満たされている間、録音データが蓄積されます。

      • マイクオンであり、サブ音声を有効にしていない
      • マイクに入力された音声の音量が一定以上になっている

      マイクがオフになった場合、サブ音声を有効にした場合、またはマイクに入力された音声の音量が小さくなった場合、それまでの録音データが audioRecord として渡され、 isPartial には false が渡されます。

      stop によってボイス入力の録音を停止した場合も同様に、それまでの録音データが audioRecord として渡され、 isPartial には false が渡されます。

      また、コールバックに渡される録音データは start で指定したオプションに従って分割されます。 録音中に音声データが長さによって分割された場合、それまでの録音データが audioRecord として渡され、 isPartial には true が渡されます。 isPartial が true の場合、この audioRecord は後続の audioRecord と Opus ストリームとして連続しているため、正しい順番で処理する必要があります。

      PlayerScriptの有効期間終了に伴ってボイス入力の録音が停止する場合、コールバックは発火せず、録音中の音声データは破棄されます。

      Parameters

      • callback: (audioRecord: AudioRecord, isPartial: boolean) => void

        audioRecord: 録音データ isPartial: 録音データが長さによって分割された場合は true 、連続した音声データの末尾の場合は false

      Returns void

    • ボイス入力の録音を開始します。 既に録音中だったり設定値が不正な場合はエラーになります。

      PlayerScriptの有効期間が終了した場合、ボイス入力の録音は停止します。

      Parameters

      • Optionaloption: VoiceRecorderOption

        ボイス録音の動作を指定するオプション値です。

      • Optionalencoder: VoiceEncoderOption

        エンコーダの設定を指定するオプション値です。省略した場合はシステムが自動的に決定した設定が適用されます。

      Returns void

    • ボイス入力の録音を停止します。

      Returns void