Interface WaitTranscodeOptions

interface WaitTranscodeOptions {
    ignorePlaybackWhileTranscoding?: boolean;
    onError?: (error: Error) => void | Promise<void>;
    onProgress?: (state: StatusResponse) => void;
    pollIntervalSeconds?: number;
    signal?: AbortSignal;
    timeoutMinutes?: number;
}

Properties

ignorePlaybackWhileTranscoding? onError? onProgress? pollIntervalSeconds? signal? timeoutMinutes?

Properties

OptionalignorePlaybackWhileTranscoding

ignorePlaybackWhileTranscoding?: boolean

If true set the status of video as "Processing" until transcode completes, instead of the default behavior of indicating "Ready" as soon as a playable version is available. See https://revdocs.vbrick.com/docs/allow-playback-during-transcoding

Default

{true} - set status to "Processing" until all processing jobs are complete.

OptionalonError

onError?: (error: Error) => void | Promise<void>

callback on error getting video status

Default

throw error immediately

OptionalonProgress

onProgress?: (state: StatusResponse) => void

callback to report current transcode progress

OptionalpollIntervalSeconds

pollIntervalSeconds?: number

How often to check video status

Default

30

Optionalsignal

signal?: AbortSignal

Signal to stop poll loop early

OptionaltimeoutMinutes

timeoutMinutes?: number

How long to wait for transcode to complete before stopping poll loop

Default

240 (4 hours)

Settings

Member Visibility

On This Page

Properties