Navigation
API > API/Runtime > API/Runtime/MediaUtils
General purpose media sample queue.
| Name | FMediaSamples |
| Type | class |
| Header File | /Engine/Source/Runtime/MediaUtils/Public/MediaSamples.h |
| Include Path | #include "MediaSamples.h" |
Syntax
class FMediaSamples : public IMediaSamples
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMediaSamples
(
uint32 InMaxNumberOfQueuedAudioSamples, |
MediaSamples.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FMediaSamples() |
MediaSamples.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MaxNumberOfQueuedAudioSamples | uint32 | MediaSamples.h | |
| MaxNumberOfQueuedCaptionSamples | uint32 | MediaSamples.h | |
| MaxNumberOfQueuedMetaDataSamples | uint32 | MediaSamples.h | |
| MaxNumberOfQueuedSubtitlesSamples | uint32 | MediaSamples.h | |
| MaxNumberOfQueuedVideoSamples | uint32 | MediaSamples.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioSampleQueue | FMediaAudioSampleQueue | Audio sample queue. | MediaSamples.h | |
| CaptionSampleQueue | FMediaOverlaySampleQueue | Caption sample queue. | MediaSamples.h | |
| MetadataSampleQueue | FMediaBinarySampleQueue | Metadata sample queue. | MediaSamples.h | |
| NextMinSequenceIndex | TOptional< int32 > | The next smallest expected sequence index if set. | MediaSamples.h | |
| SubtitleSampleQueue | FMediaOverlaySampleQueue | Subtitle sample queue. | MediaSamples.h | |
| VideoSampleQueue | FMediaTextureSampleQueue | Video sample queue. | MediaSamples.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddAudio
(
const TSharedRef< IMediaAudioSample, ESPMode::ThreadSafe >& Sample |
Add the given audio sample to the cache. | MediaSamples.h | |
void AddCaption
(
const TSharedRef< IMediaOverlaySample, ESPMode::ThreadSafe >& Sample |
Add the given caption sample to the cache. | MediaSamples.h | |
void AddMetadata
(
const TSharedRef< IMediaBinarySample, ESPMode::ThreadSafe >& Sample |
Add the given audio sample to the cache. | MediaSamples.h | |
void AddSubtitle
(
const TSharedRef< IMediaOverlaySample, ESPMode::ThreadSafe >& Sample |
Add the given subtitle sample to the cache. | MediaSamples.h | |
void AddVideo
(
const TSharedRef< IMediaTextureSample, ESPMode::ThreadSafe >& Sample |
Add the given audio sample to the cache. | MediaSamples.h |
Overridden from IMediaSamples
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanReceiveAudioSamples
(
uint32 Num |
Check if can receive more audio samples | MediaSamples.h | |
virtual bool CanReceiveCaptionSamples
(
uint32 Num |
Check if can receive more caption samples | MediaSamples.h | |
virtual bool CanReceiveMetadataSamples
(
uint32 Num |
Check if can receive more metadata samples | MediaSamples.h | |
virtual bool CanReceiveSubtitleSamples
(
uint32 Num |
Check if can receive more subtitle samples | MediaSamples.h | |
virtual bool CanReceiveVideoSamples
(
uint32 Num |
Check if can receive more video samples | MediaSamples.h | |
virtual bool DiscardAudioSamples
(
const TRange< FMediaTimeStamp >& TimeRange, |
MediaSamples.h | ||
virtual bool DiscardCaptionSamples
(
const TRange< FMediaTimeStamp >& TimeRange, |
MediaSamples.h | ||
virtual bool DiscardMetadataSamples
(
const TRange< FMediaTimeStamp >& TimeRange, |
MediaSamples.h | ||
virtual bool DiscardSubtitleSamples
(
const TRange< FMediaTimeStamp >& TimeRange, |
MediaSamples.h | ||
virtual bool DiscardVideoSamples
(
const TRange< FMediaTimeStamp >& TimeRange, |
MediaSamples.h | ||
virtual bool FetchAudio
(
TRange< FMediaTimeStamp > TimeRange, |
MediaSamples.h | ||
virtual bool FetchAudio
(
TRange< FTimespan > TimeRange, |
MediaSamples.h | ||
virtual EFetchBestSampleResult FetchBestVideoSampleForTimeRange
(
const TRange< FMediaTimeStamp >& TimeRange, |
Fetch video sample best suited for the given time range. | MediaSamples.h | |
virtual bool FetchCaption
(
TRange< FMediaTimeStamp > TimeRange, |
MediaSamples.h | ||
virtual bool FetchCaption
(
TRange< FTimespan > TimeRange, |
MediaSamples.h | ||
virtual bool FetchMetadata
(
TRange< FMediaTimeStamp > TimeRange, |
MediaSamples.h | ||
virtual bool FetchMetadata
(
TRange< FTimespan > TimeRange, |
MediaSamples.h | ||
virtual bool FetchSubtitle
(
TRange< FMediaTimeStamp > TimeRange, |
MediaSamples.h | ||
virtual bool FetchSubtitle
(
TRange< FTimespan > TimeRange, |
MediaSamples.h | ||
virtual bool FetchVideo
(
TRange< FMediaTimeStamp > TimeRange, |
MediaSamples.h | ||
virtual bool FetchVideo
(
TRange< FTimespan > TimeRange, |
MediaSamples.h | ||
virtual void FlushSamples() |
MediaSamples.h | ||
virtual uint32 GetNumDroppedAudioSamples
(
bool bInClearToZero |
MediaSamples.h | ||
virtual uint32 GetNumDroppedCaptionSamples
(
bool bInClearToZero |
MediaSamples.h | ||
virtual uint32 GetNumDroppedMetadataSamples
(
bool bInClearToZero |
MediaSamples.h | ||
virtual uint32 GetNumDroppedSubtitleSamples
(
bool bInClearToZero |
MediaSamples.h | ||
virtual uint32 GetNumDroppedVideoSamples
(
bool bInClearToZero |
MediaSamples.h | ||
virtual int32 NumAudioSamples () |
Get the number of queued audio samples. | MediaSamples.h | |
virtual int32 NumCaptionSamples () |
Get the number of queued caption samples. | MediaSamples.h | |
virtual int32 NumMetadataSamples () |
Get the number of queued metadata samples. | MediaSamples.h | |
virtual int32 NumSubtitleSamples () |
Get the number of queued subtitle samples. | MediaSamples.h | |
virtual int32 NumVideoSamples () |
Get the number of queued video samples. | MediaSamples.h | |
virtual bool PeekAudioSampleTimeRanges
(
TArray< TRange< FMediaTimeStamp > >& TimeRange |
MediaSamples.h | ||
virtual bool PeekVideoSampleTime
(
FMediaTimeStamp& TimeStamp |
Peek next video sample's timestamp | MediaSamples.h | |
virtual bool PeekVideoSampleTimeRanges
(
TArray< TRange< FMediaTimeStamp > >& TimeRange |
MediaSamples.h | ||
virtual uint32 PurgeOutdatedCaptionSamples
(
const FMediaTimeStamp& ReferenceTime, |
Remove any caption samples from the queue that have no chance of being displayed anymore | MediaSamples.h | |
virtual uint32 PurgeOutdatedMetadataSamples
(
const FMediaTimeStamp& ReferenceTime, |
Remove any caption samples from the queue that have no chance of being displayed anymore | MediaSamples.h | |
virtual uint32 PurgeOutdatedSubtitleSamples
(
const FMediaTimeStamp& ReferenceTime, |
Remove any subtitle samples from the queue that have no chance of being displayed anymore | MediaSamples.h | |
virtual uint32 PurgeOutdatedVideoSamples
(
const FMediaTimeStamp& ReferenceTime, |
Remove any video samples from the queue that have no chance of being displayed anymore | MediaSamples.h | |
virtual void SetMinExpectedNextSequenceIndex
(
TOptional< int32 > InNextSequenceIndex |
MediaSamples.h |