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)

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

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

  • 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 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 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 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)