unreal.AjaMediaSource

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

Bases: unreal.TimeSynchronizableMediaSource

Media source for AJA streams.

C++ Source:

  • Plugin: AjaMedia

  • Module: AjaMedia

  • File: AjaMediaSource.h

Editor Properties: (see get_editor_property/set_editor_property)

  • audio_channel (AjaMediaAudioChannel): [Read-Write] Audio Channel: Desired number of audio channel to capture.

  • capture_ancillary (bool): [Read-Write] Capture Ancillary: Capture Ancillary from the AJA source. It will decrease performance

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

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

  • capture_with_auto_circulating (bool): [Read-Write] Capture with Auto Circulating: Use a ring buffer to capture and transfer data. This may decrease transfer latency but increase stability.

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

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

  • frame_delay (int32): [Read-Write] Frame Delay: When using Time Synchronization, how many frame back should it read.

  • is_srgb_input (bool): [Read-Write] Is SRGBInput: Whether the video input is in sRGB color space. A sRGB to Linear conversion will be applied resulting in a texture in linear space. 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 Drop Frame: Log a warning when there’s a drop frame.

  • max_num_ancillary_frame_buffer (int32): [Read-Write] Max Num Ancillary Frame Buffer: Maximum number of ancillary data frames to buffer.

  • max_num_audio_frame_buffer (int32): [Read-Write] Max Num Audio Frame Buffer: Maximum number of audio frames to buffer.

  • max_num_video_frame_buffer (int32): [Read-Write] Max Num Video Frame Buffer: Maximum number of video frames to buffer.

  • media_configuration (MediaIOConfiguration): [Read-Write] Media Configuration: The device, port and video settings that correspond to the input.

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

  • time_delay (double): [Read-Write] Time Delay: When not using Time Synchronization, how far back it time should it read.

  • timecode_format (MediaIOTimecodeFormat): [Read-Write] Timecode Format: Use the time code embedded in the input stream.

  • use_time_synchronization (bool): [Read-Write] Use Time Synchronization: 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_channel

[Read-Only] Audio Channel: Desired number of audio channel to capture.

Type

(AjaMediaAudioChannel)

property capture_ancillary

[Read-Only] Capture Ancillary: Capture Ancillary from the AJA source. It will decrease performance

Type

(bool)

property capture_audio

[Read-Only] Capture Audio: Capture Audio from the AJA source.

Type

(bool)

property capture_video

[Read-Only] Capture Video: Capture Video from the AJA source.

Type

(bool)

property capture_with_auto_circulating

[Read-Only] Capture with Auto Circulating: Use a ring buffer to capture and transfer data. This may decrease transfer latency but increase stability.

Type

(bool)

property color_format

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

Type

(AjaMediaSourceColorFormat)

property encode_timecode_in_texel

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

Type

(bool)

property is_srgb_input

[Read-Only] Is SRGBInput: Whether the video input is in sRGB color space. A sRGB to Linear conversion will be applied resulting in a texture in linear space. 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_ancillary_frame_buffer

[Read-Only] Max Num Ancillary Frame Buffer: Maximum number of ancillary data frames to buffer.

Type

(int32)

property max_num_audio_frame_buffer

[Read-Only] Max Num Audio Frame Buffer: Maximum number of audio frames to buffer.

Type

(int32)

property max_num_video_frame_buffer

[Read-Only] Max Num Video Frame Buffer: Maximum number of video frames to buffer.

Type

(int32)

property timecode_format

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

Type

(MediaIOTimecodeFormat)