FMediaIOCorePlayerBase::QueryCacheState

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

Windows
MacOS
Linux

Override Hierarchy

IMediaCache::QueryCacheState()

FMediaIOCorePlayerBase::QueryCacheState()

References

Module

MediaIOCore

Header

/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCorePlayerBase.h

Include

#include "MediaIOCorePlayerBase.h"

Source

/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Private/Player/MediaIOCorePlayerBase.cpp

Syntax

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

Remarks

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.

Returns

true on success, false if not supported.

Parameters

Parameter

Description

State

The sample state we're interested in.

OutTimeRanges

Will contain the set of matching sample time ranges.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss