TmvMedia


Name	TmvMedia
Type	Plugin
Part of Plugins	Tiled Mipmap Video Player
Location	/Engine/Plugins/Media/TmvMedia/Source/TmvMedia/
Module Build Rules	TmvMedia.Build.cs

Name	Remarks
FTmvMediaFrameMipBufferPool	Tmv Frame Mip Buffer Pool.
FTmvMediaMessageContext	Container for error messages that get accumulated during operations and can be compiled into a report for display in UI or dumped to Logs.
FTmvMediaTranscodeJobBuilder	Fluent builder for UTmvMediaTranscodeJob.
TTmvMediaSharedObjectPool	Pool for worker thread context objects that can be reused within the same stream (i.e. no options changes) to the next when available.
UTmvMediaFrameConverter	Base class for converter stage of transcode pipeline.
UTmvMediaFrameEncoder	Base class for encoder stage of the transcode pipeline.
UTmvMediaFrameProducer	Base class for producer stage of transcode pipeline.
UTmvMediaTranscodeJob	The transcode job implements a staged transcoding pipeline.
UTmvMediaTranscodeList	Transcode Job (settings) ListThis object is a container for transcode job settings.
UTmvMediaTranscodeMuxer	Abstract base class for muxer stage of transcode pipeline.
UTmvMediaTranscodeStage	Base class for a media transcoding pipeline stage.

Name	Remarks
FTmvMediaDecoderMipRequest	Mip decoding request.
FTmvMediaDemuxerSample	A single sample read from a demuxed container.
FTmvMediaDemuxerTrackInfo	Information about a single track in a demuxed container.
FTmvMediaEncoderMipInfo	All the parameters needed to request a mip memory layout for the encoder.
FTmvMediaEncoderMipRequest	Mip encoding request.
FTmvMediaEncoderOptions	Encoder options.
FTmvMediaFrameColorInfo	Defines the color space, encoding and yuv matrix of a frame buffer in the tmv framework.
FTmvMediaFrameMipInfo	This struct describes information (memory layout, color model, component type) about a mipmap buffer for a video frame.
FTmvMediaFrameMips	Container of an array of frame mip buffers with time info for the transcoder pipeline.
FTmvMediaFramePlaneInfo	Defines the layout and format of a video frame memory plane.
FTmvMediaFrameProducerTrackInfo	Track information for the currently playing tracks from the frame producer stage.
FTmvMediaFrameTimeInfo	Time information for a frame.
FTmvMediaMuxerConfig	Configuration for the muxer output.
FTmvMediaMuxerSample	A single sample to be muxed into a track.
FTmvMediaMuxerTrackConfig	Configuration for a single track in the muxer.
FTmvMediaTrackInfo	Common descriptor for a media track, shared by muxer and demuxer.
FTmvMediaTrackSampleInfo	Common sample metadata shared by muxer and demuxer sample structs.
FTmvMediaTranscodeJobRunOptions	Per-job runtime options applied when a job is enqueued in the runner.
FTmvMediaTranscodeJobSettings	Common Transcode Job Settings
FTmvMediaTranscodeJobTime	Time arguments for job management.
FTmvMediaTranscodeListItem	Transcode Job item Holds all the settings to be able to execute a transcode job.
FTmvMediaTranscodeListItemEventArgs	Transcode list editing event arguments
FTmvMediaTranscodeMuxerSettings	Structure for muxer settings used to select the muxer.
FTmvMediaTranscodingJobStats
FTmvMediaUtils	Collections of small utility functions to help implement Tmv related features.

Name	Remarks
ITmvMediaDecoder	TMV (Tile-Based) Decoder interface.
ITmvMediaDecoderAccessUnit	Interface for the decoder's access unit.
ITmvMediaDecoderFactory	Interface for a ITmvMediaDecoder factory.
ITmvMediaDemuxer	Abstract interface for demuxing media samples from a container.
ITmvMediaDemuxerFactory	Interface for an ITmvMediaDemuxer factory.
ITmvMediaEncoder	TMV (Tile-Based) Encoder interface.
ITmvMediaEncoderAccessUnit	Interface for the encoder's access unit.
ITmvMediaEncoderFactory	Interface for a ITmvMediaEncoder factory.
ITmvMediaModule	Interface for the Tiled-Mipmap Video (TMV) module.
ITmvMediaMuxer	Abstract interface for muxing encoded access units into a media container.
ITmvMediaMuxerFactory	Interface for an ITmvMediaMuxer factory.
ITmvMediaParser	TMV access unit parser interface.
ITmvMediaTranscodeJobManager	Singleton manager for all transcode jobs.
ITmvMediaTranscodeJobRunner	Singleton runner that owns the active transcode job and a pending queue, and ticks the active job from an engine system (FTickableGameObject) so jobs progress regardless of Slate window visibility.
ITmvMediaTranscodeNotification	Interface for the notifications.

