Job Status

This section covers the status dictionaries returned by Project:RenderWithQuickExport and by the Project job status methods, which report the progress of the active render or analysis operation.

When no such operation is active, each status method returns a dictionary containing only JobStatus set to "Inactive". The other keys are only set while the job is running, on completion or on failure, as noted per key.

Quick Export render status

Project:RenderWithQuickExport and Project:GetRenderWithQuickExportStatus return a dictionary containing the following keys:

JobStatus: string (options: "Rendering", "Render Complete", "Render Failed", "Render Cancelled", "Upload Pending", "Uploading", "Upload Completed", "Upload Failed", "Upload Cancelled", "Inactive", "Unexpected")

CompletionPercentage: int (set for rendering jobs)

TimeTakenToRenderInMs: int (time taken to render in milliseconds, set on completion)

EstimatedTimeRemainingInMs: int (time remaining to render in milliseconds, set for rendering jobs)

Error: string (error details, set on failure)

Transcribe audio status

Project:GetTranscribeAudioStatus reports on the active Folder:TranscribeAudio / MediaPoolItem:TranscribeAudio operation, and returns a dictionary containing the following keys:

JobStatus: string (options: "Inactive", "Initializing", "Analyzing", "Cancelling", "Cancelled", "Complete")

CompletionPercentage: int (set while transcription is in progress)

CurrentClipIndex: int (index of the clip being analyzed, set while transcription is in progress)

TotalClips: int (total clips to analyze, set while transcription is in progress)

EstimatedTimeRemaining: int (time remaining to complete transcription in seconds, set while transcription is in progress)

Error: string (error details, set on failure)

Slate analysis status

Project:GetAnalyzeForSlateStatus reports on the active Folder:AnalyzeForSlate / MediaPoolItem:AnalyzeForSlate operation, and returns a dictionary containing the following keys:

JobStatus: string (options: "Inactive", "Initializing", "Analyzing", "Cancelling", "Cancelled", "Complete", "Failed")

CompletionPercentage: int (set during analysis)

CurrentClipIndex: int (index of the clip being analyzed, set during analysis)

TotalClips: int (total clips to analyze, set during analysis)

EstimatedTimeRemaining: int (time remaining to complete analysis in seconds, set during analysis)

Error: string (error details, set on failure)

Smart Reframe status

Project:GetSmartReframeStatus reports on the active TimelineItem:SmartReframe operation, and returns a dictionary containing the following keys:

JobStatus: string (options: "Inactive", "Initializing", "Analyzing", "Cancelled", "Complete", "Failed")

CompletionPercentage: int (set during analysis)

AnalysisSpeed: float (analysis speed in fps, set during analysis)

EstimatedTimeRemaining: int (time remaining to complete smart reframe in seconds, set during analysis)

Error: string (error details, set on failure)

Detect scene cuts status

Project:GetDetectSceneCutsStatus reports on the active Timeline:DetectSceneCuts operation, and returns a dictionary containing the following keys:

JobStatus: string (options: "Inactive", "Analyzing", "Complete", "Cancelled")

CompletionPercentage: int (set during analysis)

AnalysisSpeed: float (analysis speed in fps, set during analysis)

EstimatedTimeRemaining: int (estimated time remaining in seconds, set during analysis)

Create subtitles from audio status

Project:GetCreateSubtitlesFromAudioStatus reports on the active Timeline:CreateSubtitlesFromAudio operation, and returns a dictionary containing the following keys:

JobStatus: string (options: "Inactive", "Initializing", "Analyzing", "Cancelling", "Cancelled", "Complete", "Failed")

CompletionPercentage: int (set during analysis)

AnalysisSpeed: float (analysis speed, set during analysis)

EstimatedTimeRemaining: int (time remaining to complete subtitle creation in seconds, set during analysis)

Error: string (error details, set on failure)