UMediaProfile

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MediaFrameworkUtilities

Header

/Engine/Plugins/Media/MediaFrameworkUtilities/Source/MediaFrameworkUtilities/Public/Profile/MediaProfile.h

Include

#include "Profile/MediaProfile.h"

Syntax

UCLASS(BlueprintType)
class UMediaProfile : public UObject

Remarks

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

Variables

Name Description

Public variable

bool

 

bNeedToBeReapplied

When the profile is the current profile and modifications made it dirty.

Protected variable UProperty Category, EditAnywhere, Meta

bool

 

bOverrideCustomTimeStep

Override the Engine's Custom time step defined in the project settings.

Protected variable UProperty Category, EditAnywhere, Meta

bool

 

bOverrideTimecodeProvider

Override the Engine's Timecode provider defined in the project settings.

Protected variable UProperty Category, EditAnywhere, Meta instanced

UEngineCustomTi...

 

CustomTimeStep

Custom time step

Protected variable UProperty Category, EditAnywhere, Meta editfixedsize, instanced

TArray< UMediaO...

 

MediaOutputs

Media outputs.

Protected variable UProperty Category, EditAnywhere, Meta editfixedsize, instanced

TArray< UMediaS...

 

MediaSources

Media sources.

Protected variable UProperty Category, EditAnywhere, Meta instanced

UTimecodeProvid...

 

TimecodeProvider

Timecode provider.

Functions

Name Description

Public function Virtual

void

 

Apply()

Apply the media profile.

Public function

void

 

FixNumSourcesAndOutputs()

Update the number of sources and outputs to the number to proxies.

Public function Const

UEngineCusto...

 

GetCustomTimeStep()

Get the custom time step.

Public function Const

UMediaOutput...

 

GetMediaOutput

(
    int32 Index
)

Get the media output for the selected proxy.

Public function Const

UMediaSource...

 

GetMediaSource

(
    int32 Index
)

Get the media source for the selected proxy.

Public function Const

UTimecodePro...

 

GetTimecodeProvider()

Get the timecode provider.

Public function

bool

 

IsMediaSourceAffectedByProfile

(
    UMediaSource* InMediaSource
)

Apply the media profile as the current profile.

Public function Const

int32

 

NumMediaOutputs()

Get the number of media output.

Public function Const

int32

 

NumMediaSources()

Get the number of media source.

Public function Virtual

void

 

Reset()

Reset the media profile.