Class FFmpegQueue

A promise-returning job queue with a fixed concurrency limit.

Example

const queue = new FFmpegQueue({ concurrency: 2 });
await Promise.all([
  queue.run(() => transcode('a.mp4', 'a-out.mp4')),
  queue.run(() => transcode('b.mp4', 'b-out.mp4')),
  queue.run(() => transcode('c.mp4', 'c-out.mp4')),
]);
// At most two ran at once.

Index

Accessors

concurrency

get concurrency(): number
Maximum jobs that may run at once.

Returns number
- Defined in queue.ts:89

Constructors

constructor

new FFmpegQueue(options?: QueueOptions): FFmpegQueue
Parameters
- options: QueueOptions = {}
Returns FFmpegQueue
- Defined in queue.ts:76

Methods

stats

stats(): QueueStats
Current queue depth.

Returns QueueStats
- Defined in queue.ts:94

run

run<T>(run: () => Promise<T>, options?: { signal?: AbortSignal }): Promise<T>
Enqueue a job, resolving when it has run.
Type Parameters
- T
Parameters
- run: () => Promise<T>
- options: { signal?: AbortSignal } = {}
Returns Promise<T>
Throws
VALIDATION_FAILED when maxPending is exceeded.
- Defined in queue.ts:112

onIdle

onIdle(): Promise<void>
Wait until every queued and running job has settled.

Returns Promise<void>
- Defined in queue.ts:154

Class FFmpegQueue

Example

Index

Accessors

Constructors

Methods

Accessors

concurrency

Returns number

Constructors

constructor

Parameters

Returns FFmpegQueue

Methods

stats

Returns QueueStats

run

Type Parameters

Parameters

Returns Promise<T>

Throws

onIdle

Returns Promise<void>

Settings

On This Page