UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IMediaCache Class Reference

#include <IMediaCache.h>

Public Member Functions

virtual bool QueryCacheState (EMediaCacheState State, TRangeSet< FTimespan > &OutTimeRanges) const
 
virtual int32 GetSampleCount (EMediaCacheState State) const
 
virtual ~IMediaCache ()
 

Detailed Description

Interface for access to a media player's cache.

See also
IMediaControls, IMediaPlayer, IMediaSamples, IMediaTracks, IMediaView

Constructor & Destructor Documentation

◆ ~IMediaCache()

virtual IMediaCache::~IMediaCache ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ GetSampleCount()

virtual int32 IMediaCache::GetSampleCount ( EMediaCacheState  State) const
inlinevirtual

Query the number of samples for the specified caching state.

Parameters
StateThe sample state we're interested in.
Returns
Sample count.

◆ QueryCacheState()

virtual bool IMediaCache::QueryCacheState ( EMediaCacheState  State,
TRangeSet< FTimespan > &  OutTimeRanges 
) const
inlinevirtual

Query the time ranges of cached media samples for the specified caching state.

This method can be used to probe a media player's decoder for which samples are scheduled for loading, being loaded, or finished loading. This is generally only supported by those players that expose some kind of internal sample caching or load/decode scheduling mechanism, and most players may simply ignore this call.

Parameters
StateThe sample state we're interested in.
OutTimeRangesWill contain the set of matching sample time ranges.
Returns
true on success, false if not supported.

The documentation for this class was generated from the following file: