1. Epic GamesDeveloper
  3. UBlackmagicMediaOutput

UBlackmagicMediaOutput

Output information for a MediaCapture.

API > API/Plugins > API/Plugins/BlackmagicMediaOutput

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.

   
Name UBlackmagicMediaOutput
Type class
Header File /Engine/Plugins/Media/BlackmagicMedia/Source/BlackmagicMediaOutput/Public/BlackmagicMediaOutput.h
Include Path #include "BlackmagicMediaOutput.h"

Syntax

UCLASS (BlueprintType, prioritizeCategories=(Blackmagic, Output, Synchronization, Debug),  
       Meta=(MediaIOCustomLayout="Blackmagic"))  
class UBlackmagicMediaOutput : public UMediaOutput

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UBlackmagicMediaOutput ( const FObjectInitializer& ObjectInitializer
)

   BlackmagicMediaOutput.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AudioBitDepth EBlackmagicMediaOutputAudioBitDepth Bit depth of each audio sample. BlackmagicMediaOutput.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Output"
AudioBufferSize int32 Size of the buffer that holds rendered audio samples, a bigger buffer will produce an output of greater quality but will introduce more delay. BlackmagicMediaOutput.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Output"
AudioSampleRate EBlackmagicMediaOutputAudioSampleRate Sample rate of the audio output. BlackmagicMediaOutput.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Output"
bEncodeTimecodeInTexel bool Burn Frame Timecode on the output without any frame number clipping. BlackmagicMediaOutput.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Debug"
  • Meta=(DisplayName="Burn Frame Timecode")
bInterlacedFieldsTimecodeNeedToMatch bool Only make sense in interlaced mode. BlackmagicMediaOutput.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Output"
bInvertKeyOutput bool Invert Key Output BlackmagicMediaOutput.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Output"
bLogDropFrame bool Log a warning when there's a drop frame. BlackmagicMediaOutput.h
  • EditAnywhere
  • Category="Debug"
bOutputAudio bool Whether to capture and output audio from the engine. BlackmagicMediaOutput.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Output"
bOutputInterlaceAsProgressive bool If this is enabled when outputting media in interlace format, frames will be treated as progressive and will be outputted as-is. BlackmagicMediaOutput.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Output"
bOutputInterlaceOnEvenFrames bool Whether to only schedule interlace frames if we land on an even timecode. BlackmagicMediaOutput.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Output"
bUseMultithreadedScheduling bool Whether to use multi threaded scheduling which should improve performance when outputting 4k and 8k content. BlackmagicMediaOutput.h
  • BlueprintReadWrite
  • AdvancedDisplay
  • EditAnywhere
  • Category="Output"
bWaitForSyncEvent bool Try to maintain a the engine "Genlock" with the VSync signal. BlackmagicMediaOutput.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Synchronization"
HDROptions FBlackmagicMediaHDROptions HDR Metadata of the video signal. BlackmagicMediaOutput.h
  • EditAnywhere
  • Category="Output"
  • DisplayName="HDR"
NumberOfBlackmagicBuffers int32 Number of frame used to transfer from the system memory to the Blackmagic card. BlackmagicMediaOutput.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Output"
  • Meta=(UIMin=3, UIMax=4, ClampMin=3, ClampMax=4)
OutputChannelCount EBlackmagicMediaAudioOutputChannelCount Number of audio channels to output. BlackmagicMediaOutput.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Output"
OutputConfiguration FMediaIOOutputConfiguration The device, port and video settings that correspond to the output. BlackmagicMediaOutput.h
  • EditAnywhere
  • Category="Blackmagic"
  • Meta=(DisplayName="Configuration")
PixelFormat EBlackmagicMediaOutputPixelFormat Native data format internally used by the device before being converted to SDI/HDMI signal. BlackmagicMediaOutput.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Output"
TimecodeFormat EMediaIOTimecodeFormat Whether to embed the Engine's timecode to the output frame. BlackmagicMediaOutput.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Output"

Functions

Public

Name Remarks Include Path Unreal Specifiers

FFrameRate GetRequestedFrameRate()

   BlackmagicMediaOutput.h  

Overridden from UMediaOutput

Name Remarks Include Path Unreal Specifiers

virtual EMediaCaptureConversionOperation GetConversionOperation ( EMediaCaptureSourceType InSourceType
) const

   BlackmagicMediaOutput.h  

virtual FString GetDescriptionString()

   BlackmagicMediaOutput.h  

virtual void GetDetailsPanelInfoElements ( TArray< FInfoElement >& OutInfoElements
) const

   BlackmagicMediaOutput.h  

virtual EPixelFormat GetRequestedPixelFormat()

   BlackmagicMediaOutput.h  

virtual FIntPoint GetRequestedSize()

   BlackmagicMediaOutput.h  

virtual bool Validate ( FString& FailureReason
) const

   BlackmagicMediaOutput.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   BlackmagicMediaOutput.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& InPropertyChangedEvent
)

   BlackmagicMediaOutput.h  

Protected

Overridden from UMediaOutput

Name Remarks Include Path Unreal Specifiers

virtual UMediaCapture * CreateMediaCaptureImpl()

   BlackmagicMediaOutput.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page