1. Epic GamesDeveloper
  3. FMediaIOCoreSamples

FMediaIOCoreSamples

General purpose media sample queue.

Unreal Engine C++ API Reference > Plugins > MediaIOCore

Inheritance Hierarchy

References

   
Module MediaIOCore
Header /Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCoreSamples.h
Include #include "MediaIOCoreSamples.h"

Syntax

class FMediaIOCoreSamples : public IMediaSamples

Remarks

General purpose media sample queue.

Variables

  Type Name Description
Protected variable FMediaIOCoreSampleContainer< IMediaAudioSample > AudioSamples  
Protected variable FMediaIOCoreSampleContainer< IMediaOverlaySample > CaptionSamples  
Protected variable FMediaIOCoreSampleContainer< IMediaBinarySample > MetadataSamples  
Protected variable FMediaIOCoreSampleContainer< IMediaOverlaySample > SubtitleSamples  
Protected variable FMediaIOCoreSampleContainer< IMediaTextureSample > VideoSamples  

Constructors

  Type Name Description
Public function    
Public function    

Functions

  Type Name Description
Public function bool

AddAudio ( const TSharedRef< IMediaAudioSample, ESPMode::ThreadSafe >& Sample
)

 Add the given audio sample to the cache.
Public function bool

AddCaption ( const TSharedRef< IMediaOverlaySample, ESPMode::ThreadSafe >& Sample
)

 Add the given caption sample to the cache.
Public function bool

AddMetadata ( const TSharedRef< IMediaBinarySample, ESPMode::ThreadSafe >& Sample
)

 Add the given metadata sample to the cache.
Public function bool

AddSubtitle ( const TSharedRef< IMediaOverlaySample, ESPMode::ThreadSafe >& Sample
)

 Add the given subtitle sample to the cache.
Public function bool

AddVideo ( const TSharedRef< IMediaTextureSample, ESPMode::ThreadSafe >& Sample
)

 Add the given video sample to the cache.
Public function void

CacheSamplesState ( FTimespan PlayerTime
)

 Caches the current sample container state for a given Player (evaluation) time
Public function void Enable or disable channels based on bitfield flag
Public function Const int32 Get Audio Samples frame dropped count.
Public function Const int32 Get Caption Samples frame dropped count.
Public function Const int32 Get Metadata Samples frame dropped count.
Public function FTimespan Get next sample time from the VideoSampleQueue.
Public function Const int32 Get Subtitles Samples frame dropped count.
Public function Const int32 Get Video Samples frame dropped count.
Public function Const TArray< TSharedPtr< IMediaTextureSample, ESPMode::ThreadSafe > > Returns all available video samples
Public function void  
Public function void  
Public function void  
Public function void  
Public function void Initialize our different buffers with player's settings and wheter or not it should be displayed / supported in Timing monitor
Public function Const int32 Get the number of queued audio samples.
Public function Const int32 Get the number of queued caption samples.
Public function bool Pop a Audio sample from the cache.
Public function bool Pop a Caption sample from the cache.
Public function bool Pop a Metadata sample from the cache.
Public function bool Pop a Subtitle sample from the cache.
Public function bool Pop a video sample from the cache.

Overridden from IMediaSamples

  Type Name Description
Public function Virtual bool

FetchAudio ( TRange< FTimespan > TimeRange,
TSharedPtr< IMediaAudioSample, ESPMode::ThreadSafe >& OutSample
)

 Fetch the next audio sample.
Public function Virtual bool

FetchCaption ( TRange< FTimespan > TimeRange,
TSharedPtr< IMediaOverlaySample, ESPMode::ThreadSafe >& OutSample
)

 Fetch the next caption sample.
Public function Virtual bool

FetchMetadata ( TRange< FTimespan > TimeRange,
TSharedPtr< IMediaBinarySample, ESPMode::ThreadSafe >& OutSample
)

 Fetch the next metadata sample.
Public function Virtual bool

FetchSubtitle ( TRange< FTimespan > TimeRange,
TSharedPtr< IMediaOverlaySample, ESPMode::ThreadSafe >& OutSample
)

 Fetch the next subtitle sample.
Public function Virtual bool

FetchVideo ( TRange< FTimespan > TimeRange,
TSharedPtr< IMediaTextureSample, ESPMode::ThreadSafe >& OutSample
)

 Fetch the next video sample.
Public function Virtual void Discard any outstanding media samples.
Public function Virtual Const int32 Get the number of queued metadata samples.
Public function Virtual Const int32 Get the number of queued subtitle samples.
Public function Virtual Const int32 Get the number of queued video samples.
Public function Virtual bool  

Operators

  Type Name Description
Public function FMediaIOCoreSamples &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page