1. Epic GamesDeveloper
  3. UMediaProfilePlaybackManager

UMediaProfilePlaybackManager

Manages playback of media items within a media profile

API > API/Plugins > API/Plugins/MediaFrameworkUtilities

Manages playback of media items within a media profile

   
Name UMediaProfilePlaybackManager
Type class
Header File /Engine/Plugins/Media/MediaFrameworkUtilities/Source/MediaFrameworkUtilities/Public/Profile/MediaProfilePlaybackManager.h
Include Path #include "Profile/MediaProfilePlaybackManager.h"

Syntax

UCLASS ()  
class UMediaProfilePlaybackManager : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMediaProfilePlaybackManager ( const FObjectInitializer& ObjectInitializer
)

   Profile/MediaProfilePlaybackManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UMediaProfilePlaybackManager()

   Profile/MediaProfilePlaybackManager.h  

Structs

Name Remarks
FCloseSourceArgs Arguments that control what happens when a media source is closed

Typedefs

Name Type Remarks Include Path
FRecaptureFunc TFunction< void(UMediaProfilePlaybackManager *)> Alias for callback used to restart capture of media outputs Profile/MediaProfilePlaybackManager.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveOutputViewports TArray< TSharedPtr< MediaProfilePlaybackManager::FActiveViewport > > A list of active viewports that are being captured from Profile/MediaProfilePlaybackManager.h  
CapturesWithError TSet< TObjectPtr< UMediaCapture > > Keeps track of which captures have reported an error with the capture Profile/MediaProfilePlaybackManager.h  
ManagedOutputViewports TArray< TSharedPtr< MediaProfilePlaybackManager::FManagedViewport > > A list of viewports being managed by the playback manager, Profile/MediaProfilePlaybackManager.h  
MediaOutputCaptures TMap< int32, TObjectPtr< UMediaCapture > > A map of media captures, where the hash key is the index of the media output being captured Profile/MediaProfilePlaybackManager.h
  • Transient
MediaSourcePlayers TMap< int32, TObjectPtr< UMediaPlayer > > A map of media players, where the hash key is the index of the media source the player is playing Profile/MediaProfilePlaybackManager.h
  • Transient
MediaSourceTextures TArray< TSoftObjectPtr< UMediaTexture > > A list of media textures to use to output the corresponding media sources Profile/MediaProfilePlaybackManager.h
  • Transient
RestartCaptureFuncs TArray< FRecaptureFunc > A list of callbacks to use to auto-restart any stopped captures on the next tick Profile/MediaProfilePlaybackManager.h  
RestartCapturesTimerHandle FTimerHandle Timer handle for auto-restarting output captures Profile/MediaProfilePlaybackManager.h  
SourceConsumers TMap< TObjectPtr< UMediaPlayer >, TSet< void * > > Keeps track of registered consumers that are actively using an open media source Profile/MediaProfilePlaybackManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CloseOutput ( UMediaOutput* InMediaOutput,
bool bDestroyCaptureObjects
)

 Closes the capture of the specified media output Profile/MediaProfilePlaybackManager.h  

void CloseOutputFromIndex ( int32 InMediaOutputIndex,
bool bDestroyCaptureObjects
)

 Closes the capture of the specified media output Profile/MediaProfilePlaybackManager.h  

void CloseSource ( UMediaSource* InMediaSource,
const FCloseSourceArgs& InArgs
)

 Closes the specified media source, and optionally destroys the media player that was playing the source Profile/MediaProfilePlaybackManager.h  

void CloseSourceFromIndex ( int32 InMediaSourceIndex,
const FCloseSourceArgs& InArgs
)

 Closes the specified media source, and optionally destroys the media player that was playing the source Profile/MediaProfilePlaybackManager.h  

void CloseSourcesForConsumer ( const FCloseSourceArgs& InArgs
)

 Closes all media sources that are being played by a specified consumer Profile/MediaProfilePlaybackManager.h  

TSharedPtr< FSceneViewport > GetActiveViewport ( UMediaOutput* InMediaOutput
) const

 Gets an existing viewport in the engine that is or can be captured for the specified media output Profile/MediaProfilePlaybackManager.h  

TSharedPtr< FSceneViewport > GetActiveViewportFromIndex ( int32 InMediaOutputIndex
) const

 Gets an existing viewport in the engine that is or can be captured for the specified media output Profile/MediaProfilePlaybackManager.h  

TSharedPtr< FViewportClient > GetOrCreateManagedViewport ( UMediaOutput* InMediaOutput,
EViewModeIndex InViewMode,
void* Consumer
)

 Finds an existing or creates a new viewport to use for capture for a specified media output Profile/MediaProfilePlaybackManager.h  

TSharedPtr< FViewportClient > GetOrCreateManagedViewportFromIndex ( int32 InMediaOutputIndex,
EViewModeIndex InViewMode,
void* Consumer
)

 Finds an existing or creates a new viewport to use for capture for a specified media output Profile/MediaProfilePlaybackManager.h  

