Navigation
API > API/Runtime > API/Runtime/MediaUtils
Inheritance Hierarchy
- TMediaSampleSinks
- FMediaAudioSampleSinks
References
| Module | MediaUtils |
| Header | /Engine/Source/Runtime/MediaUtils/Public/MediaSampleSinks.h |
| Include | #include "MediaSampleSinks.h" |
Syntax
template<typename SampleType, typename SinkType>
class TMediaSampleSinks
Remarks
Collection of media sample sinks.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TArray< TWeakPtr< SinkType, ESPMode::ThreadSafe > > | Sinks | The collection of registered sinks. |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Add
(
const TSharedRef< SinkType, ESPMode::ThreadSafe >& SampleSink, |
Add the given media sample sink to the collection. |
 |
void | Cleanup () |
Remove any invalid sinks |
 |
bool | Enqueue
(
const TSharedRef< SampleType, ESPMode::ThreadSafe >& Sample |
Enqueue the given media samples to the registered sinks. |
 |
void | Flush
(
UMediaPlayer* MediaPlayer |
Flush all registered sinks. |
  |
bool | IsEmpty () |
Check if any sinks are inserted |
  |
int32 | Num () |
Get the number of sinks in this collection. |
 |
void | ReceiveEvent
(
EMediaSampleSinkEvent Event, |
Receive event and broadcast to sinks |
 |
void | Remove
(
const TSharedRef< SinkType, ESPMode::ThreadSafe >& SampleSink, |
Remove the given media sample sink from the collection. |