Navigation
API > API/Plugins > API/Plugins/MediaIOCore
MediaIO container for different types of samples. Also a TimedData channel that can be monitored
| Name | FMediaIOCoreSampleContainer |
| Type | class |
| Header File | /Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCoreSampleContainer.h |
| Include Path | #include "MediaIOCoreSampleContainer.h" |
Syntax
template<typename SampleType>
class FMediaIOCoreSampleContainer : public ITimedDataInputChannel
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMediaIOCoreSampleContainer
(
FName InChannelName |
MediaIOCoreSampleContainer.h | ||
| MediaIOCoreSampleContainer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FMediaIOCoreSampleContainer() |
MediaIOCoreSampleContainer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddSample
(
const TSharedRef< SampleType, ESPMode::ThreadSafe >& Sample |
Add the given sample to the cache. | MediaIOCoreSampleContainer.h | |
void CacheState
(
FTimespan PlayerTime |
Caches the current sample container states before samples will be taken out of it | MediaIOCoreSampleContainer.h | |
void EnableChannel
(
ITimedDataInput* Input, |
Channel is disabled by default. It won't be added to the Timed Data collection if not enabled | MediaIOCoreSampleContainer.h | |
bool FetchSample
(
TRange< FTimespan > TimeRange, |
MediaIOCoreSampleContainer.h | ||
void FlushSamples() |
MediaIOCoreSampleContainer.h | ||
| Get next sample time from the sample list. | MediaIOCoreSampleContainer.h | ||
TArray< TSharedPtr< SampleType, ESPMode::ThreadSafe > > GetSamples() |
Returns all available samples | MediaIOCoreSampleContainer.h | |
int32 NumSamples () |
Get the number of queued samples. | MediaIOCoreSampleContainer.h | |
bool PopSample () |
Pop a sample from the cache. | MediaIOCoreSampleContainer.h | |
void UpdateSettings
(
const FMediaIOSamplingSettings& InSettings |
Update this sample container settings | MediaIOCoreSampleContainer.h |
Overridden from ITimedDataInputChannel
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 GetBufferOverflowStat() |
MediaIOCoreSampleContainer.h | ||
virtual int32 GetBufferUnderflowStat() |
MediaIOCoreSampleContainer.h | ||
virtual int32 GetDataBufferSize() |
MediaIOCoreSampleContainer.h | ||
virtual TArray< FTimedDataChannelSampleTime > GetDataTimes() |
MediaIOCoreSampleContainer.h | ||
virtual FText GetDisplayName() |
MediaIOCoreSampleContainer.h | ||
virtual int32 GetFrameDroppedStat() |
MediaIOCoreSampleContainer.h | ||
virtual void GetLastEvaluationData
(
FTimedDataInputEvaluationData& OutEvaluationData |
MediaIOCoreSampleContainer.h | ||
virtual FTimedDataChannelSampleTime GetNewestDataTime() |
MediaIOCoreSampleContainer.h | ||
virtual int32 GetNumberOfSamples() |
MediaIOCoreSampleContainer.h | ||
virtual FTimedDataChannelSampleTime GetOldestDataTime() |
MediaIOCoreSampleContainer.h | ||
virtual ETimedDataInputState GetState() |
MediaIOCoreSampleContainer.h | ||
virtual bool IsBufferStatsEnabled() |
MediaIOCoreSampleContainer.h | ||
virtual void ResetBufferStats() |
MediaIOCoreSampleContainer.h | ||
virtual void SetBufferStatsEnabled
(
bool bEnable |
MediaIOCoreSampleContainer.h | ||
virtual void SetDataBufferSize
(
int32 BufferSize |
MediaIOCoreSampleContainer.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMediaIOCoreSampleContainer & operator=
(
const FMediaIOCoreSampleContainer& |
MediaIOCoreSampleContainer.h |