unreal.RivermaxMediaOutput¶
- class unreal.RivermaxMediaOutput(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
MediaOutputOutput 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 outputanc_streams(Array[RivermaxAncStream]): [Read-Write] Collection of Ancillary streams.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 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 intonumber_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.presentation_queue_size(int32): [Read-Write] Number of frames that can be queued / used in output queue. Frame being sent counts for 1.video_stream(RivermaxVideoStream): [Read-Write] Video output stream properties.
- 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 presentation_queue_size: int¶
[Read-Write] Number of frames that can be queued / used in output queue. Frame being sent counts for 1.
- Type:
(int32)
- property video_stream: RivermaxVideoStream¶
[Read-Write] Video output stream properties.
- Type: