NDIFinder

Inherits: Node

Detects available NDI sources

Properties

PackedStringArray

extra_ips

PackedStringArray()

PackedStringArray

groups

PackedStringArray()

bool

show_local_sources

true

Methods

Array[VideoStreamNDI]

get_sources() const


Signals

sources_changed() 🔗

Emited when the list of available sources has changed.


Property Descriptions

PackedStringArray extra_ips = PackedStringArray() 🔗

  • void set_extra_ips(value: PackedStringArray)

  • PackedStringArray get_extra_ips()

The list of additional IP addresses that we should query for sources. For instance, if you want to find the sources on a remote machine that is not on your local sub-net then you can add them here and those sources will be available locally even though they are not mDNS discoverable.

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


PackedStringArray groups = PackedStringArray() 🔗

  • void set_groups(value: PackedStringArray)

  • PackedStringArray get_groups()

Which groups you want to search in for sources. 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.


bool show_local_sources = true 🔗

  • void set_show_local_sources(value: bool)

  • bool get_show_local_sources()

Include sources from the local machine.


Method Descriptions

Array[VideoStreamNDI] get_sources() const 🔗

Sources can only be discovered if NDIFinder is inside the tree.

Returns an array of currently available sources according to the settings. The entries can be used directly as the stream for VideoStreamPlayer.

Warning: The array will still be empty when NDIFinder is ready. It can take a few seconds to discover NDI sources so make use of the sources_changed signal.


User-contributed notes

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