FTmvMediaTranscodeJobSettings

Common Transcode Job Settings

API > API/Plugins > API/Plugins/TmvMedia

Common Transcode Job Settings

   
Name FTmvMediaTranscodeJobSettings
Type struct
Header File /Engine/Plugins/Media/TmvMedia/Source/TmvMedia/Public/Transcoder/TmvMediaTranscodeJob.h
Include Path #include "Transcoder/TmvMediaTranscodeJob.h"

Syntax

USTRUCT (BlueprintType )  
struct FTmvMediaTranscodeJobSettings

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bEnableMipMapping bool If checked, mip maps will be generated and encoded in the final destination. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Frame Producer"
bEnableStartTimecodeOverride bool   Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Input Sequence"
  • AdvancedDisplay
  • Meta=(InlineEditConditionToggle)
bMakeOutputAsset bool If enabled, a media source asset will be made for the output sequence. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Output Sequence"
bUseMediaPlayer bool Use a media player to read the source media. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Frame Producer"
FrameRate FFrameRate Allow to specify a frame rate if the media sources don't provide it. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Input Sequence"
  • Meta=(EditCondition="InputSource == ETmvMediaTranscodeInputSource::File", EditConditionHides)
InputMediaSource TSoftObjectPtr< UMediaSource > Specify an existing media source as the input. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Input Sequence"
  • Meta=(EditCondition="InputSource == ETmvMediaTranscodeInputSource::MediaSource", EditConditionHides, AllowedClasses="/Script/MediaAssets.FileMediaSource,/Script/ImgMedia.ImgMediaSource")
InputPath FFilePath The directory that contains the source media (image sequence files or container). Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Input Sequence"
  • Meta=(EditCondition="InputSource == ETmvMediaTranscodeInputSource::File", EditConditionHides)
InputSource ETmvMediaTranscodeInputSource Select the input source. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Input Sequence"
  • Meta=(SegmentedDisplay)
Muxer FTmvMediaTranscodeMuxerSettings   Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Output Sequence"
  • AdvancedDisplay
  • Meta=(EditCondition="OutputFormat == ETmvMediaTranscodeOutputFormat::Container", EditConditionHides)
NumProducerThreads int32 Number of threads for the frame producer pipeline. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Frame Producer"
OutputAssetDirectory FDirectoryPath Destination content directory for the MediaSource asset to create or update (e.g. /Game/MediaSources) for the output sequence. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Output Sequence"
  • Meta=(EditCondition="bMakeOutputAsset", EditConditionHides, ContentDir)
OutputBaseName FString Specify the output base name. Supports {frame_number} token. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Output Sequence"
OutputFormat ETmvMediaTranscodeOutputFormat Select the output format. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Output Sequence"
  • Meta=(SegmentedDisplay)
OutputPath FDirectoryPath The directory to output the processed image sequence files to. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Output Sequence"
StartTimecodeOverride FTimecode Specify a start time code for the input sequence. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Input Sequence"
  • AdvancedDisplay
  • Meta=(EditCondition="bEnableStartTimecodeOverride")
ZeroPadFrameNumbers int32 Specify the zero padding on the frame number in the output sequence files. Transcoder/TmvMediaTranscodeJob.h
  • EditAnywhere
  • Category="Output Sequence"
  • AdvancedDisplay
  • Meta=(ClampMin=0, UIMin=0, EditCondition="OutputFormat == ETmvMediaTranscodeOutputFormat::FileSequence", EditConditionHides)

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString GetAbsoluteInputPath()

 Returns the absolute file path of the media. Transcoder/TmvMediaTranscodeJob.h  

FString GetAbsoluteOutputPath()

 Returns the absolute output directory path. Transcoder/TmvMediaTranscodeJob.h  
Returns the input frame rate setting. Transcoder/TmvMediaTranscodeJob.h  

FString GetInputPath()

 Returns the input url (either media source or file). Transcoder/TmvMediaTranscodeJob.h  

bool IsInputPathSet()

 Returns true if the input path is set. Transcoder/TmvMediaTranscodeJob.h  

bool IsOutputPathSet()

 Returns true if the output path is set. Transcoder/TmvMediaTranscodeJob.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page