camera.ui Node SDK

Appearance

@camera.ui/sdk / manager / CreateStreamDownloadOptions

Interface: CreateStreamDownloadOptions ​

Defined in: manager/index.ts:350

Options for creating a streaming download (progressive file tailing).

Extends ​

Properties ​

cleanup? ​

optional cleanup?: DownloadCleanup

Defined in: manager/index.ts:382

When the file on disk gets cleaned up. Defaults to 'never' (caller manages lifecycle). Use 'on-expiry' for multi-recipient notification images, 'on-download' for one-shot exports.

Inherited from ​

CreateDownloadOptions.cleanup

filename? ​

optional filename?: string

Defined in: manager/index.ts:372

Filename for Content-Disposition header (defaults to basename of filePath).

Inherited from ​

CreateDownloadOptions.filename

filePath ​

filePath: string

Defined in: manager/index.ts:370

Absolute path to the file on disk, inside the plugin's storage folder (api.storagePath).

Inherited from ​

CreateDownloadOptions.filePath

markerPath ​

markerPath: string

Defined in: manager/index.ts:352

Path to a marker file that signals export is still in progress, inside the plugin's storage folder.

mimeType? ​

optional mimeType?: string

Defined in: manager/index.ts:374

MIME type for Content-Type header (defaults to application/octet-stream).

Inherited from ​

CreateDownloadOptions.mimeType

ttlMs? ​

optional ttlMs?: number

Defined in: manager/index.ts:376

Time-to-live in milliseconds (defaults to 10 minutes).

Inherited from ​

CreateDownloadOptions.ttlMs