From ca38a22d12d4579eababda82eef99dafc2efef4b Mon Sep 17 00:00:00 2001 From: Christoph Blessing Date: Tue, 16 Jan 2024 16:43:46 +0100 Subject: [PATCH] Update various component readme --- src/components/player/readme.md | 6 ++++++ src/components/providers/kaltura/readme.md | 12 ++++++++++++ src/components/providers/vimeo/readme.md | 12 ++++++++++++ 3 files changed, 30 insertions(+) diff --git a/src/components/player/readme.md b/src/components/player/readme.md index fa610f5c..1f9ab5c2 100644 --- a/src/components/player/readme.md +++ b/src/components/player/readme.md @@ -117,6 +117,12 @@ Invoke the seek function on the player. Sometimes seeking starts playing the video. If the player was in paused state, we manually pause again. +#### Parameters + +| Name | Type | Description | +| --------- | -------- | ----------- | +| `seconds` | `number` | | + #### Returns Type: `Promise` diff --git a/src/components/providers/kaltura/readme.md b/src/components/providers/kaltura/readme.md index 17250f95..15e4786e 100644 --- a/src/components/providers/kaltura/readme.md +++ b/src/components/providers/kaltura/readme.md @@ -78,6 +78,12 @@ Call seek on the Kaltura player If the player is not initialized, it will save the function so it can be applied once the player is ready. +#### Parameters + +| Name | Type | Description | +| --------- | -------- | ----------- | +| `seconds` | `number` | | + #### Returns Type: `Promise` @@ -91,6 +97,12 @@ Call setPlaybackRate on the Kaltura player If the player is not initialized, it will save the function so it can be applied once the player is ready. +#### Parameters + +| Name | Type | Description | +| -------------- | -------- | ----------- | +| `playbackRate` | `number` | | + #### Returns Type: `Promise` diff --git a/src/components/providers/vimeo/readme.md b/src/components/providers/vimeo/readme.md index f16e108b..8159e408 100644 --- a/src/components/providers/vimeo/readme.md +++ b/src/components/providers/vimeo/readme.md @@ -76,6 +76,12 @@ Call seek on the Vimeo player If the player is not initialized, it will save the function so it can be applied once the player is ready. +#### Parameters + +| Name | Type | Description | +| --------- | -------- | ----------- | +| `seconds` | `number` | | + #### Returns Type: `Promise` @@ -89,6 +95,12 @@ Call setPlaybackRate on the Vimeo player If the player is not initialized, it will save the function so it can be applied once the player is ready. +#### Parameters + +| Name | Type | Description | +| -------------- | -------- | ----------- | +| `playbackRate` | `number` | | + #### Returns Type: `Promise`