ElectraBase

API > API/Plugins

   
Name ElectraBase
Type Plugin
Part of Plugins Electra Player Utilities
Location /Engine/Plugins/Media/ElectraUtil/Source/ElectraBase/
Module Build Rules ElectraBase.Build.cs

Classes

Name Remarks
FBitstreamReader  
FBitstreamWriter  
FESDescriptor  
FID3V2Metadata  
FMediaEvent  
FMediaLockCriticalSection Lock class for generic container classes requiring mutual exclusion access.
FMediaLockNone Empty lock class.
FMediaRunnable  
FMediaSemaphore  
FMediaThread A thread base class to either inherit from or use as a variable.
FParamDict  
FParamDictTS  
FStringIterator There is a known anomaly in the FString::TConstIterator.
FTimeFraction Keeps a time value as a fractional.
FTimeValue Keeps a time value in hundred nanoseconds (HNS).
FURL_RFC3986  
FVariantValue  
TMediaMessageQueueDynamicNoTimeout Generic message queue WITHOUT timeout support.
TMediaMessageQueueDynamicWithTimeout Generic message queue WITH timeout support.
TMediaMessageQueueNoTimeout Generic message queue WITHOUT timeout support.
TMediaMessageQueueStaticNoTimeout Generic message queue WITHOUT timeout support.
TMediaMessageQueueStaticWithTimeout Generic message queue WITH timeout support.
TMediaMessageQueueWithTimeout Generic message queue WITH timeout support.
TMediaNoncopyable  
TMediaQueue Object safe queue class.
TMediaQueueAllocator Default memory allocator.
TMediaQueueDynamic Dynamically sized queue.
TMediaQueueDynamicNoLock  
TMediaQueueFixedStatic Object safe queue class.
TMediaQueueFixedStaticNoLock  
TMediaQueueNoLock A mutex-less version of TMediaQueue to enable working with references.

Structs

Name Remarks
FCodecTypeFormat This structure contains codec format related information.
FDecoderInformation  
FDecoderTimeStamp  
FDRMTypeFormat Encryption information of a track.
FElectraByteReader  
FLanguageTag A parsed RFC-5646 language tag.
FMediaURL This struct describes a URL used in media streaming.
FTimeRange  
FVideoDecoderHDRMetadata_content_light_level_info  
FVideoDecoderHDRMetadata_mastering_display_colour_volume  

Interfaces

