435 lines
19 KiB
TypeScript
435 lines
19 KiB
TypeScript
import { APIResource } from "../../resource.js";
|
|
import * as Core from "../../core.js";
|
|
import * as AudioTracksAPI from "./audio-tracks.js";
|
|
import { Audio, AudioSinglePage, AudioTrackCopyParams, AudioTrackDeleteParams, AudioTrackDeleteResponse, AudioTrackEditParams, AudioTrackGetParams, AudioTracks } from "./audio-tracks.js";
|
|
import * as ClipAPI from "./clip.js";
|
|
import { Clip, ClipCreateParams, ClipResource } from "./clip.js";
|
|
import * as CopyAPI from "./copy.js";
|
|
import { Copy, CopyCreateParams } from "./copy.js";
|
|
import * as DirectUploadAPI from "./direct-upload.js";
|
|
import { DirectUpload, DirectUploadCreateParams, DirectUploadCreateResponse } from "./direct-upload.js";
|
|
import * as DownloadsAPI from "./downloads.js";
|
|
import { DownloadCreateParams, DownloadCreateResponse, DownloadDeleteParams, DownloadDeleteResponse, DownloadGetParams, DownloadGetResponse, Downloads } from "./downloads.js";
|
|
import * as EmbedAPI from "./embed.js";
|
|
import { Embed, EmbedGetParams, EmbedGetResponse } from "./embed.js";
|
|
import * as KeysAPI from "./keys.js";
|
|
import { KeyCreateParams, KeyDeleteParams, KeyDeleteResponse, KeyGetParams, KeyGetResponse, KeyGetResponsesSinglePage, Keys } from "./keys.js";
|
|
import * as TokenAPI from "./token.js";
|
|
import { Token, TokenCreateParams, TokenCreateResponse } from "./token.js";
|
|
import * as VideosAPI from "./videos.js";
|
|
import { VideoStorageUsageParams, VideoStorageUsageResponse, Videos } from "./videos.js";
|
|
import * as WatermarksAPI from "./watermarks.js";
|
|
import { Watermark, WatermarkCreateParams, WatermarkDeleteParams, WatermarkDeleteResponse, WatermarkGetParams, WatermarkListParams, Watermarks, WatermarksSinglePage } from "./watermarks.js";
|
|
import * as WebhooksAPI from "./webhooks.js";
|
|
import { WebhookDeleteParams, WebhookDeleteResponse, WebhookGetParams, WebhookGetResponse, WebhookUpdateParams, WebhookUpdateResponse, Webhooks } from "./webhooks.js";
|
|
import * as CaptionsAPI from "./captions/captions.js";
|
|
import { Caption, CaptionGetParams, Captions, CaptionsSinglePage } from "./captions/captions.js";
|
|
import * as LiveInputsAPI from "./live-inputs/live-inputs.js";
|
|
import { LiveInput, LiveInputCreateParams, LiveInputDeleteParams, LiveInputGetParams, LiveInputListParams, LiveInputListResponse, LiveInputUpdateParams, LiveInputs } from "./live-inputs/live-inputs.js";
|
|
import { SinglePage } from "../../pagination.js";
|
|
export declare class Stream extends APIResource {
|
|
audioTracks: AudioTracksAPI.AudioTracks;
|
|
videos: VideosAPI.Videos;
|
|
clip: ClipAPI.ClipResource;
|
|
copy: CopyAPI.Copy;
|
|
directUpload: DirectUploadAPI.DirectUpload;
|
|
keys: KeysAPI.Keys;
|
|
liveInputs: LiveInputsAPI.LiveInputs;
|
|
watermarks: WatermarksAPI.Watermarks;
|
|
webhooks: WebhooksAPI.Webhooks;
|
|
captions: CaptionsAPI.Captions;
|
|
downloads: DownloadsAPI.Downloads;
|
|
embed: EmbedAPI.Embed;
|
|
token: TokenAPI.Token;
|
|
/**
|
|
* Initiates a video upload using the TUS protocol. On success, the server responds
|
|
* with a status code 201 (created) and includes a `location` header to indicate
|
|
* where the content should be uploaded. Refer to https://tus.io for protocol
|
|
* details.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* await client.stream.create({
|
|
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
|
|
* body: {},
|
|
* 'Tus-Resumable': '1.0.0',
|
|
* 'Upload-Length': 0,
|
|
* });
|
|
* ```
|
|
*/
|
|
create(params: StreamCreateParams, options?: Core.RequestOptions): Core.APIPromise<void>;
|
|
/**
|
|
* Lists up to 1000 videos from a single request. For a specific range, refer to
|
|
* the optional parameters.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* // Automatically fetches more pages as needed.
|
|
* for await (const video of client.stream.list({
|
|
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
|
|
* })) {
|
|
* // ...
|
|
* }
|
|
* ```
|
|
*/
|
|
list(params: StreamListParams, options?: Core.RequestOptions): Core.PagePromise<VideosSinglePage, Video>;
|
|
/**
|
|
* Deletes a video and its copies from Cloudflare Stream.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* await client.stream.delete(
|
|
* 'ea95132c15732412d22c1476fa83f27a',
|
|
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
* );
|
|
* ```
|
|
*/
|
|
delete(identifier: string, params: StreamDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void>;
|
|
/**
|
|
* Edit details for a single video.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const video = await client.stream.edit(
|
|
* 'ea95132c15732412d22c1476fa83f27a',
|
|
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
* );
|
|
* ```
|
|
*/
|
|
edit(identifier: string, params: StreamEditParams, options?: Core.RequestOptions): Core.APIPromise<Video>;
|
|
/**
|
|
* Fetches details for a single video.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const video = await client.stream.get(
|
|
* 'ea95132c15732412d22c1476fa83f27a',
|
|
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
* );
|
|
* ```
|
|
*/
|
|
get(identifier: string, params: StreamGetParams, options?: Core.RequestOptions): Core.APIPromise<Video>;
|
|
}
|
|
export declare class VideosSinglePage extends SinglePage<Video> {
|
|
}
|
|
export type AllowedOrigins = string;
|
|
export type AllowedOriginsParam = string;
|
|
export interface Video {
|
|
/**
|
|
* Lists the origins allowed to display the video. Enter allowed origin domains in
|
|
* an array and use `*` for wildcard subdomains. Empty arrays allow the video to be
|
|
* viewed on any origin.
|
|
*/
|
|
allowedOrigins?: Array<AllowedOrigins>;
|
|
/**
|
|
* The date and time the media item was created.
|
|
*/
|
|
created?: string;
|
|
/**
|
|
* A user-defined identifier for the media creator.
|
|
*/
|
|
creator?: string;
|
|
/**
|
|
* The duration of the video in seconds. A value of `-1` means the duration is
|
|
* unknown. The duration becomes available after the upload and before the video is
|
|
* ready.
|
|
*/
|
|
duration?: number;
|
|
input?: Video.Input;
|
|
/**
|
|
* The live input ID used to upload a video with Stream Live.
|
|
*/
|
|
liveInput?: string;
|
|
/**
|
|
* The maximum duration in seconds for a video upload. Can be set for a video that
|
|
* is not yet uploaded to limit its duration. Uploads that exceed the specified
|
|
* duration will fail during processing. A value of `-1` means the value is
|
|
* unknown.
|
|
*/
|
|
maxDurationSeconds?: number;
|
|
/**
|
|
* A user modifiable key-value store used to reference other systems of record for
|
|
* managing videos.
|
|
*/
|
|
meta?: unknown;
|
|
/**
|
|
* The date and time the media item was last modified.
|
|
*/
|
|
modified?: string;
|
|
playback?: Video.Playback;
|
|
/**
|
|
* The video's preview page URI. This field is omitted until encoding is complete.
|
|
*/
|
|
preview?: string;
|
|
/**
|
|
* Indicates whether the video is playable. The field is empty if the video is not
|
|
* ready for viewing or the live stream is still in progress.
|
|
*/
|
|
readyToStream?: boolean;
|
|
/**
|
|
* Indicates the time at which the video became playable. The field is empty if the
|
|
* video is not ready for viewing or the live stream is still in progress.
|
|
*/
|
|
readyToStreamAt?: string;
|
|
/**
|
|
* Indicates whether the video can be a accessed using the UID. When set to `true`,
|
|
* a signed token must be generated with a signing key to view the video.
|
|
*/
|
|
requireSignedURLs?: boolean;
|
|
/**
|
|
* Indicates the date and time at which the video will be deleted. Omit the field
|
|
* to indicate no change, or include with a `null` value to remove an existing
|
|
* scheduled deletion. If specified, must be at least 30 days from upload time.
|
|
*/
|
|
scheduledDeletion?: string;
|
|
/**
|
|
* The size of the media item in bytes.
|
|
*/
|
|
size?: number;
|
|
/**
|
|
* Specifies a detailed status for a video. If the `state` is `inprogress` or
|
|
* `error`, the `step` field returns `encoding` or `manifest`. If the `state` is
|
|
* `inprogress`, `pctComplete` returns a number between 0 and 100 to indicate the
|
|
* approximate percent of completion. If the `state` is `error`, `errorReasonCode`
|
|
* and `errorReasonText` provide additional details.
|
|
*/
|
|
status?: Video.Status;
|
|
/**
|
|
* The media item's thumbnail URI. This field is omitted until encoding is
|
|
* complete.
|
|
*/
|
|
thumbnail?: string;
|
|
/**
|
|
* The timestamp for a thumbnail image calculated as a percentage value of the
|
|
* video's duration. To convert from a second-wise timestamp to a percentage,
|
|
* divide the desired timestamp by the total duration of the video. If this value
|
|
* is not set, the default thumbnail image is taken from 0s of the video.
|
|
*/
|
|
thumbnailTimestampPct?: number;
|
|
/**
|
|
* A Cloudflare-generated unique identifier for a media item.
|
|
*/
|
|
uid?: string;
|
|
/**
|
|
* The date and time the media item was uploaded.
|
|
*/
|
|
uploaded?: string;
|
|
/**
|
|
* The date and time when the video upload URL is no longer valid for direct user
|
|
* uploads.
|
|
*/
|
|
uploadExpiry?: string;
|
|
watermark?: WatermarksAPI.Watermark;
|
|
}
|
|
export declare namespace Video {
|
|
interface Input {
|
|
/**
|
|
* The video height in pixels. A value of `-1` means the height is unknown. The
|
|
* value becomes available after the upload and before the video is ready.
|
|
*/
|
|
height?: number;
|
|
/**
|
|
* The video width in pixels. A value of `-1` means the width is unknown. The value
|
|
* becomes available after the upload and before the video is ready.
|
|
*/
|
|
width?: number;
|
|
}
|
|
interface Playback {
|
|
/**
|
|
* DASH Media Presentation Description for the video.
|
|
*/
|
|
dash?: string;
|
|
/**
|
|
* The HLS manifest for the video.
|
|
*/
|
|
hls?: string;
|
|
}
|
|
/**
|
|
* Specifies a detailed status for a video. If the `state` is `inprogress` or
|
|
* `error`, the `step` field returns `encoding` or `manifest`. If the `state` is
|
|
* `inprogress`, `pctComplete` returns a number between 0 and 100 to indicate the
|
|
* approximate percent of completion. If the `state` is `error`, `errorReasonCode`
|
|
* and `errorReasonText` provide additional details.
|
|
*/
|
|
interface Status {
|
|
/**
|
|
* Specifies why the video failed to encode. This field is empty if the video is
|
|
* not in an `error` state. Preferred for programmatic use.
|
|
*/
|
|
errorReasonCode?: string;
|
|
/**
|
|
* Specifies why the video failed to encode using a human readable error message in
|
|
* English. This field is empty if the video is not in an `error` state.
|
|
*/
|
|
errorReasonText?: string;
|
|
/**
|
|
* Indicates the size of the entire upload in bytes. The value must be a
|
|
* non-negative integer.
|
|
*/
|
|
pctComplete?: string;
|
|
/**
|
|
* Specifies the processing status for all quality levels for a video.
|
|
*/
|
|
state?: 'pendingupload' | 'downloading' | 'queued' | 'inprogress' | 'ready' | 'error';
|
|
}
|
|
}
|
|
export interface StreamCreateParams {
|
|
/**
|
|
* Path param: The account identifier tag.
|
|
*/
|
|
account_id: string;
|
|
/**
|
|
* Body param:
|
|
*/
|
|
body: unknown;
|
|
/**
|
|
* Header param: Specifies the TUS protocol version. This value must be included in
|
|
* every upload request. Notes: The only supported version of TUS protocol is
|
|
* 1.0.0.
|
|
*/
|
|
'Tus-Resumable': '1.0.0';
|
|
/**
|
|
* Header param: Indicates the size of the entire upload in bytes. The value must
|
|
* be a non-negative integer.
|
|
*/
|
|
'Upload-Length': number;
|
|
/**
|
|
* Query param: Provisions a URL to let your end users upload videos directly to
|
|
* Cloudflare Stream without exposing your API token to clients.
|
|
*/
|
|
direct_user?: boolean;
|
|
/**
|
|
* Header param: A user-defined identifier for the media creator.
|
|
*/
|
|
'Upload-Creator'?: string;
|
|
/**
|
|
* Header param: Comma-separated key-value pairs following the TUS protocol
|
|
* specification. Values are Base-64 encoded. Supported keys: `name`,
|
|
* `requiresignedurls`, `allowedorigins`, `thumbnailtimestamppct`, `watermark`,
|
|
* `scheduleddeletion`, `maxdurationseconds`.
|
|
*/
|
|
'Upload-Metadata'?: string;
|
|
}
|
|
export interface StreamListParams {
|
|
/**
|
|
* Path param: The account identifier tag.
|
|
*/
|
|
account_id: string;
|
|
/**
|
|
* Query param: Lists videos in ascending order of creation.
|
|
*/
|
|
asc?: boolean;
|
|
/**
|
|
* Query param: A user-defined identifier for the media creator.
|
|
*/
|
|
creator?: string;
|
|
/**
|
|
* Query param: Lists videos created before the specified date.
|
|
*/
|
|
end?: string;
|
|
/**
|
|
* Query param: Includes the total number of videos associated with the submitted
|
|
* query parameters.
|
|
*/
|
|
include_counts?: boolean;
|
|
/**
|
|
* Query param: Searches over the `name` key in the `meta` field. This field can be
|
|
* set with or after the upload request.
|
|
*/
|
|
search?: string;
|
|
/**
|
|
* Query param: Lists videos created after the specified date.
|
|
*/
|
|
start?: string;
|
|
/**
|
|
* Query param: Specifies the processing status for all quality levels for a video.
|
|
*/
|
|
status?: 'pendingupload' | 'downloading' | 'queued' | 'inprogress' | 'ready' | 'error';
|
|
/**
|
|
* Query param: Specifies whether the video is `vod` or `live`.
|
|
*/
|
|
type?: string;
|
|
}
|
|
export interface StreamDeleteParams {
|
|
/**
|
|
* The account identifier tag.
|
|
*/
|
|
account_id: string;
|
|
}
|
|
export interface StreamEditParams {
|
|
/**
|
|
* Path param: The account identifier tag.
|
|
*/
|
|
account_id: string;
|
|
/**
|
|
* Body param: Lists the origins allowed to display the video. Enter allowed origin
|
|
* domains in an array and use `*` for wildcard subdomains. Empty arrays allow the
|
|
* video to be viewed on any origin.
|
|
*/
|
|
allowedOrigins?: Array<AllowedOriginsParam>;
|
|
/**
|
|
* Body param: A user-defined identifier for the media creator.
|
|
*/
|
|
creator?: string;
|
|
/**
|
|
* Body param: The maximum duration in seconds for a video upload. Can be set for a
|
|
* video that is not yet uploaded to limit its duration. Uploads that exceed the
|
|
* specified duration will fail during processing. A value of `-1` means the value
|
|
* is unknown.
|
|
*/
|
|
maxDurationSeconds?: number;
|
|
/**
|
|
* Body param: A user modifiable key-value store used to reference other systems of
|
|
* record for managing videos.
|
|
*/
|
|
meta?: unknown;
|
|
/**
|
|
* Body param: Indicates whether the video can be a accessed using the UID. When
|
|
* set to `true`, a signed token must be generated with a signing key to view the
|
|
* video.
|
|
*/
|
|
requireSignedURLs?: boolean;
|
|
/**
|
|
* Body param: Indicates the date and time at which the video will be deleted. Omit
|
|
* the field to indicate no change, or include with a `null` value to remove an
|
|
* existing scheduled deletion. If specified, must be at least 30 days from upload
|
|
* time.
|
|
*/
|
|
scheduledDeletion?: string;
|
|
/**
|
|
* Body param: The timestamp for a thumbnail image calculated as a percentage value
|
|
* of the video's duration. To convert from a second-wise timestamp to a
|
|
* percentage, divide the desired timestamp by the total duration of the video. If
|
|
* this value is not set, the default thumbnail image is taken from 0s of the
|
|
* video.
|
|
*/
|
|
thumbnailTimestampPct?: number;
|
|
/**
|
|
* Body param: The date and time when the video upload URL is no longer valid for
|
|
* direct user uploads.
|
|
*/
|
|
uploadExpiry?: string;
|
|
}
|
|
export interface StreamGetParams {
|
|
/**
|
|
* The account identifier tag.
|
|
*/
|
|
account_id: string;
|
|
}
|
|
export declare namespace Stream {
|
|
export { type AllowedOrigins as AllowedOrigins, type Video as Video, VideosSinglePage as VideosSinglePage, type StreamCreateParams as StreamCreateParams, type StreamListParams as StreamListParams, type StreamDeleteParams as StreamDeleteParams, type StreamEditParams as StreamEditParams, type StreamGetParams as StreamGetParams, };
|
|
export { AudioTracks as AudioTracks, type Audio as Audio, type AudioTrackDeleteResponse as AudioTrackDeleteResponse, AudioSinglePage as AudioSinglePage, type AudioTrackDeleteParams as AudioTrackDeleteParams, type AudioTrackCopyParams as AudioTrackCopyParams, type AudioTrackEditParams as AudioTrackEditParams, type AudioTrackGetParams as AudioTrackGetParams, };
|
|
export { Videos as Videos, type VideoStorageUsageResponse as VideoStorageUsageResponse, type VideoStorageUsageParams as VideoStorageUsageParams, };
|
|
export { ClipResource as ClipResource, type Clip as Clip, type ClipCreateParams as ClipCreateParams };
|
|
export { Copy as Copy, type CopyCreateParams as CopyCreateParams };
|
|
export { DirectUpload as DirectUpload, type DirectUploadCreateResponse as DirectUploadCreateResponse, type DirectUploadCreateParams as DirectUploadCreateParams, };
|
|
export { type Keys as Keys, type KeyDeleteResponse as KeyDeleteResponse, type KeyGetResponse as KeyGetResponse, KeyGetResponsesSinglePage as KeyGetResponsesSinglePage, type KeyCreateParams as KeyCreateParams, type KeyDeleteParams as KeyDeleteParams, type KeyGetParams as KeyGetParams, };
|
|
export { LiveInputs as LiveInputs, type LiveInput as LiveInput, type LiveInputListResponse as LiveInputListResponse, type LiveInputCreateParams as LiveInputCreateParams, type LiveInputUpdateParams as LiveInputUpdateParams, type LiveInputListParams as LiveInputListParams, type LiveInputDeleteParams as LiveInputDeleteParams, type LiveInputGetParams as LiveInputGetParams, };
|
|
export { Watermarks as Watermarks, type Watermark as Watermark, type WatermarkDeleteResponse as WatermarkDeleteResponse, WatermarksSinglePage as WatermarksSinglePage, type WatermarkCreateParams as WatermarkCreateParams, type WatermarkListParams as WatermarkListParams, type WatermarkDeleteParams as WatermarkDeleteParams, type WatermarkGetParams as WatermarkGetParams, };
|
|
export { Webhooks as Webhooks, type WebhookUpdateResponse as WebhookUpdateResponse, type WebhookDeleteResponse as WebhookDeleteResponse, type WebhookGetResponse as WebhookGetResponse, type WebhookUpdateParams as WebhookUpdateParams, type WebhookDeleteParams as WebhookDeleteParams, type WebhookGetParams as WebhookGetParams, };
|
|
export { Captions as Captions, type Caption as Caption, CaptionsSinglePage as CaptionsSinglePage, type CaptionGetParams as CaptionGetParams, };
|
|
export { Downloads as Downloads, type DownloadCreateResponse as DownloadCreateResponse, type DownloadDeleteResponse as DownloadDeleteResponse, type DownloadGetResponse as DownloadGetResponse, type DownloadCreateParams as DownloadCreateParams, type DownloadDeleteParams as DownloadDeleteParams, type DownloadGetParams as DownloadGetParams, };
|
|
export { Embed as Embed, type EmbedGetResponse as EmbedGetResponse, type EmbedGetParams as EmbedGetParams };
|
|
export { Token as Token, type TokenCreateResponse as TokenCreateResponse, type TokenCreateParams as TokenCreateParams, };
|
|
}
|
|
//# sourceMappingURL=stream.d.ts.map
|