Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

使用麥克風錄音

Godot 支援於 Windows、macOS、Linux、Android 與 iOS 平台進行遊戲內音訊錄音。

官方範例專案中包含有一個簡單的示範，並將用於本教學說明：<https://github.com/godotengine/godot-demo-projects/tree/master/audio/mic_record>_。

你必須在 Audio > Driver > Enable Input 專案設定中啟用音訊輸入，否則只會獲得空白的音訊檔案。

On iOS and iPadOS, it is also important to set the advanced Audio > General > iOS > Session Category setting to include Record or Play and Record.

範例結構

本示範由單一場景組成，場景包含兩大部分：GUI 介面與音訊處理。

我們將聚焦於音訊部分。在此範例中，建立了一個名為 Record 的匯流排（Bus），並加上 Record 效果來處理錄音，另外用一個名為 AudioStreamRecord 的 AudioStreamPlayer 來播放錄音。

var effect
var recording


func _ready():
    # We get the index of the "Record" bus.
    var idx = AudioServer.get_bus_index("Record")
    # And use it to retrieve its first effect, which has been defined
    # as an "AudioEffectRecord" resource.
    effect = AudioServer.get_bus_effect(idx, 0)

private AudioEffectRecord _effect;
private AudioStreamSample _recording;

public override void _Ready()
{
    // We get the index of the "Record" bus.
    int idx = AudioServer.GetBusIndex("Record");
    // And use it to retrieve its first effect, which has been defined
    // as an "AudioEffectRecord" resource.
    _effect = (AudioEffectRecord)AudioServer.GetBusEffect(idx, 0);
}

音訊錄製是透過 AudioEffectRecord 資源來處理，該資源具有三個方法：get_recording()、is_recording_active()，以及 set_recording_active()。

func _on_record_button_pressed():
    if effect.is_recording_active():
        recording = effect.get_recording()
        $PlayButton.disabled = false
        $SaveButton.disabled = false
        effect.set_recording_active(false)
        $RecordButton.text = "Record"
        $Status.text = ""
    else:
        $PlayButton.disabled = true
        $SaveButton.disabled = true
        effect.set_recording_active(true)
        $RecordButton.text = "Stop"
        $Status.text = "Recording..."

private void OnRecordButtonPressed()
{
    if (_effect.IsRecordingActive())
    {
        _recording = _effect.GetRecording();
        GetNode<Button>("PlayButton").Disabled = false;
        GetNode<Button>("SaveButton").Disabled = false;
        _effect.SetRecordingActive(false);
        GetNode<Button>("RecordButton").Text = "Record";
        GetNode<Label>("Status").Text = "";
    }
    else
    {
        GetNode<Button>("PlayButton").Disabled = true;
        GetNode<Button>("SaveButton").Disabled = true;
        _effect.SetRecordingActive(true);
        GetNode<Button>("RecordButton").Text = "Stop";
        GetNode<Label>("Status").Text = "Recording...";
    }
}

在範例開始時，錄音效果尚未啟動。當使用者按下 RecordButton 時，會以 set_recording_active(true) 啟用錄音效果。

再次按下按鈕時，因為 effect.is_recording_active() 為 true，可以透過呼叫 effect.get_recording() 將錄製的串流存入 recording 變數。

func _on_play_button_pressed():
    print(recording)
    print(recording.format)
    print(recording.mix_rate)
    print(recording.stereo)
    var data = recording.get_data()
    print(data.size())
    $AudioStreamPlayer.stream = recording
    $AudioStreamPlayer.play()

private void OnPlayButtonPressed()
{
    GD.Print(_recording);
    GD.Print(_recording.Format);
    GD.Print(_recording.MixRate);
    GD.Print(_recording.Stereo);
    byte[] data = _recording.Data;
    GD.Print(data.Length);
    var audioStreamPlayer = GetNode<AudioStreamPlayer>("AudioStreamPlayer");
    audioStreamPlayer.Stream = _recording;
    audioStreamPlayer.Play();
}

若要播放錄音，只需將錄製內容指定為 AudioStreamPlayer 的串流來源後呼叫 play()。

func _on_save_button_pressed():
    var save_path = $SaveButton/Filename.text
    recording.save_to_wav(save_path)
    $Status.text = "Saved WAV file to: %s\n(%s)" % [save_path, ProjectSettings.globalize_path(save_path)]

private void OnSaveButtonPressed()
{
    string savePath = GetNode<LineEdit>("SaveButton/Filename").Text;
    _recording.SaveToWav(savePath);
    GetNode<Label>("Status").Text = string.Format("Saved WAV file to: {0}\n({1})", savePath, ProjectSettings.GlobalizePath(savePath));
}

若要儲存錄音，可以呼叫 save_to_wav() 並指定檔案路徑。在本範例中，路徑由使用者透過 LineEdit 輸入欄位自訂。