Skip to content

STREAM-6735: change input types on watermarks and captions to ReadableStream #6467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danlapid merged 1 commit into from
Mar 31, 2026
Merged

STREAM-6735: change input types on watermarks and captions to ReadableStream #6467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions types/defines/stream.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,14 +375,13 @@ interface StreamScopedCaptions {
* Uploads the caption or subtitle file to the endpoint for a specific BCP47 language.
* One caption or subtitle file per language is allowed.
* @param language The BCP 47 language tag for the caption or subtitle.
* @param file The caption or subtitle file to upload.
* @param input The caption or subtitle stream to upload.
* @returns The created caption entry.
* @throws {NotFoundError} if the video is not found
* @throws {BadRequestError} if the language or file is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {InternalError} if an unexpected error occurs
*/
upload(language: string, file: File): Promise<StreamCaption>;
upload(language: string, input: ReadableStream): Promise<StreamCaption>;
/**
* Generate captions or subtitles for the provided language via AI.
* @param language The BCP 47 language tag to generate.
Expand Down Expand Up @@ -461,17 +460,16 @@ interface StreamVideos {
interface StreamWatermarks {
/**
* Generate a new watermark profile
* @param file The image file to upload
* @param input The image stream to upload
* @param params The watermark creation parameters.
* @returns The created watermark profile.
* @throws {BadRequestError} if the parameters are invalid
* @throws {InvalidURLError} if the URL is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {TooManyWatermarksError} if the number of allowed watermarks is reached
* @throws {InternalError} if an unexpected error occurs
*/
generate(
file: File,
input: ReadableStream,
params: StreamWatermarkCreateParams
): Promise<StreamWatermark>;
/**
Expand All @@ -481,7 +479,6 @@ interface StreamWatermarks {
* @returns The created watermark profile.
* @throws {BadRequestError} if the parameters are invalid
* @throws {InvalidURLError} if the URL is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {TooManyWatermarksError} if the number of allowed watermarks is reached
* @throws {InternalError} if an unexpected error occurs
*/
Expand Down
11 changes: 4 additions & 7 deletions types/generated-snapshot/experimental/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14037,14 +14037,13 @@ interface StreamScopedCaptions {
* Uploads the caption or subtitle file to the endpoint for a specific BCP47 language.
* One caption or subtitle file per language is allowed.
* @param language The BCP 47 language tag for the caption or subtitle.
* @param file The caption or subtitle file to upload.
* @param input The caption or subtitle stream to upload.
* @returns The created caption entry.
* @throws {NotFoundError} if the video is not found
* @throws {BadRequestError} if the language or file is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {InternalError} if an unexpected error occurs
*/
upload(language: string, file: File): Promise<StreamCaption>;
upload(language: string, input: ReadableStream): Promise<StreamCaption>;
/**
* Generate captions or subtitles for the provided language via AI.
* @param language The BCP 47 language tag to generate.
Expand Down Expand Up @@ -14120,17 +14119,16 @@ interface StreamVideos {
interface StreamWatermarks {
/**
* Generate a new watermark profile
* @param file The image file to upload
* @param input The image stream to upload
* @param params The watermark creation parameters.
* @returns The created watermark profile.
* @throws {BadRequestError} if the parameters are invalid
* @throws {InvalidURLError} if the URL is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {TooManyWatermarksError} if the number of allowed watermarks is reached
* @throws {InternalError} if an unexpected error occurs
*/
generate(
file: File,
input: ReadableStream,
params: StreamWatermarkCreateParams,
): Promise<StreamWatermark>;
/**
Expand All @@ -14140,7 +14138,6 @@ interface StreamWatermarks {
* @returns The created watermark profile.
* @throws {BadRequestError} if the parameters are invalid
* @throws {InvalidURLError} if the URL is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {TooManyWatermarksError} if the number of allowed watermarks is reached
* @throws {InternalError} if an unexpected error occurs
*/
Expand Down
11 changes: 4 additions & 7 deletions types/generated-snapshot/experimental/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13994,14 +13994,13 @@ export interface StreamScopedCaptions {
* Uploads the caption or subtitle file to the endpoint for a specific BCP47 language.
* One caption or subtitle file per language is allowed.
* @param language The BCP 47 language tag for the caption or subtitle.
* @param file The caption or subtitle file to upload.
* @param input The caption or subtitle stream to upload.
* @returns The created caption entry.
* @throws {NotFoundError} if the video is not found
* @throws {BadRequestError} if the language or file is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {InternalError} if an unexpected error occurs
*/
upload(language: string, file: File): Promise<StreamCaption>;
upload(language: string, input: ReadableStream): Promise<StreamCaption>;
/**
* Generate captions or subtitles for the provided language via AI.
* @param language The BCP 47 language tag to generate.
Expand Down Expand Up @@ -14077,17 +14076,16 @@ export interface StreamVideos {
export interface StreamWatermarks {
/**
* Generate a new watermark profile
* @param file The image file to upload
* @param input The image stream to upload
* @param params The watermark creation parameters.
* @returns The created watermark profile.
* @throws {BadRequestError} if the parameters are invalid
* @throws {InvalidURLError} if the URL is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {TooManyWatermarksError} if the number of allowed watermarks is reached
* @throws {InternalError} if an unexpected error occurs
*/
generate(
file: File,
input: ReadableStream,
params: StreamWatermarkCreateParams,
): Promise<StreamWatermark>;
/**
Expand All @@ -14097,7 +14095,6 @@ export interface StreamWatermarks {
* @returns The created watermark profile.
* @throws {BadRequestError} if the parameters are invalid
* @throws {InvalidURLError} if the URL is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {TooManyWatermarksError} if the number of allowed watermarks is reached
* @throws {InternalError} if an unexpected error occurs
*/
Expand Down
11 changes: 4 additions & 7 deletions types/generated-snapshot/latest/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13312,14 +13312,13 @@ interface StreamScopedCaptions {
* Uploads the caption or subtitle file to the endpoint for a specific BCP47 language.
* One caption or subtitle file per language is allowed.
* @param language The BCP 47 language tag for the caption or subtitle.
* @param file The caption or subtitle file to upload.
* @param input The caption or subtitle stream to upload.
* @returns The created caption entry.
* @throws {NotFoundError} if the video is not found
* @throws {BadRequestError} if the language or file is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {InternalError} if an unexpected error occurs
*/
upload(language: string, file: File): Promise<StreamCaption>;
upload(language: string, input: ReadableStream): Promise<StreamCaption>;
/**
* Generate captions or subtitles for the provided language via AI.
* @param language The BCP 47 language tag to generate.
Expand Down Expand Up @@ -13395,17 +13394,16 @@ interface StreamVideos {
interface StreamWatermarks {
/**
* Generate a new watermark profile
* @param file The image file to upload
* @param input The image stream to upload
* @param params The watermark creation parameters.
* @returns The created watermark profile.
* @throws {BadRequestError} if the parameters are invalid
* @throws {InvalidURLError} if the URL is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {TooManyWatermarksError} if the number of allowed watermarks is reached
* @throws {InternalError} if an unexpected error occurs
*/
generate(
file: File,
input: ReadableStream,
params: StreamWatermarkCreateParams,
): Promise<StreamWatermark>;
/**
Expand All @@ -13415,7 +13413,6 @@ interface StreamWatermarks {
* @returns The created watermark profile.
* @throws {BadRequestError} if the parameters are invalid
* @throws {InvalidURLError} if the URL is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {TooManyWatermarksError} if the number of allowed watermarks is reached
* @throws {InternalError} if an unexpected error occurs
*/
Expand Down
11 changes: 4 additions & 7 deletions types/generated-snapshot/latest/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13269,14 +13269,13 @@ export interface StreamScopedCaptions {
* Uploads the caption or subtitle file to the endpoint for a specific BCP47 language.
* One caption or subtitle file per language is allowed.
* @param language The BCP 47 language tag for the caption or subtitle.
* @param file The caption or subtitle file to upload.
* @param input The caption or subtitle stream to upload.
* @returns The created caption entry.
* @throws {NotFoundError} if the video is not found
* @throws {BadRequestError} if the language or file is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {InternalError} if an unexpected error occurs
*/
upload(language: string, file: File): Promise<StreamCaption>;
upload(language: string, input: ReadableStream): Promise<StreamCaption>;
/**
* Generate captions or subtitles for the provided language via AI.
* @param language The BCP 47 language tag to generate.
Expand Down Expand Up @@ -13352,17 +13351,16 @@ export interface StreamVideos {
export interface StreamWatermarks {
/**
* Generate a new watermark profile
* @param file The image file to upload
* @param input The image stream to upload
* @param params The watermark creation parameters.
* @returns The created watermark profile.
* @throws {BadRequestError} if the parameters are invalid
* @throws {InvalidURLError} if the URL is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {TooManyWatermarksError} if the number of allowed watermarks is reached
* @throws {InternalError} if an unexpected error occurs
*/
generate(
file: File,
input: ReadableStream,
params: StreamWatermarkCreateParams,
): Promise<StreamWatermark>;
/**
Expand All @@ -13372,7 +13370,6 @@ export interface StreamWatermarks {
* @returns The created watermark profile.
* @throws {BadRequestError} if the parameters are invalid
* @throws {InvalidURLError} if the URL is invalid
* @throws {MaxFileSizeError} if the file size is too large
* @throws {TooManyWatermarksError} if the number of allowed watermarks is reached
* @throws {InternalError} if an unexpected error occurs
*/
Expand Down
Loading