Name Remarks
IBaseDataReader Abstract base class to pass into
IElectraBaseModule Interface for the `ElectraBase_ module.
IMetaDataDecoderOutput  
ISubtitleDecoderOutput  
IVideoDecoderColorimetry  
IVideoDecoderHDRInformation  
IVideoDecoderTimecode  

Typedefs

Name Type Remarks Include Path
IMetaDataDecoderOutputPtr TSharedPtr< IMetaDataDecoderOutput, ESPMode::ThreadSafe >   MediaMetaDataDecoderOutput.h
ISubtitleDecoderOutputPtr TSharedPtr< ISubtitleDecoderOutput, ESPMode::ThreadSafe >   MediaSubtitleDecoderOutput.h
TSharedPtrTS TSharedPtr< T, ESPMode::ThreadSafe >   Core/MediaTypes.h
TWeakPtrTS TWeakPtr< T, ESPMode::ThreadSafe >   Core/MediaTypes.h
UEMediaError uint32 Include low level includes. This will also include HAL/Platform.h for our types. Core/MediaTypes.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

T Electra::AdvancePointer ( T pPointer,
C numBytes
)

 Advance a pointer by a number of bytes. Utilities/Utilities.h  

void Electra::LexFromStringHex ( int32& OutValue,
const TCHAR* Buffer
)

   Utilities/StringHelpers.h  

void Electra::LexFromStringHex64 ( int64& OutValue,
const TCHAR* Buffer
)

   Utilities/StringHelpers.h  

void Electra::LexFromStringHexU64 ( uint64& OutValue,
const TCHAR* Buffer
)

   Utilities/StringHelpers.h  

TSharedRef< T, ESPMode::ThreadSafe > Electra::MakeSharedTS ( ArgTypes&&... Args
)

   Core/MediaTypes.h  

T Electra::Utils::AbsoluteValue ( T Value
)

   Utilities/Utilities.h  

uint32 Electra::Utils::BitReverse32 ( uint32 InValue
)

   Utilities/Utilities.h  

uint16 Electra::Utils::EndianSwap ( uint16 value
)

   Utilities/Utilities.h  

int16 Electra::Utils::EndianSwap ( int16 value
)

   Utilities/Utilities.h  

uint32 Electra::Utils::EndianSwap ( uint32 value
)

   Utilities/Utilities.h  

int32 Electra::Utils::EndianSwap ( int32 value
)

   Utilities/Utilities.h  

uint64 Electra::Utils::EndianSwap ( uint64 value
)

   Utilities/Utilities.h  

int64 Electra::Utils::EndianSwap ( int64 value
)

   Utilities/Utilities.h  

uint32 Electra::Utils::Make4CC ( const uint8 A,
const uint8 B,
const uint8 C,
const uint8 D
)

   Utilities/Utilities.h  

T Electra::Utils::Max ( T a,
T b
)

   Utilities/Utilities.h  

T Electra::Utils::Min ( T a,
T b
)

   Utilities/Utilities.h  

uint32 FMediaInterlockedAdd ( uint32 volatile& variable,
uint32 value
)

   Core/MediaInterlocked.h  

int32 FMediaInterlockedAdd ( int32 volatile& variable,
int32 value
)

   Core/MediaInterlocked.h  

uint64 FMediaInterlockedAdd64 ( uint64 volatile& variable,
uint64 value
)

   Core/MediaInterlocked.h  

uint32 FMediaInterlockedCompareExchange ( uint32 volatile& variable,
uint32 exchangeValue,
uint32 compareValue
)

   Core/MediaInterlocked.h  

int32 FMediaInterlockedCompareExchange ( int32 volatile& variable,
int32 exchangeValue,
int32 compareValue
)

   Core/MediaInterlocked.h  

void * FMediaInterlockedCompareExchangePointer ( void*volatile& variable,
void* pExchangeValue,
void* pCompareValue
)

   Core/MediaInterlocked.h  

uint32 FMediaInterlockedDecrement ( uint32 volatile& variable
)

   Core/MediaInterlocked.h  

int32 FMediaInterlockedDecrement ( int32 volatile& variable
)

   Core/MediaInterlocked.h  

uint32 FMediaInterlockedExchange ( uint32 volatile& variable,
uint32 exchangeValue
)

   Core/MediaInterlocked.h  

int32 FMediaInterlockedExchange ( int32 volatile& variable,
int32 exchangeValue
)

   Core/MediaInterlocked.h  

void * FMediaInterlockedExchangePointerVoid ( void*volatile& variable,
void* pExchangeValue
)

   Core/MediaInterlocked.h  

uint32 FMediaInterlockedIncrement ( uint32 volatile& variable
)

   Core/MediaInterlocked.h  

int32 FMediaInterlockedIncrement ( int32 volatile& variable
)

   Core/MediaInterlocked.h  

uint32 FMediaInterlockedRead ( uint32 volatile& variable
)

   Core/MediaInterlocked.h  

int32 FMediaInterlockedRead ( int32 volatile& variable
)

   Core/MediaInterlocked.h  

uint64 FMediaInterlockedRead64 ( uint64 volatile& variable
)

   Core/MediaInterlocked.h  

T * TMediaInterlockedExchangePointer ( T*volatile& variable,
X* pExchangeValue
)

   Core/MediaInterlocked.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FName IDecoderOutputOptionNames::AspectH ( TEXT("aspect_h")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::AspectRatio ( TEXT("aspect_ratio")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::AspectW ( TEXT("aspect_w")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::BitsPerComponent ( TEXT("bits_per")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::Colorimetry ( TEXT("colorimetry")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::CropBottom ( TEXT("crop_bottom")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::CropLeft ( TEXT("crop_left")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::CropRight ( TEXT("crop_right")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::CropTop ( TEXT("crop_top")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::Duration ( TEXT("duration")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::FPSDenominator ( TEXT("fps_denom")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::FPSNumerator ( TEXT("fps_num")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::HDRInfo ( TEXT("hdr_info")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::Height ( TEXT("height")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::Orientation ( TEXT("orientation")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::Pitch ( TEXT("pitch")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::PixelDataScale ( TEXT("pix_datascale")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::PixelEncoding ( TEXT("pixelenc")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::PixelFormat ( TEXT("pixelfmt")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::PTS ( TEXT("pts")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::Timecode ( TEXT("timecode")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::TMCDFramerate ( TEXT("tmcd_framerate")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::TMCDTimecode ( TEXT("tmcd_timecode")
)

   MediaDecoderOutput.h  

static const FName IDecoderOutputOptionNames::Width ( TEXT("width")
)

   MediaDecoderOutput.h  

static uint16 MEDIA_ENDIAN_SWAP ( uint16 value
)

 Endian swapping Core/MediaMacros.h  

static int16 MEDIA_ENDIAN_SWAP ( int16 value
)

   Core/MediaMacros.h  

static uint32 MEDIA_ENDIAN_SWAP ( uint32 value
)

   Core/MediaMacros.h  

static int32 MEDIA_ENDIAN_SWAP ( int32 value
)

   Core/MediaMacros.h  

static uint64 MEDIA_ENDIAN_SWAP ( uint64 value
)

   Core/MediaMacros.h  

static int64 MEDIA_ENDIAN_SWAP ( int64 value
)

   Core/MediaMacros.h  

static uint8 MEDIA_FROM_BIG_ENDIAN ( uint8 value
)

   Core/MediaMacros.h  

static int8 MEDIA_FROM_BIG_ENDIAN ( int8 value
)

   Core/MediaMacros.h  

static uint16 MEDIA_FROM_BIG_ENDIAN ( uint16 value
)

 Convert a big endian value to native. Core/MediaMacros.h  

static int16 MEDIA_FROM_BIG_ENDIAN ( int16 value
)

   Core/MediaMacros.h  

static int32 MEDIA_FROM_BIG_ENDIAN ( int32 value
)

   Core/MediaMacros.h  

static uint32 MEDIA_FROM_BIG_ENDIAN ( uint32 value
)

   Core/MediaMacros.h  

static int64 MEDIA_FROM_BIG_ENDIAN ( int64 value
)

   Core/MediaMacros.h  

static uint64 MEDIA_FROM_BIG_ENDIAN ( uint64 value
)

   Core/MediaMacros.h  

static uint8 MEDIA_FROM_LITTLE_ENDIAN ( uint8 value
)

   Core/MediaMacros.h  

static int8 MEDIA_FROM_LITTLE_ENDIAN ( int8 value
)

   Core/MediaMacros.h  

static uint16 MEDIA_FROM_LITTLE_ENDIAN ( uint16 value
)

 Convert a little endian value to native. Core/MediaMacros.h  

static int16 MEDIA_FROM_LITTLE_ENDIAN ( int16 value
)

   Core/MediaMacros.h  

static int32 MEDIA_FROM_LITTLE_ENDIAN ( int32 value
)

   Core/MediaMacros.h  

static uint32 MEDIA_FROM_LITTLE_ENDIAN ( uint32 value
)

   Core/MediaMacros.h  

static int64 MEDIA_FROM_LITTLE_ENDIAN ( int64 value
)

   Core/MediaMacros.h  

static uint64 MEDIA_FROM_LITTLE_ENDIAN ( uint64 value
)

   Core/MediaMacros.h  

static uint8 MEDIA_TO_BIG_ENDIAN ( uint8 value
)

 Yes, there's no endian swapping with 8 bit values. We put them here so templated functions can be used with these types. Core/MediaMacros.h  

static int8 MEDIA_TO_BIG_ENDIAN ( int8 value
)

   Core/MediaMacros.h  

static uint16 MEDIA_TO_BIG_ENDIAN ( uint16 value
)

 Convert a native value to big endian. Core/MediaMacros.h  

static int16 MEDIA_TO_BIG_ENDIAN ( int16 value
)

   Core/MediaMacros.h  

static int32 MEDIA_TO_BIG_ENDIAN ( int32 value
)

   Core/MediaMacros.h  

static uint32 MEDIA_TO_BIG_ENDIAN ( uint32 value
)

   Core/MediaMacros.h  

static int64 MEDIA_TO_BIG_ENDIAN ( int64 value
)

   Core/MediaMacros.h  

static uint64 MEDIA_TO_BIG_ENDIAN ( uint64 value
)

   Core/MediaMacros.h  

static uint8 MEDIA_TO_LITTLE_ENDIAN ( uint8 value
)

   Core/MediaMacros.h  

static int8 MEDIA_TO_LITTLE_ENDIAN ( int8 value
)

   Core/MediaMacros.h  

static uint16 MEDIA_TO_LITTLE_ENDIAN ( uint16 value
)

 Convert a native value to little endian. Core/MediaMacros.h  

static int16 MEDIA_TO_LITTLE_ENDIAN ( int16 value
)

   Core/MediaMacros.h  

static int32 MEDIA_TO_LITTLE_ENDIAN ( int32 value
)

   Core/MediaMacros.h  

static uint32 MEDIA_TO_LITTLE_ENDIAN ( uint32 value
)

   Core/MediaMacros.h  

static int64 MEDIA_TO_LITTLE_ENDIAN ( int64 value
)

   Core/MediaMacros.h  

static uint64 MEDIA_TO_LITTLE_ENDIAN ( uint64 value
)

   Core/MediaMacros.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page