1. Epic GamesDeveloper
  3. FMediaSamples

FMediaSamples

General purpose media sample queue.

Unreal Engine C++ API Reference > Runtime > MediaUtils

Inheritance Hierarchy

References

   
Module MediaUtils
Header /Engine/Source/Runtime/MediaUtils/Public/MediaSamples.h
Include #include "MediaSamples.h"

Syntax

class FMediaSamples : public IMediaSamples

Remarks

General purpose media sample queue.

Constructors

  Type Name Description
Public function  

FMediaSamples ( uint32 InMaxNumberOfQueuedAudioSamples,
uint32 InMaxNumberOfQueuedVideoSamples,
uint32 InMaxNumberOfQueuedCaptionSamples,
uint32 InMaxNumberOfQueuedSubtitlesSamples,
uint32 InMaxNumberOfQueuedMetaDataSamples
)

  

Functions

  Type Name Description
Public function void

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

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

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

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

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

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

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

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

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

 Add the given audio sample to the cache.

Overridden from IMediaSamples

  Type Name Description
Public function Virtual Const bool

CanReceiveAudioSamples ( uint32 Num
)

 Check if can receive more audio samples
Public function Virtual Const bool

CanReceiveCaptionSamples ( uint32 Num
)

 Check if can receive more caption samples
Public function Virtual Const bool

CanReceiveMetadataSamples ( uint32 Num
)

 Check if can receive more metadata samples
Public function Virtual Const bool

CanReceiveSubtitleSamples ( uint32 Num
)

 Check if can receive more subtitle samples
Public function Virtual Const bool

CanReceiveVideoSamples ( uint32 Num
)

 Check if can receive more video samples
Public function Virtual bool

DiscardAudioSamples ( const TRange< FMediaTimeStamp >& TimeRange,
bool bReverse
)

  
Public function Virtual bool

DiscardCaptionSamples ( const TRange< FMediaTimeStamp >& TimeRange,
bool bReverse
)

  
Public function Virtual bool

DiscardMetadataSamples ( const TRange< FMediaTimeStamp >& TimeRange,
bool bReverse
)

  
Public function Virtual bool

DiscardSubtitleSamples ( const TRange< FMediaTimeStamp >& TimeRange,
bool bReverse
)

  
Public function Virtual bool

DiscardVideoSamples ( const TRange< FMediaTimeStamp >& TimeRange,
bool bReverse
)

  
Public function Virtual bool

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

  
Public function Virtual bool

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

 Fetch the next audio sample.
Public function Virtual EFetchBestSampleResult

FetchBestVideoSampleForTimeRange ( const TRange< FMediaTimeStamp >& TimeRange,
TSharedPtr< IMediaTextureSample, ESPMode::ThreadSafe >& OutSample,
bool bReverse
)

 Fetch video sample best suited for the given time range.
Public function Virtual bool

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

  
Public function Virtual bool

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

 Fetch the next caption sample.
Public function Virtual bool

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

  
Public function Virtual bool

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

 Fetch the next metadata sample.
Public function Virtual bool

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

  
Public function Virtual bool

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

 Fetch the next subtitle sample.
Public function Virtual bool

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

  
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 audio samples.
Public function Virtual Const int32 Get the number of queued caption 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 Peek next video sample's timestamp
Public function Virtual uint32

PurgeOutdatedCaptionSamples ( const FMediaTimeStamp& ReferenceTime,
bool bReversed,
FTimespan MaxAge
)

 Remove any caption samples from the queue that have no chance of being displayed anymore
Public function Virtual uint32

PurgeOutdatedMetadataSamples ( const FMediaTimeStamp& ReferenceTime,
bool bReversed,
FTimespan MaxAge
)

 Remove any caption samples from the queue that have no chance of being displayed anymore
Public function Virtual uint32

PurgeOutdatedSubtitleSamples ( const FMediaTimeStamp& ReferenceTime,
bool bReversed,
FTimespan MaxAge
)

 Remove any subtitle samples from the queue that have no chance of being displayed anymore
Public function Virtual uint32

PurgeOutdatedVideoSamples ( const FMediaTimeStamp& ReferenceTime,
bool bReversed,
FTimespan MaxAge
)

 Remove any video samples from the queue that have no chance of being displayed anymore

Constants

Name Description
MaxNumberOfQueuedAudioSamples  
MaxNumberOfQueuedCaptionSamples  
MaxNumberOfQueuedMetaDataSamples  
MaxNumberOfQueuedSubtitlesSamples  
MaxNumberOfQueuedVideoSamples  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page