From 4773d3e42238c0e605fac2b1b250f66386c47296 Mon Sep 17 00:00:00 2001 From: olivierapivideo Date: Fri, 10 Nov 2023 12:54:16 +0000 Subject: [PATCH] Add documentation CI --- .../sdks/vod/apivideo-typescript-uploader.md | 23 ++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/templates/documentation/sdks/vod/apivideo-typescript-uploader.md b/templates/documentation/sdks/vod/apivideo-typescript-uploader.md index 64386a02..02690df7 100644 --- a/templates/documentation/sdks/vod/apivideo-typescript-uploader.md +++ b/templates/documentation/sdks/vod/apivideo-typescript-uploader.md @@ -1,3 +1,7 @@ + --- title: api.video TypeScript video uploader meta: @@ -5,6 +9,7 @@ meta: --- # api.video TypeScript video uploader +{% include "_partials/view-on-github-button.md" link: "https://github.com/apivideo/test-sdk-documentation-update" %} [api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app. @@ -198,6 +203,11 @@ An onProgress event contains the following attributes: - currentChunk (number): index of the chunk being uploaded - currentChunkUploadedBytes (number): number of bytes uploaded for the current chunk +#### `cancel()` + +The cancel() method cancels the upload. It takes no parameter. + + **Example** ```javascript @@ -325,6 +335,7 @@ The onProgress() method let you defined an upload progress listener. It takes a An onProgress event contains the following attributes: - uploadedBytes (number): total number of bytes uploaded for this upload - totalBytes (number): total size of the file +- part (number): index of the part being uploaded **Example** @@ -334,9 +345,14 @@ An onProgress event contains the following attributes: uploader.onProgress((event) => { console.log(`total number of bytes uploaded for this upload: ${event.uploadedBytes}.`); console.log(`total size of the file: ${event.totalBytes}.`); + console.log(`current part: ${event.part}.`); }); ``` +#### `cancel()` + +The cancel() method cancels the upload. It takes no parameter. + #### `onPlayable()` The onPlayable() method let you defined a listener that will be called when the video is playable. It takes a callback function with one parameter: the `video` object returned by the API. @@ -354,4 +370,9 @@ The onPlayable() method let you defined a listener that will be called when the document.getElementById('player-container').innerHTML = v.assets.iframe; }); -``` \ No newline at end of file +``` + + +## Static wrapper + +For situations where managing object instances is impractical, consider using the [UploaderStaticWrapper](https://github.com/apivideo/api.video-typescript-uploader/blob/main/doc/UploaderStaticWrapper.md) class, which offers static method equivalents for all functionalities. \ No newline at end of file