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.

MovieWriter

Eredita: Object

Classe astratta per codificatori di registrazione video non in tempo reale.

Descrizione

Godot può registrare video con simulazione non in tempo reale. Come l'argomento della riga di comando--fixed-fps, questo forza il delta segnalato nelle funzioni Node._process() a essere identico tra i frame, a prescindere dal tempo effettivamente impiegato per renderizzare il frame. Questo può essere utilizzato per registrare video di alta qualità con una frequenza perfetta di frame a prescindere dalle capacità del tuo hardware.

Godot ha 3 MovieWriter integrati:

  • Contenitore OGV con Theora per il video e Vorbis per l'audio (estensione file .ogv). Compressione con perdita di dati, dimensioni file medie, codifica veloce. La qualità della compressione può essere regolata modificando ProjectSettings.editor/movie_writer/video_quality e ProjectSettings.editor/movie_writer/ogv/audio_quality. È possibile visualizzare il file risultante in Godot con VideoStreamPlayer e la maggior parte dei lettori video, ma non con i browser web, poiché non supportano Theora.

  • Contenitore AVI con MJPEG per video e audio non compresso (estensione file .avi). Compressione con perdita di dati, dimensioni file medie, codifica veloce. La qualità della compressione può essere regolata modificando ProjectSettings.editor/movie_writer/video_quality. È possibile visualizzare il file risultante nella maggior parte dei lettori video, ma è necessario convertirlo in un altro formato per poterlo visualizzare sul Web o da Godot con VideoStreamPlayer. MJPEG non supporta la trasparenza. Il file in AVI risultante può attualmente essere di dimensioni fino a 4 GB.

  • Sequenza di immagini PNG per video e WAV per audio (estensione file .png). Compressione senza perdita di dati, dimensioni file grandi, codifica lenta. Progettato per essere codificato in un file video con un altro strumento come FFmpeg dopo la registrazione. La trasparenza non è attualmente supportata, anche se la viewport radice è impostata per essere trasparente.

Se c'è bisogno di codificare in un formato diverso o di incanalare un flusso tramite software di terze parti, è possibile estendere la classe MovieWriter per creare scrittori di filmato personalizzati. Questo dovrebbe essere in genere fatto usando GDExtension per motivi di prestazioni.

Utilizzo dell'editor: È possibile specificare un percorso predefinito per il file del filmato in ProjectSettings.editor/movie_writer/movie_file. In alternativa, per l'esecuzione di singole scene, è possibile aggiungere metadati movie_file al nodo radice, specificando il percorso di un file del filmato che sarà utilizzato durante la registrazione di tale scena. Una volta impostato un percorso, clicca sull'icona del rullino video nell'angolo in alto a destra dell'editor per abilitare la modalità Movie Maker, quindi eseguire una qualsiasi scena come al solito. Il motore inizierà a registrare non appena la schermata di avvio sarà terminata e interromperà la registrazione solo quando il motore si chiuderà. Cliccare nuovamente sull'icona del rullino video per disabilitare la modalità Movie Maker. Si noti che commutare la modalità Movie Maker non influisce sulle istanze già in esecuzione del progetto.

Nota: MovieWriter è disponibile per l'uso sia nell'editor sia nei progetti esportati, ma non è progettato per essere utilizzato dagli utenti finali per registrare video durante la riproduzione. I giocatori che desiderano registrare video di gioco dovrebbero installare strumenti come OBS Studio o SimpleScreenRecorder.

Nota: Il supporto di MJPEG (estensione file .avi) dipende dall'abilitazione del modulo jpg in fase di compilazione (comportamento predefinito).

Nota: Il supporto di OGV (estensione file .ogv) dipende dall'abilitazione del modulo theora in fase di compilazione (comportamento predefinito). La compressione Theora è disponibile solo negli eseguibili dell'editor.

Metodi

int

_get_audio_mix_rate() virtual required const

SpeakerMode

_get_audio_speaker_mode() virtual required const

PackedStringArray

_get_supported_extensions() virtual required const

bool

_handles_file(path: String) virtual required const

Error

_write_begin(movie_size: Vector2i, fps: int, base_path: String) virtual required

void

_write_end() virtual required

Error

_write_frame(frame_image: Image, audio_frame_block: const void*) virtual required

void

add_writer(writer: MovieWriter) static


Descrizioni dei metodi

int _get_audio_mix_rate() virtual required const 🔗

Chiamato quando la frequenza di campionamento audio utilizzata per la registrazione dell'audio è richiesta dal motore. Il valore restituito deve essere specificato in Hz. Il valore predefinito è 48000 Hz se _get_audio_mix_rate() non è sovrascritto.


SpeakerMode _get_audio_speaker_mode() virtual required const 🔗

Chiamato quando la modalità altoparlante audio utilizzata per la registrazione dell'audio è richiesta dal motore. Ciò può influenzare il numero di canali di output nel file o flusso audio risultante. Il valore predefinito è AudioServer.SPEAKER_MODE_STEREO se _get_audio_speaker_mode() non è sovrascritto.


PackedStringArray _get_supported_extensions() virtual required const 🔗

Returns the list of supported filename extensions for movies written with this MovieWriter.


bool _handles_file(path: String) virtual required const 🔗

Chiamato quando il motore determina se questo MovieWriter è in grado di gestire il file nel percorso path. Deve restituire true se questo MovieWriter è in grado di gestire il percorso del file specificato, altrimenti false. In genere, _handles_file() viene sovrascritto come segue per consentire all'utente di registrare un file in qualsiasi percorso con una determinata estensione di file:

func _handles_file(path):
    # Consente di specificare un file di output con estensione di file `.mkv` (senza distinzione tra maiuscole e minuscole),
    # nelle Impostazioni del progetto o con l'argomento di riga di comando `--write-movie <path>`.
    return path.get_extension().to_lower() == "mkv"

Error _write_begin(movie_size: Vector2i, fps: int, base_path: String) virtual required 🔗

Chiamato una volta prima che il motore inizi a scrivere i dati video e audio. movie_size è la larghezza e l'altezza del video da salvare. fps è il numero di fotogrammi al secondo specificato nelle impostazioni del progetto o utilizzando l'argomento di riga di comando --fixed-fps <fps>.


void _write_end() virtual required 🔗

Chiamato quando il motore termina la scrittura. Ciò si verifica quando il motore si chiude premendo il pulsante di chiusura del gestore delle finestre o quando viene chiamato SceneTree.quit().

Nota: Premere Ctrl + C sul terminale che esegue l'editor o il progetto non provoca la chiamata di _write_end().


Error _write_frame(frame_image: Image, audio_frame_block: const void*) virtual required 🔗

Chiamato alla fine di ogni frame renderizzato. Gli argomenti della funzione frame_image e audio_frame_block dovrebbero essere modificati.


void add_writer(writer: MovieWriter) static 🔗

Aggiunge uno scrittore che può essere utilizzato dal motore. Le estensioni di file supportate possono essere impostate sovrascrivendo _handles_file().

Nota: add_writer() deve essere chiamato abbastanza presto nell'inizializzazione del motore per funzionare, poiché la scrittura dei film è progettata per avviarsi allo stesso tempo del resto del motore.