Interface StreamScopedDownloads

interface StreamScopedDownloads {
    delete(downloadType?: StreamDownloadType): Promise<void>;
    generate(
        downloadType?: StreamDownloadType,
    ): Promise<StreamDownloadGetResponse>;
    get(): Promise<StreamDownloadGetResponse>;
}

Index

Methods

delete generate get

Methods

delete

delete(downloadType?: StreamDownloadType): Promise<void>
Delete the downloads for a video. Available types are default and audio. Defaults to default when omitted.
Parameters
- OptionaldownloadType: StreamDownloadType
  The download type to delete.
Returns Promise<void>
A promise that resolves when deletion completes.

Throws
if the video or downloads are not found

Throws
if an unexpected error occurs
- Defined in src/server/worker-configuration.d.ts:13459

generate

generate(downloadType?: StreamDownloadType): Promise<StreamDownloadGetResponse>
Generates a download for a video when a video is ready to view. Available types are default and audio. Defaults to default when omitted.
Parameters
- OptionaldownloadType: StreamDownloadType
  The download type to create.
Returns Promise<StreamDownloadGetResponse>
The current downloads for the video.

Throws
if the video is not found

Throws
if the download type is invalid

Throws
if the video duration is too long to generate a download

Throws
if the video is not ready to stream

Throws
if an unexpected error occurs
- Defined in src/server/worker-configuration.d.ts:13443

get

get(): Promise<StreamDownloadGetResponse>
Lists the downloads created for a video.

Returns Promise<StreamDownloadGetResponse>
The current downloads for the video.

Throws
if the video or downloads are not found

Throws
if an unexpected error occurs
- Defined in src/server/worker-configuration.d.ts:13450