Skip to content

Commit

Permalink
Update various component readme
Browse files Browse the repository at this point in the history
  • Loading branch information
christophblessing committed Jan 16, 2024
1 parent 8e25397 commit ca38a22
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/components/player/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<void>`
Expand Down
12 changes: 12 additions & 0 deletions src/components/providers/kaltura/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<number>`
Expand All @@ -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<number>`
Expand Down
12 changes: 12 additions & 0 deletions src/components/providers/vimeo/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<number>`
Expand All @@ -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<number>`
Expand Down

0 comments on commit ca38a22

Please sign in to comment.