IMediaSamples

Interface for access to a media player's sample queue.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Media

Header

/Engine/Source/Runtime/Media/Public/IMediaSamples.h

Include

#include "IMediaSamples.h"

Syntax

class IMediaSamples

Remarks

Interface for access to a media player's sample queue.

Destructors

Name Description

Public function Virtual

~IMediaSamples()

Virtual destructor.

Functions

Name Description

Public function Virtual Const

bool

 

CanReceiveAudioSamples

(
    uint32 Num
)

Public function Virtual Const

bool

 

CanReceiveVideoSamples

(
    uint32 Num
)

Public function Virtual

bool

 

FetchAudio

(
    TRange< FTimespan > TimeRange,
    TSharedPtr< IMediaAudioSample, ESPM...
)

Fetch the next audio sample.

Public function Virtual

EFetchBestSa...

 

FetchBestVideoSampleForTimeRange

(
    const TRange< FMediaTimeStamp >& T...,
    TSharedPtr< IMediaTextureSample, ES...,
    bool bReverse
)

Public function Virtual

bool

 

FetchCaption

(
    TRange< FMediaTimeStamp > TimeRange,
    TSharedPtr< IMediaOverlaySample, ES...
)

Public function Virtual

bool

 

FetchCaption

(
    TRange< FTimespan > TimeRange,
    TSharedPtr< IMediaOverlaySample, ES...
)

Fetch the next caption sample.

Public function Virtual

bool

 

FetchMetadata

(
    TRange< FTimespan > TimeRange,
    TSharedPtr< IMediaBinarySample, ESP...
)

Fetch the next metadata sample.

Public function Virtual

bool

 

FetchSubtitle

(
    TRange< FMediaTimeStamp > TimeRange,
    TSharedPtr< IMediaOverlaySample, ES...
)

Public function Virtual

bool

 

FetchSubtitle

(
    TRange< FTimespan > TimeRange,
    TSharedPtr< IMediaOverlaySample, ES...
)

Fetch the next subtitle sample.

Public function Virtual

bool

 

FetchVideo

(
    TRange< FMediaTimeStamp > TimeRange,
    TSharedPtr< IMediaTextureSample, ES...
)

Public function Virtual

bool

 

FetchVideo

(
    TRange< FTimespan > TimeRange,
    TSharedPtr< IMediaTextureSample, ES...
)

Fetch the next video sample.

Public function Virtual

void

 

FlushSamples()

Discard any outstanding media samples.

Public function Virtual Const

int32

 

NumAudio()

Public function Virtual Const

int32

 

NumCaption()

Public function Virtual Const

int32

 

NumMetadataSamples()

Public function Virtual Const

int32

 

NumSubtitleSamples()

Public function Virtual Const

int32

 

NumVideoSamples()

Public function

bool

 

PeekVideoSampleTime

(
    FMediaTimeStamp& TimeStamp
)

Public function Virtual

uint32

 

PurgeOutdatedSubtitleSamples

(
    const FMediaTimeStamp& ReferenceTi...,
    bool bReversed
)

Public function Virtual

uint32

 

PurgeOutdatedVideoSamples

(
    const FMediaTimeStamp& ReferenceTi...,
    bool bReversed
)

Enums

Name

Description

Public enum

EFetchBestSampleResult

See Also