Navigation
API > API/Plugins > API/Plugins/TmvMedia
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.
Sequential: at most one job runs at a time; the next is started when the current completes.
| Name | ITmvMediaTranscodeJobRunner |
| Type | class |
| Header File | /Engine/Plugins/Media/TmvMedia/Source/TmvMedia/Public/Transcoder/ITmvMediaTranscodeJobRunner.h |
| Include Path | #include "Transcoder/ITmvMediaTranscodeJobRunner.h" |
Syntax
class ITmvMediaTranscodeJobRunner
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ITmvMediaTranscodeJobRunner() |
Transcoder/ITmvMediaTranscodeJobRunner.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnAllJobsFinished | TMulticastDelegate_NoParams< void > | Delegate fired (game thread) when the runner observes the last active job complete via Tick with no pending jobs left. | Transcoder/ITmvMediaTranscodeJobRunner.h |
| FOnRunnerJobEvent | TMulticastDelegate_OneParam< void, UTmvMediaTranscodeJob * > | Delegate fired (game thread) when a job's Start() returned true and the job is now active. | Transcoder/ITmvMediaTranscodeJobRunner.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CancelAll() |
Cancel the active job and discard all pending jobs. | Transcoder/ITmvMediaTranscodeJobRunner.h | |
void CancelJob
(
const FGuid& InJobId |
Cancel a specific job by id, whether it is currently active or pending. | Transcoder/ITmvMediaTranscodeJobRunner.h | |
void EnqueueJob
(
UTmvMediaTranscodeJob* InJob, |
Enqueue a job for execution. | Transcoder/ITmvMediaTranscodeJobRunner.h | |
FOnAllJobsFinished & GetOnAllJobsFinished() |
Transcoder/ITmvMediaTranscodeJobRunner.h | ||
FOnRunnerJobEvent & GetOnJobFinished () |
Delegate fired (game thread) when a job leaves the runner. | Transcoder/ITmvMediaTranscodeJobRunner.h | |
FOnRunnerJobEvent & GetOnJobStarted() |
Transcoder/ITmvMediaTranscodeJobRunner.h | ||
bool HasActiveOrPendingJobs() |
Returns true if there is at least one job active or pending. | Transcoder/ITmvMediaTranscodeJobRunner.h | |
bool IsJobActiveOrPending
(
const FGuid& InJobId |
Returns true if the job with the given id is currently active or queued. | Transcoder/ITmvMediaTranscodeJobRunner.h |
Protected Virtual
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static ITmvMediaTranscodeJobRunner * Get() |
Returns a pointer to the global transcode job runner, if the TmvMedia module is loaded. | Transcoder/ITmvMediaTranscodeJobRunner.h |