Navigation
API > API/Plugins > API/Plugins/TmvMedia
Base class for a media transcoding pipeline stage.
| Name | UTmvMediaTranscodeStage |
| Type | class |
| Header File | /Engine/Plugins/Media/TmvMedia/Source/TmvMedia/Public/Transcoder/TmvMediaTranscodeStage.h |
| Include Path | #include "Transcoder/TmvMediaTranscodeStage.h" |
Syntax
UCLASS (MinimalAPI)
class UTmvMediaTranscodeStage : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UTmvMediaTranscodeStage
Derived Classes
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| StageStatus | std::atomic< ETmvMediaTranscodeStageStatus > | Indicate the status of the stage. | Transcoder/TmvMediaTranscodeStage.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ETmvMediaTranscodeStageStatus GetStageStatus() |
Returns the current status of the stage. | Transcoder/TmvMediaTranscodeStage.h | |
void SetStageStatus
(
ETmvMediaTranscodeStageStatus InStatus, |
Change the status of the stage. This will propagate job events. | Transcoder/TmvMediaTranscodeStage.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void RequestStop
(
UTmvMediaTranscodeJob* InParentJob |
This will request the stage to stop. | Transcoder/TmvMediaTranscodeStage.h | |
virtual bool Start
(
UTmvMediaTranscodeJob* InParentJob |
Start the stage. | Transcoder/TmvMediaTranscodeStage.h | |
virtual void Tick
(
UTmvMediaTranscodeJob* InParentJob, |
Tick the job in the main thread to perform the main thread coordination. | Transcoder/TmvMediaTranscodeStage.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void UpdateStatusFromFrameProducer
(
UTmvMediaTranscodeJob* InParentJob |
Updates the status of this stage to mirror that of the producer stage. | Transcoder/TmvMediaTranscodeStage.h |