unreal.RivermaxMediaOutput
¶
- class unreal.RivermaxMediaOutput(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
MediaOutput
Output information for a Rivermax media capture.
C++ Source:
Plugin: RivermaxMedia
Module: RivermaxMedia
File: RivermaxMediaOutput.h
Editor Properties: (see get_editor_property/set_editor_property)
alignment_mode
(RivermaxMediaAlignmentMode): [Read-Write] Used by frame scheduler to know how to align the outputdo_continuous_output
(bool): [Read-Write] Whether to produce a continuous output stream repeating last frame if no new frames provided Note: Not supported in frame creation modedo_frame_counter_timestamping
(bool): [Read-Write] Experimental flag to use frame counter instead of using NVIDIA Rivermax clock for timestamping output frames Meant to be used for UE-UE streams where frame locking is done, e.g. nDisplay.frame_locking_mode
(RivermaxFrameLockingMode): [Read-Write] For alignment point mode, controls whether we stall engine before capturing if there are no buffer available to capture intoframe_rate
(FrameRate): [Read-Write] Frame rate of this output streaminterface_address
(str): [Read-Write] Network card interface to use to send 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*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.override_resolution
(bool): [Read-Write] If false, use the default source buffer size. If true, a specific resolution will be used.pixel_format
(RivermaxMediaOutputPixelFormat): [Read-Write] Pixel format for this output streamport
(int32): [Read-Write] Port to use for this outputpresentation_queue_size
(int32): [Read-Write] Number of frames that can be queued / used in output queue. Frame being sent counts for 1.resolution
(IntPoint): [Read-Write] Resolution of this output streamstream_address
(str): [Read-Write] Address of the stream. Can be multicast, i.e. 228.1.1.1)use_gpu_direct
(bool): [Read-Write] Whether to use GPUDirect if available (Memcopy from GPU to NIC directly bypassing system) if available
- property alignment_mode: RivermaxMediaAlignmentMode¶
[Read-Write] Used by frame scheduler to know how to align the output
- Type:
- property do_continuous_output: bool¶
[Read-Write] Whether to produce a continuous output stream repeating last frame if no new frames provided Note: Not supported in frame creation mode
- Type:
(bool)
- property frame_locking_mode: RivermaxFrameLockingMode¶
[Read-Write] For alignment point mode, controls whether we stall engine before capturing if there are no buffer available to capture into
- Type:
- property interface_address: str¶
[Read-Write] Network card interface to use to send 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 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: RivermaxMediaOutputPixelFormat¶
[Read-Write] Pixel format for this output stream
- Type: