unreal.NDIMediaOutput

class unreal.NDIMediaOutput(outer: Object | None = None, name: Name | str = 'None')

Bases: MediaOutput

Output information for a NDI media capture. note: ‘Frame Buffer Pixel Format’ must be set to RGBA8

C++ Source:

  • Plugin: NDIMedia

  • Module: NDIMedia

  • File: NDIMediaOutput.h

Editor Properties: (see get_editor_property/set_editor_property)

  • audio_buffer_size (int32): [Read-Write] Size of the buffer that holds rendered audio samples, a bigger buffer will produce a more stable output signal but will introduce more delay.

  • audio_sample_rate (NDIMediaOutputAudioSampleRate): [Read-Write] NDI Audio supports any sample rate. The standard for live production is 48 kHz.

  • desired_pixel_format (NDIMediaOutputPixelFormat): [Read-Write] Use the default back buffer pixel format or specify a specific the pixel format to capture.

  • desired_size (IntPoint): [Read-Write] Use the default back buffer size or specify a specific size to capture.

  • frame_rate (FrameRate): [Read-Write] Represents the desired number of frames (per second) for video to be sent over NDI

  • group_name (str): [Read-Write] Defines the group this source is part of. If left empty, the source is “ungrouped” and will fall in the “Public” group by default in NDI Access Manager or NDI Bridge.

  • invert_key_output (bool): [Read-Write] Options on how to save the images.

  • num_output_audio_channels (int32): [Read-Write] An individual NDI stream can transport multiple audio channels. The number of channels supported depends on the codec used. PCM allows unlimited channels; in NDI, AAC can support 2 channels, while Opus can support up to 255 channels.

  • number_of_texture_buffers (int32): [Read-Write] Number of texture used to transfer the texture from the GPU to the system memory. A smaller number is most likely to block the GPU (wait for the transfer to complete). A bigger number is most likely to increase latency. note: Some Capture are not are executed on the GPU. If it’s the case then no buffer will be needed and no buffer will be created.

  • output_audio (bool): [Read-Write] Whether to capture and output audio from the engine.

  • output_type (MediaIOOutputType): [Read-Write] Whether to output the fill or the fill and key.

  • override_desired_size (bool): [Read-Write] Use the default back buffer size or specify a specific size to capture.

  • override_pixel_format (bool): [Read-Write] Use the default back buffer pixel format or specify a specific the pixel format to capture.

  • send_audio_only_if_receivers_connected (bool): [Read-Write] As an optimization, the audio will not be converted and sent if there are no connected receivers. Setting this to false will result in audio being converted and sent regardless of receivers.

  • source_name (str): [Read-Write] Describes a user-friendly name of the output stream to differentiate from other output streams on the current machine

  • wait_for_sync_event (bool): [Read-Write] Wait for the NDI source sync event. Caution: this will be blocking in the rendering thread and may cause performance issues in the engine.

property audio_buffer_size: int

[Read-Write] Size of the buffer that holds rendered audio samples, a bigger buffer will produce a more stable output signal but will introduce more delay.

Type:

(int32)

property audio_sample_rate: NDIMediaOutputAudioSampleRate

[Read-Write] NDI Audio supports any sample rate. The standard for live production is 48 kHz.

Type:

(NDIMediaOutputAudioSampleRate)

property desired_pixel_format: NDIMediaOutputPixelFormat

[Read-Write] Use the default back buffer pixel format or specify a specific the pixel format to capture.

Type:

(NDIMediaOutputPixelFormat)

property desired_size: IntPoint

[Read-Write] Use the default back buffer size or specify a specific size to capture.

Type:

(IntPoint)

property frame_rate: FrameRate

[Read-Write] Represents the desired number of frames (per second) for video to be sent over NDI

Type:

(FrameRate)

property group_name: str

[Read-Write] Defines the group this source is part of. If left empty, the source is “ungrouped” and will fall in the “Public” group by default in NDI Access Manager or NDI Bridge.

Type:

(str)

property invert_key_output: bool

[Read-Write] Options on how to save the images.

Type:

(bool)

property num_output_audio_channels: int

[Read-Write] An individual NDI stream can transport multiple audio channels. The number of channels supported depends on the codec used. PCM allows unlimited channels; in NDI, AAC can support 2 channels, while Opus can support up to 255 channels.

Type:

(int32)

property output_audio: bool

[Read-Write] Whether to capture and output audio from the engine.

Type:

(bool)

property output_type: MediaIOOutputType

[Read-Write] Whether to output the fill or the fill and key.

Type:

(MediaIOOutputType)

property override_desired_size: bool

[Read-Write] Use the default back buffer size or specify a specific size to capture.

Type:

(bool)

property override_pixel_format: bool

[Read-Write] Use the default back buffer pixel format or specify a specific the pixel format to capture.

Type:

(bool)

property send_audio_only_if_receivers_connected: bool

[Read-Write] As an optimization, the audio will not be converted and sent if there are no connected receivers. Setting this to false will result in audio being converted and sent regardless of receivers.

Type:

(bool)

property source_name: str

[Read-Write] Describes a user-friendly name of the output stream to differentiate from other output streams on the current machine

Type:

(str)

property wait_for_sync_event: bool

[Read-Write] Wait for the NDI source sync event. Caution: this will be blocking in the rendering thread and may cause performance issues in the engine.

Type:

(bool)