1. Epic GamesDeveloper
  3. UNDIMediaOutput

UNDIMediaOutput

Note: Other formats YUV 8 bits or YUV 16 bits, both support fill and key as well.

API > API/Plugins > API/Plugins/NDIMedia

Inheritance Hierarchy

References

   
Module NDIMedia
Header /Engine/Plugins/Media/NDIMedia/Source/NDIMedia/Public/NDIMediaOutput.h
Include #include "NDIMediaOutput.h"

Syntax

UCLASS (BlueprintType, Meta=(MediaIOCustomLayout="NDI"))  
class UNDIMediaOutput : public UMediaOutput

Remarks

Note: Other formats YUV 8 bits or YUV 16 bits, both support fill and key as well.

Format mapping: 8 bit RGBA Fill: NDIlib_FourCC_type_BGRX 8 bit RGBA Fill&Key: NDIlib_FourCC_type_BGRA 8 bits YUV Fill: NDIlib_FourCC_type_UYVY (422) 8 bits YUV Fill&Key: NDIlib_FourCC_type_UYVA (422+4) 16 bits YUV Fill: NDIlib_FourCC_type_P216 (422) 16 bits YUV Fill&Key:NDIlib_FourCC_type_PA16 (422+4)

10 bits is not supported. Output information for a NDI media capture.

'Frame Buffer Pixel Format' must be set to RGBA8

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bInvertKeyOutput Options on how to save the images.
Public variable UProperty Category BlueprintReadWrite bool bOverrideDesiredSize Use the default back buffer size or specify a specific size to capture.
Public variable UProperty Category BlueprintReadWrite bool bOverridePixelFormat Use the default back buffer pixel format or specify a specific the pixel format to capture.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bWaitForSyncEvent Wait for the NDI source sync event.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite ENDIMediaOutputPixelFormat DesiredPixelFormat Use the default back buffer pixel format or specify a specific the pixel format to capture.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FIntPoint DesiredSize Use the default back buffer size or specify a specific size to capture.
Public variable UProperty Category, EditDefaultsOnly BlueprintReadWrite FFrameRate FrameRate Represents the desired number of frames (per second) for video to be sent over NDI
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FString GroupName Defines the group this source is part of.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EMediaIOOutputType OutputType Whether to output the fill or the fill and key.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FString SourceName Describes a user-friendly name of the output stream to differentiate from other output streams on the current machine

Constructors

  Type Name Description
Public function  

UNDIMediaOutput ( const FObjectInitializer& ObjectInitializer
)

  

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& FailureReason
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page