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

#include <MediaSampleQueue.h>

+ Inheritance diagram for FMediaAudioSampleQueue:

Public Member Functions

 FMediaAudioSampleQueue (uint32 MaxSamplesInQueue=-1)
 
void SetAudioTime (const FMediaTimeStampSample &InAudioTime)
 
void SetAudioTimeIfEqualFlushCount (const FMediaTimeStampSample &InAudioTime, uint32 InFlushCount)
 
FMediaTimeStampSample GetAudioTime () const override
 
void InvalidateAudioTime () override
 
virtual void RequestFlush () override
 
- Public Member Functions inherited from TMediaSampleQueue< class IMediaAudioSample, class FMediaAudioSampleSink >
 TMediaSampleQueue (int32 InMaxSamplesInQueue=-1)
 
virtual ~TMediaSampleQueue ()
 
int32 Num () const
 
uint32 GetNumDroppedSamples (bool bInClearToZero)
 
virtual bool Dequeue (TSharedPtr< class IMediaAudioSample, ESPMode::ThreadSafe > &OutSample) override
 
virtual bool Peek (TSharedPtr< class IMediaAudioSample, ESPMode::ThreadSafe > &OutSample) override
 
virtual void GetSampleTimes (TArray< TRange< FMediaTimeStamp > > &OutSampleTimeRanges) override
 
virtual bool Pop () override
 
bool Discard (const TRange< FMediaTimeStamp > &TimeRange, bool bReverse)
 
EMediaSampleQueueFetchResult FetchBestSampleForTimeRange (const TRange< FMediaTimeStamp > &TimeRange, TSharedPtr< class IMediaAudioSample, ESPMode::ThreadSafe > &OutSample, bool bReverse, bool bConsistentResult)
 
uint32 PurgeOutdatedSamples (const FMediaTimeStamp &ReferenceTime, bool bReversed, FTimespan MaxAge)
 
void PurgeUntilSequenceIndex (int32 InUntilIndex)
 
virtual bool Enqueue (const TSharedRef< class IMediaAudioSample, ESPMode::ThreadSafe > &Sample) override
 
virtual uint32 GetFlushCount () const
 
virtual bool CanAcceptSamples (int32 NumSamples) const override
 
- Public Member Functions inherited from TMediaSampleSource< SampleType >
virtual bool Dequeue (TSharedPtr< SampleType, ESPMode::ThreadSafe > &OutSample)=0
 
virtual bool Peek (TSharedPtr< SampleType, ESPMode::ThreadSafe > &OutSample)=0
 
virtual ~TMediaSampleSource ()
 

Additional Inherited Members

- Protected Member Functions inherited from TMediaSampleQueue< class IMediaAudioSample, class FMediaAudioSampleSink >
void FindRangeInQueue (const TRange< FMediaTimeStamp > &TimeRange, bool bReverse, int32 &FirstPossibleIndex, int32 &LastPossibleIndex, int32 &NumOldSamplesAtBegin)
 
- Protected Attributes inherited from TMediaSampleQueue< class IMediaAudioSample, class FMediaAudioSampleSink >
FCriticalSection CriticalSection
 
TArray< TSharedPtr< class IMediaAudioSample, ESPMode::ThreadSafe > > Samples
 
int32 MaxSamplesInQueue
 
uint32 FlushCount
 
uint32 NumDroppedSamples
 

Detailed Description

audio sample queue.

Constructor & Destructor Documentation

◆ FMediaAudioSampleQueue()

FMediaAudioSampleQueue::FMediaAudioSampleQueue ( uint32  MaxSamplesInQueue = -1)
inline

Member Function Documentation

◆ GetAudioTime()

FMediaTimeStampSample FMediaAudioSampleQueue::GetAudioTime ( ) const
inlineoverride

◆ InvalidateAudioTime()

void FMediaAudioSampleQueue::InvalidateAudioTime ( )
inlineoverride

◆ RequestFlush()

virtual void FMediaAudioSampleQueue::RequestFlush ( )
inlineoverridevirtual

Request to flush the queue.

Note
To be called only from producer thread.
See also
Enqueue, Num

Reimplemented from TMediaSampleQueue< class IMediaAudioSample, class FMediaAudioSampleSink >.

◆ SetAudioTime()

void FMediaAudioSampleQueue::SetAudioTime ( const FMediaTimeStampSample InAudioTime)
inline

◆ SetAudioTimeIfEqualFlushCount()

void FMediaAudioSampleQueue::SetAudioTimeIfEqualFlushCount ( const FMediaTimeStampSample InAudioTime,
uint32  InFlushCount 
)
inline

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