Navigation
Unreal Engine C++ API Reference > Runtime > MediaUtils
Inheritance Hierarchy
- IMediaSamples
- FMediaSamples
References
Module | MediaUtils |
Header | /Engine/Source/Runtime/MediaUtils/Public/MediaSamples.h |
Include | #include "MediaSamples.h" |
Syntax
class FMediaSamples : public IMediaSamples
Remarks
General purpose media sample queue.
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
FMediaSamples
(
uint32 InMaxNumberOfQueuedAudioSamples, |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | AddAudio
(
const TSharedRef< IMediaAudioSample, ESPMode::ThreadSafe >& Sample |
Add the given audio sample to the cache. |
![]() |
void | AddCaption
(
const TSharedRef< IMediaOverlaySample, ESPMode::ThreadSafe >& Sample |
Add the given caption sample to the cache. |
![]() |
void | AddMetadata
(
const TSharedRef< IMediaBinarySample, ESPMode::ThreadSafe >& Sample |
Add the given audio sample to the cache. |
![]() |
void | AddSubtitle
(
const TSharedRef< IMediaOverlaySample, ESPMode::ThreadSafe >& Sample |
Add the given subtitle sample to the cache. |
![]() |
void | AddVideo
(
const TSharedRef< IMediaTextureSample, ESPMode::ThreadSafe >& Sample |
Add the given audio sample to the cache. |
Overridden from IMediaSamples
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() |
bool | CanReceiveAudioSamples
(
uint32 Num |
Check if can receive more audio samples |
![]() ![]() ![]() |
bool | CanReceiveCaptionSamples
(
uint32 Num |
Check if can receive more caption samples |
![]() ![]() ![]() |
bool | CanReceiveMetadataSamples
(
uint32 Num |
Check if can receive more metadata samples |
![]() ![]() ![]() |
bool | CanReceiveSubtitleSamples
(
uint32 Num |
Check if can receive more subtitle samples |
![]() ![]() ![]() |
bool | CanReceiveVideoSamples
(
uint32 Num |
Check if can receive more video samples |
![]() ![]() |
bool | DiscardAudioSamples
(
const TRange< FMediaTimeStamp >& TimeRange, |
|
![]() ![]() |
bool | DiscardCaptionSamples
(
const TRange< FMediaTimeStamp >& TimeRange, |
|
![]() ![]() |
bool | DiscardMetadataSamples
(
const TRange< FMediaTimeStamp >& TimeRange, |
|
![]() ![]() |
bool | DiscardSubtitleSamples
(
const TRange< FMediaTimeStamp >& TimeRange, |
|
![]() ![]() |
bool | DiscardVideoSamples
(
const TRange< FMediaTimeStamp >& TimeRange, |
|
![]() ![]() |
bool | FetchAudio
(
TRange< FMediaTimeStamp > TimeRange, |
|
![]() ![]() |
bool | FetchAudio
(
TRange< FTimespan > TimeRange, |
Fetch the next audio sample. |
![]() ![]() |
EFetchBestSampleResult | FetchBestVideoSampleForTimeRange
(
const TRange< FMediaTimeStamp >& TimeRange, |
Fetch video sample best suited for the given time range. |
![]() ![]() |
bool | FetchCaption
(
TRange< FMediaTimeStamp > TimeRange, |
|
![]() ![]() |
bool | FetchCaption
(
TRange< FTimespan > TimeRange, |
Fetch the next caption sample. |
![]() ![]() |
bool | FetchMetadata
(
TRange< FMediaTimeStamp > TimeRange, |
|
![]() ![]() |
bool | FetchMetadata
(
TRange< FTimespan > TimeRange, |
Fetch the next metadata sample. |
![]() ![]() |
bool | FetchSubtitle
(
TRange< FMediaTimeStamp > TimeRange, |
|
![]() ![]() |
bool | FetchSubtitle
(
TRange< FTimespan > TimeRange, |
Fetch the next subtitle sample. |
![]() ![]() |
bool | FetchVideo
(
TRange< FMediaTimeStamp > TimeRange, |
|
![]() ![]() |
bool | FetchVideo
(
TRange< FTimespan > TimeRange, |
Fetch the next video sample. |
![]() ![]() |
void | FlushSamples () |
Discard any outstanding media samples. |
![]() ![]() ![]() |
int32 | NumAudio () |
Get the number of queued audio samples. |
![]() ![]() ![]() |
int32 | NumCaption () |
Get the number of queued caption samples. |
![]() ![]() ![]() |
int32 | Get the number of queued metadata samples. | |
![]() ![]() ![]() |
int32 | Get the number of queued subtitle samples. | |
![]() ![]() ![]() |
int32 | Get the number of queued video samples. | |
![]() ![]() |
bool | PeekVideoSampleTime
(
FMediaTimeStamp& TimeStamp |
Peek next video sample's timestamp |
![]() ![]() |
uint32 | PurgeOutdatedCaptionSamples
(
const FMediaTimeStamp& ReferenceTime, |
Remove any caption samples from the queue that have no chance of being displayed anymore |
![]() ![]() |
uint32 | PurgeOutdatedMetadataSamples
(
const FMediaTimeStamp& ReferenceTime, |
Remove any caption samples from the queue that have no chance of being displayed anymore |
![]() ![]() |
uint32 | PurgeOutdatedSubtitleSamples
(
const FMediaTimeStamp& ReferenceTime, |
Remove any subtitle samples from the queue that have no chance of being displayed anymore |
![]() ![]() |
uint32 | PurgeOutdatedVideoSamples
(
const FMediaTimeStamp& ReferenceTime, |
Remove any video samples from the queue that have no chance of being displayed anymore |