FMediaIOCoreSampleContainer

MediaIO container for different types of samples. Also a TimedData channel that can be monitored

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

ITimedDataInputChannel

FMediaIOCoreSampleContainer

References

Module

MediaIOCore

Header

/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCoreSampleContainer.h

Include

#include "MediaIOCoreSampleContainer.h"

Syntax

template<typename SampleType>
class FMediaIOCoreSampleContainer : public ITimedDataInputChannel

Remarks

MediaIO container for different types of samples. Also a TimedData channel that can be monitored

Variables

Name Description

Protected variable

bool

 

bIsChannelEnabled

Should this channel be considered available

Protected variable

bool

 

bIsStatEnabled

Stats logging enabled or not

Protected variable

TAtomic< int32 ...

 

BufferOverflow

Protected variable

TAtomic< int32 ...

 

BufferUnderflow

Evaluation statistics we keep track of

Protected variable

FTimedDataInput...

 

CachedEvaluationData

Last evaluation data for that channel

Protected variable

TArray< FTimedD...

 

CachedSamplesData

Samples are consumed by the the facade layer when evaluating and sending to render thread.

Protected variable

FName

 

ChannelName

Name of this channel

Protected variable

FCriticalSectio...

 

CriticalSection

Sample container: We add at the beginning of the array [0] and we pop at the end [Size-1].

Protected variable

FMediaIOSamplin...

 

EvaluationSettings

Channel settings

Protected variable

TAtomic< int32 ...

 

FrameDrop

Protected variable

TArray< TShared...

 

Samples

Constructors

Name Description

Public function

FMediaIOCoreSampleContainer

(
    FName InChannelName
)

Public function

FMediaIOCoreSampleContainer

(
    const FMediaIOCoreSampleContainer&
)

Destructors

Functions

Name Description

Public function

bool

 

AddSample

(
    const TSharedRef< SampleType, ESPMo...
)

Add the given sample to the cache.

Public function

void

 

CacheState

(
    FTimespan PlayerTime
)

Caches the current sample container states before samples will be taken out of it

Public function

void

 

EnableChannel

(
    ITimedDataInput* Input,
    bool bShouldEnable
)

Channel is disabled by default. It won't be added to the Timed Data collection if not enabled

Public function

bool

 

FetchSample

(
    TRange< FTimespan > TimeRange,
    TSharedPtr< SampleType, ESPMode::Th...
)

Public function

void

 

FlushSamples()

Public function

FTimespan

 

GetNextSampleTime()

Get next sample time from the sample list.

Public function Const

int32

 

NumSamples()

Get the number of queued samples.

Public function

bool

 

PopSample()

Pop a sample from the cache.

Public function

void

 

UpdateSettings

(
    const FMediaIOSamplingSettings& In...
)

Update this sample container settings

Overridden from ITimedDataInputChannel

Name Description

Public function Virtual Const

int32

 

GetBufferOverflowStat()

Return buffer overflow count detected by this input

Public function Virtual Const

int32

 

GetBufferUnderflowStat()

Return buffer underflow count detected by this input

Public function Virtual Const

int32

 

GetDataBufferSize()

If the channel does support it, get the current maximum sample count of channel.

Public function Virtual Const

TArray< FTim...

 

GetDataTimes()

Get the time of all the data samples available.

Public function Virtual Const

FText

 

GetDisplayName()

Get the channel's display name.

Public function Virtual Const

int32

 

GetFrameDroppedStat()

Return frame dropped count detected by this input

Public function Virtual Const

void

 

GetLastEvaluationData

(
    FTimedDataInputEvaluationData& Out...
)

Get data about last evaluation. Samples used, expected, number of samples.

Public function Virtual Const

FTimedDataCh...

 

GetNewestDataTime()

Get the time of the newest data sample available.

Public function Virtual Const

int32

 

GetNumberOfSamples()

Get the number of data samples available.

Public function Virtual Const

FTimedDataCh...

 

GetOldestDataTime()

Get the time of the oldest data sample available.

Public function Virtual Const

ETimedDataIn...

 

GetState()

Get the current state of the channel.

Public function Virtual Const

bool

 

IsBufferStatsEnabled()

Is tracking of stats enabled for this input

Public function Virtual

void

 

ResetBufferStats()

Resets internal stat counters

Public function Virtual

void

 

SetBufferStatsEnabled

(
    bool bEnable
)

Enables or disables stats tracking for this input

Public function Virtual

void

 

SetDataBufferSize

(
    int32 BufferSize
)

If the channel does support it, set the maximum sample count of the channel.

Operators

Name Description

Public function

FMediaIOCore...

 

operator=

(
    const FMediaIOCoreSampleContainer&
)