Navigation
API > API/Runtime > API/Runtime/MediaUtils
Interface for media sample sinks.
This interface declares the write side of media sample queues.
| Name | TMediaSampleSink |
| Type | class |
| Header File | /Engine/Source/Runtime/MediaUtils/Public/MediaSampleSink.h |
| Include Path | #include "MediaSampleSink.h" |
Syntax
template<typename SampleType>
class TMediaSampleSink
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~TMediaSampleSink() |
Virtual destructor. | MediaSampleSink.h |
Classes
| Name | Remarks |
|---|---|
| FOnMediaSampleSinkEvent | Register to receive events flowing to this sink |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MediaSampleSinkEvent | FOnMediaSampleSinkEvent | MediaSampleSink.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanAcceptSamples
(
int32 NumSamples |
Check if sink can accept new samplesOverride in implementation as needed | MediaSampleSink.h | |
bool Enqueue
(
const TSharedRef< SampleType, ESPMode::ThreadSafe >& Sample |
Add a sample to the head of the queue. | MediaSampleSink.h | |
uint32 GetFlushCount() |
Returns the number of times the queue has been requested to flush already. | MediaSampleSink.h | |
int32 Num () |
Get the number of samples in the queue. | MediaSampleSink.h | |
TMediaSampleSink::FOnMediaSampleSinkEvent TBaseMulticastDelegate_TwoParams OnMediaSampleSinkEvent() |
MediaSampleSink.h | ||
void ReceiveEvent
(
EMediaSampleSinkEvent Event, |
Receive event | MediaSampleSink.h | |
void RequestFlush () |
Request to flush the queue.To be called only from producer thread. | MediaSampleSink.h |