Navigation
API > API/Plugins > API/Plugins/NDIMedia
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
| Name | UNDIMediaOutput |
| Type | class |
| Header File | /Engine/Plugins/Media/NDIMedia/Source/NDIMedia/Public/NDIMediaOutput.h |
| Include Path | #include "NDIMediaOutput.h" |
Syntax
UCLASS (BlueprintType, prioritizeCategories=(Media, Audio, Output, Synchronization),
Meta=(MediaIOCustomLayout="NDI"))
class UNDIMediaOutput : public UMediaOutput
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMediaOutput → UNDIMediaOutput
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNDIMediaOutput
(
const FObjectInitializer& ObjectInitializer |
NDIMediaOutput.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioBufferSize | int32 | Size of the buffer that holds rendered audio samples, a bigger buffer will produce a more stable output signal but will introduce more delay. | NDIMediaOutput.h |
|
| AudioSampleRate | ENDIMediaOutputAudioSampleRate | NDI Audio supports any sample rate. The standard for live production is 48 kHz. | NDIMediaOutput.h |
|
| bInvertKeyOutput | bool | Options on how to save the images. | NDIMediaOutput.h |
|
| bOutputAudio | bool | Whether to capture and output audio from the engine. | NDIMediaOutput.h |
|
| bOverrideDesiredSize | bool | Use the default back buffer size or specify a specific size to capture. | NDIMediaOutput.h |
|
| bOverridePixelFormat | bool | Use the default back buffer pixel format or specify a specific the pixel format to capture. | NDIMediaOutput.h |
|
| bSendAudioOnlyIfReceiversConnected | bool | As an optimization, the audio will not be converted and sent if there are no connected receivers. | NDIMediaOutput.h |
|
| bWaitForSyncEvent | bool | Wait for the NDI source sync event. | NDIMediaOutput.h |
|
| DesiredPixelFormat | ENDIMediaOutputPixelFormat | Use the default back buffer pixel format or specify a specific the pixel format to capture. | NDIMediaOutput.h |
|
| DesiredSize | FIntPoint | Use the default back buffer size or specify a specific size to capture. | NDIMediaOutput.h |
|
| FrameRate | FFrameRate | Represents the desired number of frames (per second) for video to be sent over NDI | NDIMediaOutput.h |
|
| GroupName | FString | Defines the group this source is part of. | NDIMediaOutput.h |
|
| NumOutputAudioChannels | int32 | An individual NDI stream can transport multiple audio channels. | NDIMediaOutput.h |
|
| OutputType | EMediaIOOutputType | Whether to output the fill or the fill and key. | NDIMediaOutput.h |
|
| SourceName | FString | Describes a user-friendly name of the output stream to differentiate from other output streams on the current machine | NDIMediaOutput.h |
|
Functions
Public
Overridden from UMediaOutput
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EMediaCaptureConversionOperation GetConversionOperation
(
EMediaCaptureSourceType InSourceType |
NDIMediaOutput.h | ||
virtual FString GetDescriptionString() |
NDIMediaOutput.h | ||
virtual void GetDetailsPanelInfoElements
(
TArray< FInfoElement >& OutInfoElements |
NDIMediaOutput.h | ||
virtual EPixelFormat GetRequestedPixelFormat() |
NDIMediaOutput.h | ||
virtual FIntPoint GetRequestedSize() |
NDIMediaOutput.h | ||
virtual bool Validate
(
FString& FailureReason |
NDIMediaOutput.h |
Protected
Overridden from UMediaOutput
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UMediaCapture * CreateMediaCaptureImpl() |
NDIMediaOutput.h |