Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MediaIOCore > FMediaIOCoreSamples

Light Theme

Dark Theme

FMediaIOCoreSamples

General purpose media sample queue.

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

		Name	Description
	FMediaIOCoreSam...	AudioSamples
	FMediaIOCoreSam...	CaptionSamples
	FMediaIOCoreSam...	MetadataSamples
	FMediaIOCoreSam...	SubtitleSamples
	FMediaIOCoreSam...	VideoSamples

Constructors

	Name	Description
	FMediaIOCoreSamples()
	FMediaIOCoreSamples ( const FMediaIOCoreSamples& )

Functions

	Name	Description
bool	AddAudio ( const TSharedRef< IMediaAudioSample... )	Add the given audio sample to the cache.
bool	AddCaption ( const TSharedRef< IMediaOverlaySamp... )	Add the given caption sample to the cache.
bool	AddMetadata ( const TSharedRef< IMediaBinarySampl... )	Add the given metadata sample to the cache.
bool	AddSubtitle ( const TSharedRef< IMediaOverlaySamp... )	Add the given subtitle sample to the cache.
bool	AddVideo ( const TSharedRef< IMediaTextureSamp... )	Add the given video sample to the cache.
void	CacheSamplesState ( FTimespan PlayerTime )	Caches the current sample container state for a given Player (evaluation) time
void	EnableTimedDataChannels ( ITimedDataInput* Input, EMediaIOSampleType SampleTypes )	Enable or disable channels based on bitfield flag
int32	GetAudioFrameDropCount()	Get Audio Samples frame dropped count.
int32	GetCaptionsFrameDropCount()	Get Caption Samples frame dropped count.
int32	GetMetadataFrameDropCount()	Get Metadata Samples frame dropped count.
FTimespan	GetNextVideoSampleTime()	Get next sample time from the VideoSampleQueue.
int32	GetSubtitlesFrameDropCount()	Get Subtitles Samples frame dropped count.
int32	GetVideoFrameDropCount()	Get Video Samples frame dropped count.
void	InitializeAudioBuffer ( const FMediaIOSamplingSettings& In... )
void	InitializeCaptionBuffer ( const FMediaIOSamplingSettings& In... )
void	InitializeMetadataBuffer ( const FMediaIOSamplingSettings& In... )
void	InitializeSubtitlesBuffer ( const FMediaIOSamplingSettings& In... )
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
int32	NumAudioSamples()	Get the number of queued audio samples.
int32	NumCaptionSamples()	Get the number of queued caption samples.
int32	NumMetadataSamples()	Get the number of queued metadata samples.
int32	NumSubtitleSamples()	Get the number of queued subtitle samples.
int32	NumVideoSamples()	Get the number of queued video samples.
bool	PopAudio()	Pop a Audio sample from the cache.
bool	PopCaption()	Pop a Caption sample from the cache.
bool	PopMetadata()	Pop a Metadata sample from the cache.
bool	PopSubtitle()	Pop a Subtitle sample from the cache.
bool	PopVideo()	Pop a video sample from the cache.

Overridden from IMediaSamples

	Name	Description
bool	FetchAudio ( TRange< FTimespan > TimeRange, TSharedPtr< IMediaAudioSample, ESPM... )	Fetch the next audio sample.
bool	FetchCaption ( TRange< FTimespan > TimeRange, TSharedPtr< IMediaOverlaySample, ES... )	Fetch the next caption sample.
bool	FetchMetadata ( TRange< FTimespan > TimeRange, TSharedPtr< IMediaBinarySample, ESP... )	Fetch the next metadata sample.
bool	FetchSubtitle ( TRange< FTimespan > TimeRange, TSharedPtr< IMediaOverlaySample, ES... )	Fetch the next subtitle sample.
bool	FetchVideo ( TRange< FTimespan > TimeRange, TSharedPtr< IMediaTextureSample, ES... )	Fetch the next video sample.
void	FlushSamples()	Discard any outstanding media samples.

Operators

		Name	Description
	FMediaIOCore...	operator= ( const FMediaIOCoreSamples& )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss