MediaIOCore

API > API/Plugins

   
Name MediaIOCore
Type Plugin
Part of Plugins Media IO Framework
Location /Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/
Module Build Rules MediaIOCore.Build.cs

Classes

Name Remarks
FBlendDeinterlacer Line-doubles both fields to full height and per-pixel averages them. One sample per source frame.
FBobDeinterlacer Line-double each field independently.
FDeinterlacer Handles deinterlacing a video signal.
FDiscardDeinterlacer Discards one of the fields (based on InterlaceFieldOrder) and line-doubles the kept field to full height.
FMainMediaIOAudioCapture Audio capture that automatically registers to the main engine device.
FMediaCaptureStateChangedSignature Delegate signatures
FMediaCaptureUserData Base class of additional data that can be stored for each requested capture.
FMediaIOAudioCapture Handles capturing audio samples rendered by the engine and dispatching them to outputs.
FMediaIOAudioOutput  
FMediaIOCoreAudioSampleBase Implements a media audio sample.
FMediaIOCoreBinarySampleBase Implements a media binary data sample.
FMediaIOCoreCaptionSampleBase Implements a media caption sample.
FMediaIOCoreEncodeTime  
FMediaIOCorePlayerBase Implements a base player for hardware IO cards.
FMediaIOCoreSampleContainer MediaIO container for different types of samples. Also a TimedData channel that can be monitored
FMediaIOCoreSamples General purpose media sample queue.
FMediaIOCoreSubtitleSampleBase Implements a media subtitle sample.
FMediaIOCoreTextureSampleBase Implements the IMediaTextureSample/IMediaPoolable interface.
FMediaIOCoreTextureSampleConverter Media IO base texture sample converter.
FMediaIOCoreWaitVSyncThread  
FOrderedAsyncGate Class to ensure that async tasks execute any critical path in order.
UBlendDeinterlacer Combines both fields into a single full-resolution image. Moving objects appear slightly ghosted.
UBobDeinterlacer Doubles the frame rate by treating each field as its own moment.
UCaptureCardMediaSource Base class for media sources that are coming from a capture card.
UDiscardDeinterlacer Keeps a single field and line-doubles it. Simple and clean, but with reduced vertical detail.
UFileMediaCapture  
UFileMediaOutput Output information for a file media capture.
UMediaCapture Abstract base class for media capture.
UMediaIOCoreSubsystem  
UMediaOutput Abstract base class for media output.
UVideoDeinterlacer Represents a deinterlacing algorithm.

Structs

Name Remarks
FAudioDebugDump  
FAudioDebugDumpSystem  
FLogCategoryLogMediaIOAudioDebug Single header drop in file to help diagnose audio issues
FMediaCaptureOptions Base class of additional data that can be stored for each requested capture.
FMediaCaptureTransform  
FMediaIOAutoDetectableTimecodeFormat_Backup  
FMediaIOCommonDisplayModeInfo  
FMediaIOCommonDisplayModeResolutionInfo  
FMediaIOCommonDisplayModes  
FMediaIOConfiguration Configuration of a device input / output.
FMediaIOConnection Identifies an media connection.
FMediaIOCoreMediaOption  
FMediaIOCoreSampleJITRConfigurationArgs Used to setup JITR data for a sample
FMediaIODevice Identifies a device.
FMediaIOInputConfiguration Configuration of a device input.
FMediaIOMode Identifies a media mode.
FMediaIOOutputConfiguration Configuration of a device output.
FMediaIOSamplingSettings  
FMediaIOVideoTimecodeConfiguration Configuration of a Timecode from Video
FRHICaptureResourceDescription Description of resource to be captured when in rhi capture / immediate mode.
FVideoFrame Description of a video frame.

Interfaces

Name Remarks
IMediaIOCoreDeviceProvider  
IMediaIOCoreHardwareSync Interface to Hardware Sync Device
IMediaIOCoreModule Definition the MediaIOCore module.

Typedefs

Name Type Remarks Include Path
FMediaCaptureOutputSynchronization TBaseDelegate_NoParams< void >   MediaCapture.h
FMediaCaptureStateChangedSignatureNative TMulticastDelegate_NoParams< void >   MediaCapture.h
FOnBufferReceived TBaseDelegate_TwoParams< void, uint8 *Buffer, int32 BufferSize >   MediaIOCoreAudioOutput.h
TextureTransferPtr TSharedPtr< class ITextureTransfer >   MediaIOCorePlayerBase.h

Enums

Public

Name Remarks
EFileMediaOutputPixelFormat Texture format supported by UFileMediaOutput.
EMediaCaptureConversionOperation  
EMediaCaptureCroppingType Type of cropping
EMediaCaptureOverrunAction Action when overrun occurs
EMediaCapturePhase  
EMediaCaptureResizeMethod  
EMediaCaptureResourceType Possible resource type the MediaCapture can create based on the conversion operation.
EMediaCaptureRotation  
EMediaCaptureSourceType  
EMediaCaptureState Possible states of media capture.
EMediaIOAutoDetectableTimecodeFormat Timecode formats.
EMediaIOCoreColorFormat  
EMediaIOCoreEncodePixelFormat  
EMediaIOInputType SDI Input type.
EMediaIOInterlaceFieldOrder Which interlace field should be set first in the buffer.
EMediaIOOutputType SDI Output type.
EMediaIOQuadLinkTransportType Quad link transport type.
EMediaIOReferenceType SDI Output type.
EMediaIOSampleEvaluationType Various sample evaluation types available in MediaIO.
EMediaIOSampleType Bitflags about different types of sample a MediaIO can push
EMediaIOStandardType SDI transport type.
EMediaIOTimecodeFormat Timecode formats.
EMediaIOTransportType Media transport type.

