unreal.SharedMemoryMediaSource

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

Bases: MediaSource

Media source for SharedMemory streams.

C++ Source:

  • Plugin: nDisplay

  • Module: SharedMemoryMedia

  • File: SharedMemoryMediaSource.h

Editor Properties: (see get_editor_property/set_editor_property)

  • mode (SharedMemoryMediaSourceMode): [Read-Write] Mode of operation when receiving data. Framelocked - Matches source and local frame numbers. Always use this mode in nDisplay. Genlocked - It doesn’t match frame numbers, but it also doesn’t skip frames, so will hold back the sender if it is faster than the receiver. Freerun - It always grabs the latest frame. It may skip frames if they arrive too fast.

  • unique_name (str): [Read-Write] Shared memory will be found by using this name. Should match the media output setting.

  • zero_latency (bool): [Read-Write] Zero latency option to wait for the cross gpu texture rendered on the same frame. May adversely affect fps. Only applicable in Framelocked mode.

property mode: SharedMemoryMediaSourceMode

[Read-Write] Mode of operation when receiving data. Framelocked - Matches source and local frame numbers. Always use this mode in nDisplay. Genlocked - It doesn’t match frame numbers, but it also doesn’t skip frames, so will hold back the sender if it is faster than the receiver. Freerun - It always grabs the latest frame. It may skip frames if they arrive too fast.

Type:

(SharedMemoryMediaSourceMode)

property unique_name: str

[Read-Write] Shared memory will be found by using this name. Should match the media output setting.

Type:

(str)

property zero_latency: bool

[Read-Write] Zero latency option to wait for the cross gpu texture rendered on the same frame. May adversely affect fps. Only applicable in Framelocked mode.

Type:

(bool)