FMediaIOCoreSamples

General purpose media sample queue.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IMediaSamples

FMediaIOCoreSamples

References

Module

MediaIOCore

Header

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

Include

#include "MediaIOCoreSamples.h"

Syntax

class FMediaIOCoreSamples : public IMediaSamples

Remarks

General purpose media sample queue.

Variables

Constructors

Functions

Name Description

Public function

bool

 

AddAudio

(
    const TSharedRef< IMediaAudioSample...
)

Add the given audio sample to the cache.

Public function

bool

 

AddCaption

(
    const TSharedRef< IMediaOverlaySamp...
)

Add the given caption sample to the cache.

Public function

bool

 

AddMetadata

(
    const TSharedRef< IMediaBinarySampl...
)

Add the given metadata sample to the cache.

Public function

bool

 

AddSubtitle

(
    const TSharedRef< IMediaOverlaySamp...
)

Add the given subtitle sample to the cache.

Public function

bool

 

AddVideo

(
    const TSharedRef< IMediaTextureSamp...
)

Add the given video sample to the cache.

Public function

void

 

CacheSamplesState

(
    FTimespan PlayerTime
)

Caches the current sample container state for a given Player (evaluation) time

Public function

void

 

EnableTimedDataChannels

(
    ITimedDataInput* Input,
    EMediaIOSampleType SampleTypes
)

Enable or disable channels based on bitfield flag

Public function Const

int32

 

GetAudioFrameDropCount()

Get Audio Samples frame dropped count.

Public function Const

int32

 

GetCaptionsFrameDropCount()

Get Caption Samples frame dropped count.

Public function Const

int32

 

GetMetadataFrameDropCount()

Get Metadata Samples frame dropped count.

Public function

FTimespan

 

GetNextVideoSampleTime()

Get next sample time from the VideoSampleQueue.

Public function Const

int32

 

GetSubtitlesFrameDropCount()

Get Subtitles Samples frame dropped count.

Public function Const

int32

 

GetVideoFrameDropCount()

Get Video Samples frame dropped count.

Public function

void

 

InitializeAudioBuffer

(
    const FMediaIOSamplingSettings& In...
)

Public function

void

 

InitializeCaptionBuffer

(
    const FMediaIOSamplingSettings& In...
)

Public function

void

 

InitializeMetadataBuffer

(
    const FMediaIOSamplingSettings& In...
)

Public function

void

 

InitializeSubtitlesBuffer

(
    const FMediaIOSamplingSettings& In...
)

Public function

void

 

InitializeVideoBuffer

(
    const FMediaIOSamplingSettings& In...
)

Initialize our different buffers with player's settings and wheter or not it should be displayed / supported in Timing monitor

Public function Const

int32

 

NumAudioSamples()

Get the number of queued audio samples.

Public function Const

int32

 

NumCaptionSamples()

Get the number of queued caption samples.

Public function

bool

 

PopAudio()

Pop a Audio sample from the cache.

Public function

bool

 

PopCaption()

Pop a Caption sample from the cache.

Public function

bool

 

PopMetadata()

Pop a Metadata sample from the cache.

Public function

bool

 

PopSubtitle()

Pop a Subtitle sample from the cache.

Public function

bool

 

PopVideo()

Pop a video sample from the cache.

Overridden from IMediaSamples

Name Description

Public function Virtual

bool

 

FetchAudio

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

Fetch the next audio sample.

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< FTimespan > TimeRange,
    TSharedPtr< IMediaOverlaySample, ES...
)

Fetch the next subtitle sample.

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

 

NumMetadataSamples()

Get the number of queued metadata samples.

Public function Virtual Const

int32

 

NumSubtitleSamples()

Get the number of queued subtitle samples.

Public function Virtual Const

int32

 

NumVideoSamples()

Get the number of queued video samples.

Public function Virtual

bool

 

PeekVideoSampleTime

(
    FMediaTimeStamp& TimeStamp
)

Operators

Name Description

Public function

FMediaIOCore...

 

operator=

(
    const FMediaIOCoreSamples&
)