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...

NDIOutput

Inherits: Node

Transmit the Viewport as a NDI source

Description

Creates an NDI source and displays the closest Viewport up the tree.

Warning: Outputting more than 60 FPS will cause stuttering. Limit the FPS by setting application/run/max_fps in ProjectSettings.

If the Viewport should be transmitted while its not visible, for example when the window is in the background or a SubViewport is used without a SubViewportContainer, make sure to have the render_target_update_mode set to Always on the SubViewport.

Tutorials

Properties

StringName

audio_bus

&"None"

bool

enable_editor_output

false

bool

enable_video_output

true

PackedStringArray

groups

PackedStringArray()

String

name

""

Property Descriptions

StringName audio_bus = &"None" 🔗

  • void set_audio_bus(value: StringName)

  • StringName get_audio_bus()

Which Audio Bus to transmit.

Note: Selected Bus has to have a Capture effect added and enabled.

Warning: Only mono and stereo audio devices are supported.

bool enable_editor_output = false 🔗

  • void set_output_editor(value: bool)

  • bool is_outputting_editor()

Makes the NDIOutput Node transmit while running in the Editor. Source name will be suffixed with [Editor].

Warning: Enable Update Continuously in the Editor Settings to prevent excessive stuttering.

bool enable_video_output = true 🔗

  • void set_output_video(value: bool)

  • bool is_outputting_video()

Can be disabled if you only want to transmit audio.

PackedStringArray groups = PackedStringArray() 🔗

  • void set_groups(value: PackedStringArray)

  • PackedStringArray get_groups()

List of groups that the source will be available in. Leave empty for default.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedStringArray for more details.

String name = "" 🔗

  • void set_name(value: String)

  • String get_name()

The name of the NDI source.

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.