unreal.BlackmagicMediaSource

class unreal.BlackmagicMediaSource(outer=None, name='None')

Bases: unreal.TimeSynchronizableMediaSource

Media source description for Blackmagic.

C++ Source:

  • Plugin: BlackmagicMedia
  • Module: BlackmagicMedia
  • File: BlackmagicMediaSource.h

Editor Properties: (see get_editor_property/set_editor_property)

  • audio_channels (BlackmagicMediaAudioChannel): [Read-Write] Desired number of audio channel to capture.
  • capture_audio (bool): [Read-Write] Capture Audio from the Blackmagic source.
  • capture_video (bool): [Read-Write] Capture Video from the Blackmagic source.
  • color_format (BlackmagicMediaSourceColorFormat): [Read-Write] Native data format internally used by the device after being converted from SDI/HDMI signal.
  • encode_timecode_in_texel (bool): [Read-Write] Burn Frame Timecode in the input texture without any frame number clipping. Only supported in progressive format.:
  • frame_delay (int32): [Read-Write] When using Time Synchronization, how many frame back should it read.
  • is_srgb_input (bool): [Read-Write] Whether the video input is in sRGB color space. A sRGB to Linear conversion will be applied resulting in a texture in linear space. If the texture is not in linear space, it won’t look correct in the editor. Another pass will be required either through Composure or other means.:
  • log_drop_frame (bool): [Read-Write] Log a warning when there’s a drop frame.
  • 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.
  • platform_player_names (Map(str, Name)): [Read-Write] Override native media player plug-ins per platform (Empty = find one automatically).
  • time_delay (double): [Read-Write] When not using Time Synchronization, how far back it time should it read.
  • timecode_format (MediaIOTimecodeFormat): [Read-Write] Use the time code embedded in the input stream.
  • 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.
audio_channels

(BlackmagicMediaAudioChannel) – [Read-Write] Desired number of audio channel to capture.

capture_audio

(bool) – [Read-Only] Capture Audio from the Blackmagic source.

capture_video

(bool) – [Read-Only] Capture Video from the Blackmagic source.

color_format

(BlackmagicMediaSourceColorFormat) – [Read-Only] Native data format internally used by the device after being converted from SDI/HDMI signal.

encode_timecode_in_texel

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

is_srgb_input

(bool) – [Read-Only] Whether the video input is in sRGB color space. A sRGB to Linear conversion will be applied resulting in a texture in linear space. If the texture is not in linear space, it won’t look correct in the editor. Another pass will be required either through Composure or other means.:

max_num_audio_frame_buffer

(int32) – [Read-Only] Maximum number of audio frames to buffer.

max_num_video_frame_buffer

(int32) – [Read-Only] Maximum number of video frames to buffer.

timecode_format

(MediaIOTimecodeFormat) – [Read-Only] Use the time code embedded in the input stream.