1. Epic GamesDeveloper
  3. UMediaProfile

UMediaProfile

A media profile that configures the inputs, outputs, timecode provider and custom time step.

API > API/Plugins > API/Plugins/MediaFrameworkUtilities

A media profile that configures the inputs, outputs, timecode provider and custom time step.

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

Syntax

UCLASS (BlueprintType)  
class UMediaProfile : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMediaProfile ( const FObjectInitializer& ObjectInitializer
)

   Profile/MediaProfile.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bNeedToBeReapplied bool When the profile is the current profile and modifications made it dirty. Profile/MediaProfile.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AppliedCustomTimeStep TObjectPtr< UEngineCustomTimeStep >   Profile/MediaProfile.h
  • Transient
AppliedTimecodeProvider TObjectPtr< UTimecodeProvider >   Profile/MediaProfile.h
  • Transient
bCustomTimeStepWasApplied bool Applied Custom time step, cached to reset the previous value. Profile/MediaProfile.h  
bTimecodeProvideWasApplied bool Applied Timecode provider, cached to reset the previous value. Profile/MediaProfile.h  
PlaybackManager TObjectPtr< UMediaProfilePlaybackManager > Playback manager with maintains any necessary objects to support playback of the profile's media sources and outputs Profile/MediaProfile.h
  • Transient
  • Instanced
PreviousCustomTimeStep TObjectPtr< UEngineCustomTimeStep >   Profile/MediaProfile.h
  • Transient
PreviousTimecodeProvider TObjectPtr< UTimecodeProvider >   Profile/MediaProfile.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMediaOutput ( UMediaOutput* MediaOutput
)

 Adds the specified media output to the profile's list of media outputs Profile/MediaProfile.h  

void AddMediaSource ( UMediaSource* MediaSource
)

 Adds the specified media source to the profile's list of media sources Profile/MediaProfile.h  

virtual void Apply ()

 Apply the media profile. Profile/MediaProfile.h  

void ApplyCustomTimeStep()

 Resets and applies the media profile's custom time step to the engine if it is set to override the project settings timecode Profile/MediaProfile.h  

void ApplyTimecodeProvider()

 Resets and applies the media profile's timecode to the engine if it is set to override the project settings timecode Profile/MediaProfile.h  

int32 FindMediaOutputIndex ( UMediaOutput* MediaOutput
) const

 Gets the index of the specified media output if it was found in the media profile's list of outputs Profile/MediaProfile.h  

int32 FindMediaSourceIndex ( UMediaSource* MediaSource
) const

 Gets the index of the specified media source if it was found in the media profile's list of sources Profile/MediaProfile.h  

void FixNumSourcesAndOutputs()

 Update the number of sources and outputs to the number to proxies. Profile/MediaProfile.h  

UEngineCustomTimeStep * GetCustomTimeStep()

 Get the custom time step. Profile/MediaProfile.h  

FString GetLabelForMediaOutput ( int32 Index
)

 Gets the label for a media output Profile/MediaProfile.h  

FString GetLabelForMediaSource ( int32 Index
)

 Gets the label for a media source Profile/MediaProfile.h  

UMediaOutput * GetMediaOutput ( int32 Index
) const

 Get the media output for the selected proxy. Profile/MediaProfile.h  

UMediaSource * GetMediaSource ( int32 Index
) const

 Get the media source for the selected proxy. Profile/MediaProfile.h  

UMediaProfilePlaybackManager * GetPlaybackManager()

 Gets the playback manager to use for playback of this profile's media sources and outputs Profile/MediaProfile.h  

UTimecodeProvider * GetTimecodeProvider()

 Get the timecode provider. Profile/MediaProfile.h  

bool MoveMediaOutput ( int32 CurrentIndex,
int32 DestIndex
)

 Moves the media output at the specified index to the destination index, shifting other media outputs down to accommodate Profile/MediaProfile.h  

bool MoveMediaSource ( int32 CurrentIndex,
int32 DestIndex
)

 Moves the media source at the specified index to the destination index, shifting other media sources down to accommodate Profile/MediaProfile.h  

int32 NumMediaOutputs()

 Get the number of media output. Profile/MediaProfile.h  

int32 NumMediaSources()

 Get the number of media source. Profile/MediaProfile.h  

bool RemoveMediaOutput ( int32 Index
)

 Removes the specified media output from the profile's list of outputs Profile/MediaProfile.h  

bool RemoveMediaSource ( int32 Index
)

 Removes the specified media source from the profile's list of sources Profile/MediaProfile.h  

virtual void Reset ()

 Reset the media profile. Profile/MediaProfile.h  

void SetLabelForMediaOutput ( int32 Index,
const FString& NewLabel
)

 Sets the label for a media output Profile/MediaProfile.h  

void SetLabelForMediaSource ( int32 Index,
const FString& NewLabel
)

 Sets the label for a media source Profile/MediaProfile.h  

void SetMediaOutput ( int32 Index,
UMediaOutput* InMediaOutput
)

 Sets the media output at the specified index in the profile's list of outputs Profile/MediaProfile.h  

void SetMediaSource ( int32 Index,
UMediaSource* InMediaSource
)

 Sets the media source at the specified index in the profile's list of sources Profile/MediaProfile.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page