Navigation
API > API/Plugins > API/Plugins/NDIMedia
Media source for NDI streams.
| Name | UNDIMediaSource |
| Type | class |
| Header File | /Engine/Plugins/Media/NDIMedia/Source/NDIMedia/Public/NDIMediaSource.h |
| Include Path | #include "NDIMediaSource.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, HideCategories=(Platforms, Object),
prioritizeCategories=(NDI, Video, Audio, Ancillary, Synchronization, Debug),
Meta=(MediaIOCustomLayout="NDI"))
class UNDIMediaSource : public UCaptureCardMediaSource
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMediaSource → UBaseMediaSource → UTimeSynchronizableMediaSource → UCaptureCardMediaSource → UNDIMediaSource
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNDIMediaSource() |
Default constructor. | NDIMediaSource.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnOptionChanged | TMulticastDelegate_TwoParams< void, UObject *, FPropertyChangedEvent & > | Delegate called when an NDI Media Source is modified. | NDIMediaSource.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| OnOptionChanged | FOnOptionChanged | NDIMediaSource.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Bandwidth | ENDIReceiverBandwidth | Indicates the current bandwidth mode used for the connection to this source | NDIMediaSource.h |
|
| bCaptureAncillary | bool | Capture Ancillary from the NDI source. It will decrease performance | NDIMediaSource.h |
|
| bCaptureAudio | bool | Capture Audio from the NDI source. | NDIMediaSource.h |
|
| bCaptureVideo | bool | Capture Video from the NDI source. | NDIMediaSource.h |
|
| bEncodeTimecodeInTexel | bool | Burn Frame Timecode in the input texture without any frame number clipping. | NDIMediaSource.h |
|
| bLogDropFrame | bool | Log a warning when there's a drop frame. | NDIMediaSource.h |
|
| bSyncTimecodeToSource | bool | Indicates whether the timecode should be synced to the Source Timecode value or engine's. | NDIMediaSource.h |
|
| MaxNumAncillaryFrameBuffer | int32 | Maximum number of ancillary data frames to buffer. | NDIMediaSource.h |
|
| MaxNumAudioFrameBuffer | int32 | Maximum number of audio frames to buffer. | NDIMediaSource.h |
|
| MaxNumVideoFrameBuffer | int32 | Maximum number of video frames to buffer. | NDIMediaSource.h |
|
| MediaConfiguration | FMediaIOConfiguration | The device, port and video settings that correspond to the input. | NDIMediaSource.h |
|
Functions
Public
Overridden from UTimeSynchronizableMediaSource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool SupportsFormatAutoDetection() |
NDIMediaSource.h |
Overridden from UMediaSource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetUrl() |
NDIMediaSource.h | ||
virtual bool Validate() |
NDIMediaSource.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& InPropertyChangedEvent |
NDIMediaSource.h | ||
virtual void PostLoad() |
NDIMediaSource.h |
Overridden from IMediaOptions
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool GetMediaOption
(
const FName& Key, |
NDIMediaSource.h | ||
virtual int64 GetMediaOption
(
const FName& Key, |
NDIMediaSource.h | ||
virtual FString GetMediaOption
(
const FName& Key, |
NDIMediaSource.h | ||
virtual bool HasMediaOption
(
const FName& Key |
NDIMediaSource.h |