Name	Type	Remarks	Include Path
FOnTranscodeJobBuilt	TBaseDelegate_OneParam< void, UTmvMediaTranscodeJob * >	Delegate invoked on a fully-assembled job just before the builder returns it (Start has not been called).	Transcoder/TmvMediaTranscodeJobBuilder.h
FOnTranscodeJobStarting	TBaseDelegate_OneParam< void, UTmvMediaTranscodeJob * >	Fired on the game thread immediately before the runner calls Start() on the job.	Transcoder/ITmvMediaTranscodeJobRunner.h
FTmvMediaFrameMipBufferHandle	TSharedPtr< FTmvMediaFrameMipBuffer, ESPMode::ThreadSafe >	A shared mip buffer acquired from a pool that handles returning to the pool upon release.	SampleConverter/TmvMediaFrameMipBufferFwd.h

Name	Remarks
ETmvMediaContainerResult	Common result code for container muxer/demuxer operations.
ETmvMediaDecoderResult	Decoder return code.
ETmvMediaEncoderColorMatrix	Carries the information about the YUV conversion matrix.
ETmvMediaEncoderColorMatrixRange	Carries the information about the range of the YUV conversion matrix (Scaled vs UnScaled)
ETmvMediaEncoderEncoding	List of supported encoder transfer functions (a.k.a encodings), matching the list in ColorManagementDefines.h.
ETmvMediaEncoderReferenceWhite	Reference-white standards for HDR encoder input.
ETmvMediaEncoderResult	Encoder return code.
ETmvMediaFrameBufferLayout	Defines buffer memory data layout, i.e. the overall way the memory is organized in the whole frame buffer.
ETmvMediaFrameColorMatrix	Carries the information about the YUV conversion matrix.
ETmvMediaFrameColorMatrixRange	Carries the information about the range of the YUV conversion matrix (Scaled vs UnScaled)
ETmvMediaFrameColorModel	Defines the color model the components are representing.
ETmvMediaFrameComponentLayout	Defines the layout of components in a memory plane.
ETmvMediaFrameComponentType	Defines currently supported component data types.
ETmvMediaTrackType	Track type for muxer/demuxer tracks.
ETmvMediaTranscodeInputSource	Selection of the input source/
ETmvMediaTranscodeJobEvent	Job event enumeration used in delegates (for UI refresh mostly)
ETmvMediaTranscodeJobStatus	Transcode Job Status.
ETmvMediaTranscodeJobStopReason	Information about the reason for job to be stopped. This is used for monitoring the job's state.
ETmvMediaTranscodeListItemEventType	Transcode list editing events
ETmvMediaTranscodeOutputFormat	Selection of the output format.
ETmvMediaTranscodeStageStatus	Transcode stage status.

Name	Remarks	Include Path
FString UE::TmvMedia::Utils::FourCCToString ( uint32 InFourCC )	Returns the string made out of the 4 character codes from the given FourCC value.	Utils/TmvMediaUtils.h
uint32 UE::TmvMedia::Utils::MakeFourCC ( const uint8 A, const uint8 B, const uint8 C, const uint8 D )	Constructs a FourCC integer from four 8-bit character codes, commonly used for identifying file formats, codec types, or pixel formats.	Utils/TmvMediaUtils.h
FString UE::TmvMedia::Utils::StaticEnumToString ( InEnumType InValue )	Converts an enum value to a string for logging purposes.	Utils/TmvMediaUtils.h
FText UE::TmvMedia::Utils::StaticEnumToText ( InEnumType InValue )		Utils/TmvMediaUtils.h

Navigation

Classes

Structs

Interfaces

Typedefs

Enums

Public

Functions

Public