Skip to content

Commit

Permalink
Merge pull request #394 from apivideo/typescript-media-stream-compose…
Browse files Browse the repository at this point in the history
…r-fix-documentation

[SDK README - api.video-typescript-media-stream-composer] Fix documentation
  • Loading branch information
olivier-lando authored Sep 26, 2024
2 parents 5cba03b + b19baf7 commit daa56e2
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions sdks/vod/apivideo-typescript-media-stream-composer.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ When you load an image onto the composition, the origin of the image must be the
| mute | boolean | false | Whether the stream should be muted or not |
| hidden | boolean | false | Whether the stream should be hidden or not
| opacity | number | 100 | Opacity of the stream (from 0 to 100) |
| onClick | (streamId: string, event: \{ x: number; y: number; }) => void | undefined | A callback function that will be called when the stream is clicked |
| onClick | (streamId: string, event: ` { x: number; y: number; } `) => void | undefined | A callback function that will be called when the stream is clicked |

**Example (screen capture)**

Expand Down Expand Up @@ -361,11 +361,13 @@ Using delegated upload tokens for authentication is best options when uploading
###### Common options
| Option name | Mandatory | Type | Description |
| ----------: | --------- | ------ | ------------------------------------------------------------------- |
| videoName | no | string | the name of your recorded video (overrides the default "file" name) |
| apiHost | no | string | api.video host (default: ws.api.video) |
| retries | no | number | number of retries when an API call fails (default: 5) |
| Option name | Mandatory | Type | Description |
| ----------: | ------------------ | ------ | ------------------------------------------------------------------- |
| videoName | no | string | the name of your recorded video (overrides the default "file" name) |
| apiHost | no | string | api.video host (default: ws.api.video) |
| retries | no | number | number of retries when an API call fails (default: 5) |
| timeslice | no (default: 5000) | number | The number of milliseconds to record into each Blob. |
**Example**
Expand Down

0 comments on commit daa56e2

Please sign in to comment.