unreal.AjaMediaOutput

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

Bases: unreal.MediaOutput

Output information for an aja media capture. note: ‘Frame Buffer Pixel Format’ must be set to at least 8 bits of alpha to enabled the Key. note: ‘Enable alpha channel support in post-processing’ must be set to ‘Allow through tonemapper’ to enabled the Key.

C++ Source:

  • Plugin: AjaMedia

  • Module: AjaMediaOutput

  • File: AjaMediaOutput.h

Editor Properties: (see get_editor_property/set_editor_property)

  • audio_buffer_size (int32): [Read-Write] Audio Buffer Size: Size of the buffer that holds rendered audio samples, a bigger buffer will produce a more stable output signal but will introduce more delay.

  • audio_sample_rate (AjaMediaOutputAudioSampleRate): [Read-Write] Audio Sample Rate: Audio output sample rate.

  • encode_timecode_in_texel (bool): [Read-Write] Encode Timecode in Texel: Burn Frame Timecode on the output without any frame number clipping.

  • interlaced_fields_timecode_need_to_match (bool): [Read-Write] Interlaced Fields Timecode Need to Match: Only make sense in interlaced mode. When creating a new Frame the 2 fields need to have the same timecode value. The Engine’s need a TimecodeProvider (or the default system clock) that is in sync with the generated fields.

  • invert_key_output (bool): [Read-Write] Invert Key Output: Invert Key Output

  • log_drop_frame (bool): [Read-Write] Log Drop Frame: Log a warning when there’s a drop frame.

  • num_output_audio_channels (AjaMediaOutputChannelConfiguration): [Read-Write] Num Output Audio Channels: Number of audio channels used when output audio on the card.

  • number_of_aja_buffers (int32): [Read-Write] Number Of AJABuffers: Number of frame used to transfer from the system memory to the AJA card. A smaller number is most likely to cause missed frame. A bigger number is most likely to increase latency.

  • number_of_texture_buffers (int32): [Read-Write] Number Of Texture Buffers: 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.

  • output_audio (bool): [Read-Write] Output Audio: Whether to capture and output audio from the engine.

  • output_configuration (MediaIOOutputConfiguration): [Read-Write] Output Configuration: The device, port and video settings that correspond to the output.

  • output_in3g_level_b (bool): [Read-Write] Output in 3GLevel B: If the video format is compatible with 3G Level A, do the conversion to output in LevelB.

  • output_with_auto_circulating (bool): [Read-Write] Output with Auto Circulating: The output of the Audio, Ancillary and/or video will be perform at the same time. This may decrease transfer performance but each the data will be sync in relation with each other.

  • pixel_format (AjaMediaOutputPixelFormat): [Read-Write] Pixel Format: Native data format internally used by the device before being converted to SDI/HDMI signal.

  • timecode_format (MediaIOTimecodeFormat): [Read-Write] Timecode Format: Whether to embed the Engine’s timecode to the output frame.

  • wait_for_sync_event (bool): [Read-Write] Wait for Sync Event: Try to maintain a the engine “Genlock” with the VSync signal.

property audio_buffer_size

[Read-Write] Audio Buffer Size: Size of the buffer that holds rendered audio samples, a bigger buffer will produce a more stable output signal but will introduce more delay.

Type

(int32)

property audio_sample_rate

[Read-Write] Audio Sample Rate: Audio output sample rate.

Type

(AjaMediaOutputAudioSampleRate)

property encode_timecode_in_texel

[Read-Write] Encode Timecode in Texel: Burn Frame Timecode on the output without any frame number clipping.

Type

(bool)

property num_output_audio_channels

[Read-Write] Num Output Audio Channels: Number of audio channels used when output audio on the card.

Type

(AjaMediaOutputChannelConfiguration)

property output_audio

[Read-Write] Output Audio: Whether to capture and output audio from the engine.

Type

(bool)

property output_with_auto_circulating

[Read-Write] Output with Auto Circulating: The output of the Audio, Ancillary and/or video will be perform at the same time. This may decrease transfer performance but each the data will be sync in relation with each other.

Type

(bool)

property pixel_format

[Read-Write] Pixel Format: Native data format internally used by the device before being converted to SDI/HDMI signal.

Type

(AjaMediaOutputPixelFormat)

property timecode_format

[Read-Write] Timecode Format: Whether to embed the Engine’s timecode to the output frame.

Type

(MediaIOTimecodeFormat)

property wait_for_sync_event

[Read-Write] Wait for Sync Event: Try to maintain a the engine “Genlock” with the VSync signal.

Type

(bool)