TOptional< EMediaCaptureState > GetOutputCaptureState ( UMediaOutput* InMediaOutput,
bool& bOutHasError
) const

 Gets the capture state of the specified media output, or null of there is no active capture of the media output Profile/MediaProfilePlaybackManager.h  

TOptional< EMediaCaptureState > GetOutputCaptureStateFromIndex ( int32 InMediaOutputIndex,
bool& bOutHasError
) const

 Gets the capture state of the specified media output, or null of there is no active capture of the media output Profile/MediaProfilePlaybackManager.h  

UMediaTexture * GetSourceMediaTexture ( UMediaSource* InMediaSource
) const

 Gets the media texture that is outputting the specified media source Profile/MediaProfilePlaybackManager.h  

UMediaTexture * GetSourceMediaTextureFromIndex ( int32 InMediaSourceIndex
) const

 Gets the media texture that is outputting the specified media source Profile/MediaProfilePlaybackManager.h  

bool IsOutputCapturing ( UMediaOutput* InMediaOutput
) const

 Gets whether there is an active capture for the specified media output Profile/MediaProfilePlaybackManager.h  

bool IsOutputCapturingFromIndex ( int32 InMediaOutputIndex
) const

 Gets whether there is an active capture for the specified media output index Profile/MediaProfilePlaybackManager.h  

bool IsSourceOpen ( UMediaSource* InMediaSource,
void* InConsumer
) const

 Gets whether a media source is currently open Profile/MediaProfilePlaybackManager.h  

bool IsSourceOpenFromIndex ( int32 InMediaSourceIndex,
void* InConsumer
) const

 Gets whether a media source is currently open Profile/MediaProfilePlaybackManager.h  

bool IsValidSourceMediaTexture ( UMediaTexture* InMediaTexture,
int32& OutMediaSourceIndex
) const

 Checks the specified media texture to see if it is being used by the media profile to play one of its media sources Profile/MediaProfilePlaybackManager.h  

UMediaCapture * OpenActiveViewportOutput ( UMediaOutput* InMediaOutput,
const FMediaCaptureOptions& InCaptureOptions,
bool bAutoRestartCapture
)

 Starts a capture of an existing engine viewport for a specified media output Profile/MediaProfilePlaybackManager.h  

UMediaCapture * OpenActiveViewportOutputFromIndex ( int32 InMediaOutputIndex,
const FMediaCaptureOptions& InCaptureOptions,
bool bAutoRestartCapture
)

 Starts a capture of an existing engine viewport for a specified media output Profile/MediaProfilePlaybackManager.h  

UMediaCapture * OpenManagedViewportOutput ( UMediaOutput* InMediaOutput,
const FMediaCaptureOptions& InCaptureOptions,
bool bAutoRestartCapture
)

 Starts a capture of a managed viewport for a specified media output Profile/MediaProfilePlaybackManager.h  

UMediaCapture * OpenManagedViewportOutputFromIndex ( int32 InMediaOutputIndex,
const FMediaCaptureOptions& InCaptureOptions,
bool bAutoRestartCapture
)

 Starts a capture of a managed viewport for a specified media output Profile/MediaProfilePlaybackManager.h  

UMediaCapture * OpenRenderTargetOutput ( UMediaOutput* InMediaOutput,
UTextureRenderTarget2D* InRenderTarget,
const FMediaCaptureOptions& InCaptureOptions,
bool bAutoRestartCapture
)

 Starts a capture of a render target for a specified media output Profile/MediaProfilePlaybackManager.h  

UMediaCapture * OpenRenderTargetOutputFromIndex ( int32 InMediaOutputIndex,
UTextureRenderTarget2D* InRenderTarget,
const FMediaCaptureOptions& InCaptureOptions,
bool bAutoRestartCapture
)

 Starts a capture of a render target for a specified media output Profile/MediaProfilePlaybackManager.h  

UMediaTexture * OpenSource ( UMediaSource* InMediaSource,
void* InConsumer
)

 Opens and begins playing the specified media source Profile/MediaProfilePlaybackManager.h  

UMediaTexture * OpenSourceFromIndex ( int32 InMediaSourceIndex,
void* InConsumer
)

 Opens and begins playing the specified media source Profile/MediaProfilePlaybackManager.h  

void ReleaseManagedViewport ( UMediaOutput* InMediaOutput,
void* Consumer
)

 Releases a use of the managed viewport for the specified media output,which may destroy the managed viewport if it is not actively being used Profile/MediaProfilePlaybackManager.h  

void ReleaseManagedViewportFromIndex ( int32 InMediaOutputIndex,
void* Consumer
)

 Releases a use of the managed viewport for the specified media output,which may destroy the managed viewport if it is not actively being used Profile/MediaProfilePlaybackManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page