1. Epic GamesDeveloper
  3. UBlackmagicMediaOutput

UBlackmagicMediaOutput

Output information for a MediaCapture.

API > API/Plugins > API/Plugins/BlackmagicMediaOutput

Inheritance Hierarchy

References

   
Module BlackmagicMediaOutput
Header /Engine/Plugins/Media/BlackmagicMedia/Source/BlackmagicMediaOutput/Public/BlackmagicMediaOutput.h
Include #include "BlackmagicMediaOutput.h"

Syntax

UCLASS&40;BlueprintType, Meta&61;&40;MediaIOCustomLayout&61;"Blackmagic"&41;&41;  
class UBlackmagicMediaOutput : public UMediaOutput

Remarks

Output information for a MediaCapture.

'Frame Buffer Pixel Format' must be set to at least 8 bits of alpha to enabled the Key.

'Enable alpha channel support in post-processing' must be set to 'Allow through tonemapper' to enabled the Key.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EBlackmagicMediaOutputAudioBitDepth AudioBitDepth Bit depth of each audio sample.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite int32 AudioBufferSize Size of the buffer that holds rendered audio samples, a bigger buffer will produce an output of greater quality but will introduce more delay.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EBlackmagicMediaOutputAudioSampleRate AudioSampleRate Sample rate of the audio output.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bEncodeTimecodeInTexel Burn Frame Timecode on the output without any frame number clipping.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay bool bInterlacedFieldsTimecodeNeedToMatch Only make sense in interlaced mode.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay bool bInvertKeyOutput Invert Key Output
Public variable UProperty Category, EditAnywhere bool bLogDropFrame Log a warning when there's a drop frame.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bOutputAudio Whether to capture and output audio from the engine.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite bool bUseMultithreadedScheduling Whether to use multi threaded scheduling which should improve performance when outputting 4k and 8k content.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bWaitForSyncEvent Try to maintain a the engine "Genlock" with the VSync signal.
Public variable UProperty Category, EditAnywhere displayname FBlackmagicMediaHDROptions HDROptions HDR Metadata of the video signal.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta int32 NumberOfBlackmagicBuffers Number of frame used to transfer from the system memory to the Blackmagic card.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EBlackmagicMediaAudioOutputChannelCount OutputChannelCount Number of audio channels to output.
Public variable UProperty Category, EditAnywhere, Meta FMediaIOOutputConfiguration OutputConfiguration The device, port and video settings that correspond to the output.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EBlackmagicMediaOutputPixelFormat PixelFormat Native data format internally used by the device before being converted to SDI/HDMI signal.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EMediaIOTimecodeFormat TimecodeFormat Whether to embed the Engine's timecode to the output frame.

Constructors

  Type Name Description
Public function  

UBlackmagicMediaOutput ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const FFrameRate  

Overridden from UMediaOutput

  Type Name Description
Protected function Virtual UMediaCapture *  
Public function Virtual Const EMediaCaptureConversionOperation The conversion we wish to accomplish on the GPU before the DMA transfer occurs.
Public function Virtual Const EPixelFormat The pixel format of the buffer we wish to capture.
Public function Virtual Const FIntPoint The size of the buffer we wish to capture.
Public function Virtual Const bool

Validate ( FString& OutFailureReason
)

 Validate the media output settings (must be implemented in child classes).

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page