UBlackmagicMediaOutput

Output information for a MediaCapture.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMediaOutput

UBlackmagicMediaOutput

References

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

Syntax

UCLASS(BlueprintType, Meta=(MediaIOCustomLayout="Blackmagic"))
class UBlackmagicMediaOutput : public UMediaOutput

Remarks

Output information for a MediaCapture. @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.

Variables

	Name	Description
EBlackmagicMedi...	AudioBitDepth	Bit depth of each audio sample.
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.
EBlackmagicMedi...	AudioSampleRate	Sample rate of the audio output.
bool	bEncodeTimecodeInTexel	Burn Frame Timecode on the output without any frame number clipping.
bool	bInterlacedFieldsTimecodeNeedToMatch	Only make sense in interlaced mode.
bool	bInvertKeyOutput	Invert Key Output
bool	bLogDropFrame	Log a warning when there's a drop frame.
bool	bOutputAudio	Whether to capture and output audio from the engine.
bool	bWaitForSyncEvent	Try to maintain a the engine "Genlock" with the VSync signal.
int32	NumberOfBlackmagicBuffers	Number of frame used to transfer from the system memory to the Blackmagic card.
EBlackmagicMedi...	OutputChannelCount	Number of audio channels to output.
FMediaIOOutputC...	OutputConfiguration	The device, port and video settings that correspond to the output.
EBlackmagicMedi...	PixelFormat	Native data format internally used by the device before being converted to SDI/HDMI signal.
EMediaIOTimecod...	TimecodeFormat	Whether to embed the Engine's timecode to the output frame.

Constructors

	Name	Description
	UBlackmagicMediaOutput ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	FFrameRate	GetRequestedFrameRate()

Overridden from UMediaOutput

	Name	Description
UMediaCaptur...	CreateMediaCaptureImpl()
EMediaCaptur...	GetConversionOperation ( EMediaCaptureSourceType InSourceTyp... )	The conversion we wish to accomplish on the GPU before the DMA transfer occurs.
EPixelFormat	GetRequestedPixelFormat()	The pixel format of the buffer we wish to capture.
FIntPoint	GetRequestedSize()	The size of the buffer we wish to capture.
bool	Validate ( FString& OutFailureReason )	Validate the media output settings (must be implemented in child classes).

Overridden from UObject

		Name	Description
	bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
	void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.