unreal.RivermaxMediaSource

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

Bases: CaptureCardMediaSource

Media source for Rivermax streams.

C++ Source:

• Plugin: RivermaxMedia

• Module: RivermaxMedia

• File: RivermaxMediaSource.h

Editor Properties: (see get_editor_property/set_editor_property)

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

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

• frame_rate (FrameRate): [Read-Write] Incoming stream video frame rate

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

• interface_address (str): [Read-Write] Network card interface to use to receive data Wildcards are supported to match against an interface found on the machine 192.*.0.110 192.168.0.1?0 192.168.0.1*

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

• is_srgb_input (bool): [Read-Write] deprecated: Use Override Source Encoding instead

• override_resolution (bool): [Read-Write] If false, use the default source buffer size. If true, a specific resolution will be used.

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

• pixel_format (RivermaxMediaSourcePixelFormat): [Read-Write] Incoming stream pixel format

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

• player_mode (RivermaxPlayerMode_DEPRECATED): [Read-Write] deprecated: Use Sample Evaluation Type and Framelock instead

• port (int32): [Read-Write] Port used by the sender to send its stream

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

• resolution (IntPoint): [Read-Write] Incoming stream video resolution

• stream_address (str): [Read-Write] IP address where incoming stream is coming from

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

• use_gpu_direct (bool): [Read-Write] Whether to use GPUDirect if available (Memcopy from NIC to GPU directly bypassing system memory) if available

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

• use_zero_latency (bool): [Read-Write] deprecated: Use Frame Delay under Synchronization category

property frame_rate: FrameRate

[Read-Write] Incoming stream video frame rate

Type:

(FrameRate)

property interface_address: str

[Read-Write] Network card interface to use to receive data Wildcards are supported to match against an interface found on the machine 192.*.0.110 192.168.0.1?0 192.168.0.1*

Type:

(str)

property is_srgb_input: bool

[Read-Write] deprecated: Use Override Source Encoding instead

Type:

(bool)

property override_resolution: bool

[Read-Write] If false, use the default source buffer size. If true, a specific resolution will be used.

Type:

(bool)

property pixel_format: RivermaxMediaSourcePixelFormat

[Read-Write] Incoming stream pixel format

Type:

(RivermaxMediaSourcePixelFormat)

property player_mode: RivermaxPlayerMode_DEPRECATED

[Read-Write] deprecated: Use Sample Evaluation Type and Framelock instead

Type:

(RivermaxPlayerMode_DEPRECATED)

property port: int

[Read-Write] Port used by the sender to send its stream

Type:

(int32)

property resolution: IntPoint

[Read-Write] Incoming stream video resolution

Type:

(IntPoint)

property stream_address: str

[Read-Write] IP address where incoming stream is coming from

Type:

(str)

property use_gpu_direct: bool

[Read-Write] Whether to use GPUDirect if available (Memcopy from NIC to GPU directly bypassing system memory) if available

Type:

(bool)

property use_zero_latency: bool

[Read-Write] deprecated: Use Frame Delay under Synchronization category

Type:

(bool)