unreal.BlackmagicMediaSource

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

Bases: CaptureCardMediaSource

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.

  • auto_detectable_timecode_format (MediaIOAutoDetectableTimecodeFormat): [Read-Write] Use the time code embedded in the input stream.

  • capture_audio (bool): [Read-Write] Capture Audio from the Blackmagic source.

  • capture_video (bool): [Read-Write] Capture Video from the Blackmagic source.

  • color_conversion_settings (OpenColorIOColorConversionSettings): [Read-Write] OpenColorIO transform settings used for applying a color conversion override to the incoming source.

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

  • deinterlacer (VideoDeinterlacer): [Read-Write] How interlaced video should be treated.

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

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

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

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

  • is_override_source_color_space (bool): [Read-Write] deprecated: This property is deprecated. Please use SourceColorSettings instead.

  • is_override_source_encoding (bool): [Read-Write] deprecated: This property is deprecated. Please use SourceColorSettings instead.

  • 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. deprecated: Use ColorEncoding instead. Note: 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.

  • override_source_color_space (TextureColorSpace): [Read-Write] deprecated: This property is deprecated. Please use SourceColorSettings instead.

  • override_source_encoding (MediaIOCoreSourceEncoding): [Read-Write] deprecated: This property is deprecated. Please use SourceColorSettings instead.

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

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

  • source_color_settings (MediaSourceColorSettings): [Read-Write] Manual definition of media source color space & encoding.

  • 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. deprecated: Property ‘TimecodeFormat’ is deprecated.

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

property audio_channels: BlackmagicMediaAudioChannel

[Read-Write] Desired number of audio channel to capture.

Type:

(BlackmagicMediaAudioChannel)

property auto_detectable_timecode_format: MediaIOAutoDetectableTimecodeFormat

[Read-Only] Use the time code embedded in the input stream.

Type:

(MediaIOAutoDetectableTimecodeFormat)

property capture_audio: bool

[Read-Only] Capture Audio from the Blackmagic source.

Type:

(bool)

property capture_video: bool

[Read-Only] Capture Video from the Blackmagic source.

Type:

(bool)

property color_format: BlackmagicMediaSourceColorFormat

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

Type:

(BlackmagicMediaSourceColorFormat)

property encode_timecode_in_texel: bool

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

Type:

(bool)

property 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. deprecated: Use ColorEncoding instead. Note: 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.

Type:

(bool)

property max_num_audio_frame_buffer: int

[Read-Only] Maximum number of audio frames to buffer.

Type:

(int32)

property max_num_video_frame_buffer: int

[Read-Only] Maximum number of video frames to buffer.

Type:

(int32)

property timecode_format: MediaIOTimecodeFormat

[Read-Write] Use the time code embedded in the input stream. deprecated: Property ‘TimecodeFormat’ is deprecated.

Type:

(MediaIOTimecodeFormat)