Constants

Name Type Remarks Include Path
LogMediaIOAudioDebug FLogCategoryLogMediaIOAudioDebug   MediaIOAudioDebug.h
UE::MediaIOAudioDebug::bProcessAudio bool   MediaIOAudioDebug.h
UE::MediaIOAudioDebug::SecondsToDumpFor int32   MediaIOAudioDebug.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ColorSpaceType UE::Color::EColorSpace Color space of the texture. MediaIOCoreTextureSampleBase.h  
Encoding UE::Color::EEncoding Encoding of the texture. MediaIOCoreTextureSampleBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool operator! ( EMediaIOSampleType E
)

   MediaIOCoreSamples.h  
  MediaIOCoreSamples.h  
  MediaIOCoreSamples.h  
  MediaIOCoreSamples.h  
  MediaIOCoreSamples.h  
  MediaIOCoreSamples.h  
  MediaIOCoreSamples.h  
  MediaIOCoreSamples.h  

UE::MediaIOCore::FColorFormatArgs ( bool bIsSRGBInput
)

 Bool constructor to allow backwards compatibility with previous method definitions of FMediaIOCoreTextureSampleBase::Initialize. MediaIOCoreTextureSampleBase.h  
  MediaIOCoreTextureSampleBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName UE::CaptureCardMediaSource::Deinterlacer ( "Deinterlacer"
)

   CaptureCardMediaSource.h  

static FName UE::CaptureCardMediaSource::EvaluationType ( "EvaluationType"
)

   CaptureCardMediaSource.h  

static FName UE::CaptureCardMediaSource::Framelock ( "Framelock"
)

   CaptureCardMediaSource.h  

static FName UE::CaptureCardMediaSource::InterlaceFieldOrder ( "InterlaceFieldOrder"
)

   CaptureCardMediaSource.h  

static FName UE::CaptureCardMediaSource::OpenColorIOSettings ( "OpenColorIOSettings"
)

   CaptureCardMediaSource.h  

static FName UE::CaptureCardMediaSource::OverrideSourceColorSpace ( "OverrideSourceColorSpace_DEPRECATED"
)

   CaptureCardMediaSource.h  

static FName UE::CaptureCardMediaSource::OverrideSourceEncoding ( "OverrideSourceEncoding_DEPRECATED"
)

 5.8 deprecated options CaptureCardMediaSource.h  

static FName UE::CaptureCardMediaSource::RenderJIT ( "RenderJIT"
)

   CaptureCardMediaSource.h  

static FName UE::CaptureCardMediaSource::SourceColorSettingsOption ( "SourceColorSettings"
)

   CaptureCardMediaSource.h  

static FName UE::CaptureCardMediaSource::SourceColorSpace ( "SourceColorcSpace_DEPRECATED"
)

   CaptureCardMediaSource.h  

static FName UE::CaptureCardMediaSource::SourceEncoding ( "SourceEncoding_DEPRECATED"
)

   CaptureCardMediaSource.h  

static EMediaIOTimecodeFormat UE::MediaIO::FromAutoDetectableTimecodeFormat ( EMediaIOAutoDetectableTimecodeFormat TimecodeFormat
)

   MediaIOCoreDefinitions.h  

static void UE::MediaIO::LogThrottle ( const FLogCategoryBase& InLogCategory,
ELogVerbosity::Type InVerbosity,
const FTimespan& InTimeBetweenLogs,
const FString& LogDetails,
const FString& FileName,
int32 LineNumber
)

   MediaIOCoreUtilities.h  

static EMediaIOAutoDetectableTimecodeFormat UE::MediaIO::ToAutoDetectableTimecodeFormat ( EMediaIOTimecodeFormat TimecodeFormat
)

   MediaIOCoreDefinitions.h  

static FAutoConsoleCommand UE::MediaIOAudioDebug::CAudioDebug ( TEXT("MediaIO.DumpAudio")
)

   MediaIOAudioDebug.h  

static FAudioDebugDumpSystem & UE::MediaIOAudioDebug::GetSingleton()

   MediaIOAudioDebug.h  

static void UE::MediaIOAudioDebug::Private::SerializeWaveFile ( TArray< uint8 >& OutWaveFileData,
const uint8* InPCMData,
const int32 NumBytes,
const int32 NumChannels,
const int32 SampleRate,
const int32 BytesPerSample,
bool bFloatingPoint
)

   MediaIOAudioDebug.h  

static void UE::MediaIOAudioDebug::Private::WriteUInt16ToByteArrayLE ( TArray< uint8 >& InByteArray,
int32& Index,
const uint16 Value
)

   MediaIOAudioDebug.h  

static void UE::MediaIOAudioDebug::Private::WriteUInt32ToByteArrayLE ( TArray< uint8 >& InByteArray,
int32& Index,
const uint32 Value
)

   MediaIOAudioDebug.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page