unreal.NDIMediaSource

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

Bases: CaptureCardMediaSource

Media source for NDI streams.

C++ Source:

  • Plugin: NDIMedia

  • Module: NDIMedia

  • File: NDIMediaSource.h

Editor Properties: (see get_editor_property/set_editor_property)

  • bandwidth (NDIReceiverBandwidth): [Read-Write] Indicates the current bandwidth mode used for the connection to this source

  • capture_ancillary (bool): [Read-Write] Capture Ancillary from the NDI source. It will decrease performance

  • capture_audio (bool): [Read-Write] Capture Audio from the NDI source.

  • capture_video (bool): [Read-Write] Capture Video from the NDI source.

  • color_conversion_settings (OpenColorIOColorConversionSettings): [Read-Write] OCIO Settings used for applying a color conversion to the incoming source.

  • deinterlacer (VideoDeinterlacer): [Read-Write] How interlaced video should be treated.

  • encode_timecode_in_texel (bool): [Read-Write] Burn Frame Timecode in the input texture without any frame number clipping. Note: Only supported with progressive format.

  • evaluation_type (MediaIOSampleEvaluationType): [Read-Write] Sample evaluation type.

  • frame_delay (int32): [Read-Write] When using Time Synchronization, how many frame back should it read. Capped at 4 frames due to the potential issues with buffer sizes. Framelocked modes don’t support this feature.

  • framelock (bool): [Read-Write] Should wait for some time until requested frame arrives? Requires JIT rendering.

  • interlace_field_order (MediaIOInterlaceFieldOrder): [Read-Write] The order in which interlace fields should be copied.

  • log_drop_frame (bool): [Read-Write] Log a warning when there’s a drop frame.

  • max_num_ancillary_frame_buffer (int32): [Read-Write] Maximum number of ancillary data frames to buffer.

  • max_num_audio_frame_buffer (int32): [Read-Write] Maximum number of audio frames to buffer.

  • max_num_video_frame_buffer (int32): [Read-Write] Maximum number of video frames to buffer.

  • media_configuration (MediaIOConfiguration): [Read-Write] The device, port and video settings that correspond to the input.

  • override_source_color_space (bool): [Read-Write] Whether to override the source color space or to use the metadata embedded in the ancillary data of the signal.

  • override_source_color_space (TextureColorSpace): [Read-Write] Color space of the source texture.

  • override_source_encoding (MediaIOCoreSourceEncoding): [Read-Write] Encoding of the source texture.

  • override_source_encoding (bool): [Read-Write] Whether to override the source encoding or to use the metadata embedded in the ancillary data of the signal.

  • platform_player_names (Map[str, Name]): [Read-Write] Override native media player plug-ins per platform (Empty = find one automatically).

  • render_jit (bool): [Read-Write] Should use JITR technique? It enables late sample picking for render.

  • sync_timecode_to_source (bool): [Read-Write] Indicates whether the timecode should be synced to the Source Timecode value or engine’s.

  • time_delay (double): [Read-Write] When not using Time Synchronization, how far back it time should it read.

  • use_time_synchronization (bool): [Read-Write] Synchronize the media with the engine’s timecode. The media player has be able to read timecode. The media player will try to play the corresponding frame, base on the frame’s timecode value.

property capture_ancillary: bool

[Read-Only] Capture Ancillary from the NDI source. It will decrease performance

Type:

(bool)

property capture_audio: bool

[Read-Only] Capture Audio from the NDI source.

Type:

(bool)

property capture_video: bool

[Read-Only] Capture Video from the NDI source.

Type:

(bool)

property encode_timecode_in_texel: bool

[Read-Only] Burn Frame Timecode in the input texture without any frame number clipping. Note: Only supported with progressive format.

Type:

(bool)

property max_num_ancillary_frame_buffer: int

[Read-Only] Maximum number of ancillary data frames to buffer.

Type:

(int32)

property max_num_audio_frame_buffer: int

[Read-Only] Maximum number of audio frames to buffer.

Type:

(int32)

property max_num_video_frame_buffer: int

[Read-Only] Maximum number of video frames to buffer.

Type:

(int32)

property sync_timecode_to_source: bool

[Read-Write] Indicates whether the timecode should be synced to the Source Timecode value or engine’s.

Type:

(bool)