IMediaSamples::FetchCaption

Fetch the next caption sample.

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

References

Module

Media

Header

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

Include

#include "IMediaSamples.h"

Syntax

virtual bool FetchCaption
(
    TRange< FTimespan > TimeRange,
    TSharedPtr< IMediaOverlaySample, ESPMode::ThreadSafe > & OutSample
)

Remarks

Fetch the next caption sample.

Returns

true if the returned sample is valid, false otherwise.

Parameters

Parameter

Description

TimeRange

The range of present times that the sample is allowed to have.

OutSample

Will contain the sample if the queue is not empty.

See Also