1. Epic GamesDeveloper
  3. FMediaIOCoreSampleContainer

FMediaIOCoreSampleContainer

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

Unreal Engine C++ API Reference > Plugins > MediaIOCore

Inheritance Hierarchy

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

  Type 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 FTimedDataInputEvaluationData CachedEvaluationData Last evaluation data for that channel
Protected variable TArray< FTimedDataChannelSampleTime > 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 FCriticalSection CriticalSection Sample container: We add at the beginning of the array [0] and we pop at the end [Size-1].
Protected variable FMediaIOSamplingSettings EvaluationSettings Channel settings
Protected variable TAtomic< int32 > FrameDrop  
Protected variable TArray< TSharedPtr< SampleType, ESPMode::ThreadSafe > > Samples  

Constructors

  Type Name Description
Public function    
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function bool

AddSample ( const TSharedRef< SampleType, ESPMode::ThreadSafe >& Sample
)

 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::ThreadSafe >& OutSample
)

  
Public function void  
Public function FTimespan Get next sample time from the sample list.
Public function Const TArray< TSharedPtr< SampleType, ESPMode::ThreadSafe > > Returns all available samples
Public function Const int32 Get the number of queued samples.
Public function bool Pop a sample from the cache.
Public function void Update this sample container settings

Overridden from ITimedDataInputChannel

  Type Name Description
Public function Virtual Const int32 Return buffer overflow count detected by this input
Public function Virtual Const int32 Return buffer underflow count detected by this input
Public function Virtual Const int32 If the channel does support it, get the current maximum sample count of channel.
Public function Virtual Const TArray< FTimedDataChannelSampleTime > Get the time of all the data samples available.
Public function Virtual Const FText Get the channel's display name.
Public function Virtual Const int32 Return frame dropped count detected by this input
Public function Virtual Const void Get data about last evaluation. Samples used, expected, number of samples.
Public function Virtual Const FTimedDataChannelSampleTime Get the time of the newest data sample available.
Public function Virtual Const int32 Get the number of data samples available.
Public function Virtual Const FTimedDataChannelSampleTime Get the time of the oldest data sample available.
Public function Virtual Const ETimedDataInputState Get the current state of the channel.
Public function Virtual Const bool Is tracking of stats enabled for this input
Public function Virtual void 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

  Type Name Description
Public function FMediaIOCoreSampleContainer &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page