1. Epic GamesDeveloper
  3. IMediaSamples

IMediaSamples

Interface for access to a media player's sample queue.

Unreal Engine C++ API Reference > Runtime > Media

Inheritance Hierarchy

References

   
Module Media
Header /Engine/Source/Runtime/Media/Public/IMediaSamples.h
Include #include "IMediaSamples.h"

Syntax

class IMediaSamples

Remarks

Interface for access to a media player's sample queue.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function Virtual Const bool

CanReceiveAudioSamples ( uint32 Num
)

  
Public function Virtual Const bool

CanReceiveCaptionSamples ( uint32 Num
)

  
Public function Virtual Const bool

CanReceiveMetadataSamples ( uint32 Num
)

  
Public function Virtual Const bool

CanReceiveSubtitleSamples ( uint32 Num
)

  
Public function Virtual Const bool

CanReceiveVideoSamples ( uint32 Num
)

  
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
)

  
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  
Public function Virtual Const int32  
Public function Virtual Const int32  
Public function Virtual Const int32  
Public function Virtual Const int32  
Public function bool  
Public function Virtual uint32

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

  
Public function Virtual uint32

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

  
Public function Virtual uint32

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

  
Public function Virtual uint32

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

  

Enums

  Type Name Description
Public enum EFetchBestSampleResult    

See Also

IMediaCache

IMediaControls

IMediaPlayer

IMediaTracks

IMediaView

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page