Interface StreamVideoHandle

captions

downloads

id

delete

• delete(): Promise<void>

  Deletes a video and its copies from Cloudflare Stream.

  Returns Promise<void>

  A promise that resolves when deletion completes.

  Throws

  if the video is not found

  Throws

  if an unexpected error occurs

details

• details(): Promise<StreamVideo>

  Get a full videos details

  Returns Promise<StreamVideo>

  The full video details.

  Throws

  if the video is not found

  Throws

  if an unexpected error occurs

generateToken

• generateToken(): Promise<string>

  Creates a signed URL token for a video.

  Returns Promise<string>

  The signed token that was created.

  Throws

  if the signing key cannot be retrieved or the token cannot be signed

update

• update(params: StreamUpdateVideoParams): Promise<StreamVideo>

  Update details for a single video.

  Parameters

  • params: StreamUpdateVideoParams

    The fields to update for the video.

  Returns Promise<StreamVideo>

  The updated video details.

  Throws

  if the video is not found

  Throws

  if the parameters are invalid

  Throws

  if an unexpected error occurs