cloudflare/resources/stream/stream.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as AudioTracksAPI from 'cloudflare/resources/stream/audio-tracks';
import * as ClipAPI from 'cloudflare/resources/stream/clip';
import * as CopyAPI from 'cloudflare/resources/stream/copy';
import * as DirectUploadAPI from 'cloudflare/resources/stream/direct-upload';
import * as DownloadsAPI from 'cloudflare/resources/stream/downloads';
import * as EmbedAPI from 'cloudflare/resources/stream/embed';
import * as KeysAPI from 'cloudflare/resources/stream/keys';
import * as TokenAPI from 'cloudflare/resources/stream/token';
import * as VideosAPI from 'cloudflare/resources/stream/videos';
import * as WatermarksAPI from 'cloudflare/resources/stream/watermarks';
import * as WebhooksAPI from 'cloudflare/resources/stream/webhooks';
import * as CaptionsAPI from 'cloudflare/resources/stream/captions/captions';
import * as LiveInputsAPI from 'cloudflare/resources/stream/live-inputs/live-inputs';
import { SinglePage } from 'cloudflare/pagination';
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.
     */
    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.
     */
    list(params: StreamListParams, options?: Core.RequestOptions): Core.PagePromise<VideosSinglePage, Video>;
    /**
     * Deletes a video and its copies from Cloudflare Stream.
     */
    delete(identifier: string, params: StreamDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void>;
    /**
     * Fetches details for a single video.
     */
    get(identifier: string, params: StreamGetParams, options?: Core.RequestOptions): Core.APIPromise<Video>;
}
export declare class VideosSinglePage extends SinglePage<Video> {
}
export type AllowedOrigins = 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;
    /**
     * 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`.
     */
    '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 {
    /**
     * Path param: The account identifier tag.
     */
    account_id: string;
    /**
     * Body param:
     */
    body: unknown;
}
export interface StreamGetParams {
    /**
     * The account identifier tag.
     */
    account_id: string;
}
export declare namespace Stream {
    export import AudioTracks = AudioTracksAPI.AudioTracks;
    export import Audio = AudioTracksAPI.Audio;
    export import AudioTrackDeleteResponse = AudioTracksAPI.AudioTrackDeleteResponse;
    export import AudioTrackGetResponse = AudioTracksAPI.AudioTrackGetResponse;
    export import AudioTrackDeleteParams = AudioTracksAPI.AudioTrackDeleteParams;
    export import AudioTrackCopyParams = AudioTracksAPI.AudioTrackCopyParams;
    export import AudioTrackEditParams = AudioTracksAPI.AudioTrackEditParams;
    export import AudioTrackGetParams = AudioTracksAPI.AudioTrackGetParams;
    export import Videos = VideosAPI.Videos;
    export import VideoStorageUsageResponse = VideosAPI.VideoStorageUsageResponse;
    export import VideoStorageUsageParams = VideosAPI.VideoStorageUsageParams;
    export import ClipResource = ClipAPI.ClipResource;
    export import Clip = ClipAPI.Clip;
    export import ClipCreateParams = ClipAPI.ClipCreateParams;
    export import Copy = CopyAPI.Copy;
    export import CopyCreateParams = CopyAPI.CopyCreateParams;
    export import DirectUpload = DirectUploadAPI.DirectUpload;
    export import DirectUploadCreateResponse = DirectUploadAPI.DirectUploadCreateResponse;
    export import DirectUploadCreateParams = DirectUploadAPI.DirectUploadCreateParams;
    export import Keys = KeysAPI.Keys;
    export import KeyDeleteResponse = KeysAPI.KeyDeleteResponse;
    export import KeyGetResponse = KeysAPI.KeyGetResponse;
    export import KeyCreateParams = KeysAPI.KeyCreateParams;
    export import KeyDeleteParams = KeysAPI.KeyDeleteParams;
    export import KeyGetParams = KeysAPI.KeyGetParams;
    export import LiveInputs = LiveInputsAPI.LiveInputs;
    export import LiveInput = LiveInputsAPI.LiveInput;
    export import LiveInputListResponse = LiveInputsAPI.LiveInputListResponse;
    export import LiveInputCreateParams = LiveInputsAPI.LiveInputCreateParams;
    export import LiveInputUpdateParams = LiveInputsAPI.LiveInputUpdateParams;
    export import LiveInputListParams = LiveInputsAPI.LiveInputListParams;
    export import LiveInputDeleteParams = LiveInputsAPI.LiveInputDeleteParams;
    export import LiveInputGetParams = LiveInputsAPI.LiveInputGetParams;
    export import Watermarks = WatermarksAPI.Watermarks;
    export import Watermark = WatermarksAPI.Watermark;
    export import WatermarkDeleteResponse = WatermarksAPI.WatermarkDeleteResponse;
    export import WatermarksSinglePage = WatermarksAPI.WatermarksSinglePage;
    export import WatermarkCreateParams = WatermarksAPI.WatermarkCreateParams;
    export import WatermarkListParams = WatermarksAPI.WatermarkListParams;
    export import WatermarkDeleteParams = WatermarksAPI.WatermarkDeleteParams;
    export import WatermarkGetParams = WatermarksAPI.WatermarkGetParams;
    export import Webhooks = WebhooksAPI.Webhooks;
    export import WebhookUpdateResponse = WebhooksAPI.WebhookUpdateResponse;
    export import WebhookDeleteResponse = WebhooksAPI.WebhookDeleteResponse;
    export import WebhookGetResponse = WebhooksAPI.WebhookGetResponse;
    export import WebhookUpdateParams = WebhooksAPI.WebhookUpdateParams;
    export import WebhookDeleteParams = WebhooksAPI.WebhookDeleteParams;
    export import WebhookGetParams = WebhooksAPI.WebhookGetParams;
    export import Captions = CaptionsAPI.Captions;
    export import Caption = CaptionsAPI.Caption;
    export import CaptionGetResponse = CaptionsAPI.CaptionGetResponse;
    export import CaptionGetParams = CaptionsAPI.CaptionGetParams;
    export import Downloads = DownloadsAPI.Downloads;
    export import DownloadCreateResponse = DownloadsAPI.DownloadCreateResponse;
    export import DownloadDeleteResponse = DownloadsAPI.DownloadDeleteResponse;
    export import DownloadGetResponse = DownloadsAPI.DownloadGetResponse;
    export import DownloadCreateParams = DownloadsAPI.DownloadCreateParams;
    export import DownloadDeleteParams = DownloadsAPI.DownloadDeleteParams;
    export import DownloadGetParams = DownloadsAPI.DownloadGetParams;
    export import Embed = EmbedAPI.Embed;
    export import EmbedGetResponse = EmbedAPI.EmbedGetResponse;
    export import EmbedGetParams = EmbedAPI.EmbedGetParams;
    export import Token = TokenAPI.Token;
    export import TokenCreateResponse = TokenAPI.TokenCreateResponse;
    export import TokenCreateParams = TokenAPI.TokenCreateParams;
}
//# sourceMappingURL=stream.d.ts.map