Skip to content

Commit 43f7d52

Browse files
committed
Fix doc
1 parent f41227d commit 43f7d52

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,8 @@
3131
- [Define your own controls](#define-your-own-controls)
3232

3333
<!--</documentation_excluded>-->
34-
35-
## <!--<documentation_only>
36-
34+
<!--<documentation_only>
35+
---
3736
title: api.video React Player component
3837
meta:
3938
description: The official api.video React Player component for api.video. [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.
@@ -45,7 +44,7 @@ description: The official api.video React Player component for api.video. [api.v
4544
[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.
4645
4746
</documentation_only>-->
48-
47+
4948
## Project description
5049

5150
The official api.video React Player component.
@@ -83,11 +82,11 @@ The following properties are used to configure the player. The value of each of
8382

8483
| Property | Mandatory | Type | Description | Default |
8584
| ------------------- | ------------------ | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------- |
86-
| video | **yes** | `{id: string;live?: boolean; token?: string;}` | `id`: id of the video to play<br/>`token` (optional): secret video token<br/>`live` (optional): true for live videos | |
87-
| style | no | React.CSSProperties | CSS style to apply to the player container | `{}` |
85+
| video | **yes** | `{id: string;live?: boolean; token?: string;}` | `id`: id of the video to play<br>`token` (optional): secret video token<br>`live` (optional): true for live videos | |
86+
| style | no | React.CSSProperties | CSS style to apply to the player container | {} |
8887
| autoplay | no | boolean | Define if the video should start playing as soon as it is loaded | false |
8988
| muted | no | boolean | The video is muted | false |
90-
| metadata | no | `{ [key: string]: string }` | Object containing [metadata](https://api.video/blog/tutorials/dynamic-metadata/) (see **example** below) | `{}` |
89+
| metadata | no | `{ [key: string]: string }` | Object containing [metadata](https://api.video/blog/tutorials/dynamic-metadata/) (see **example** below) | {} |
9190
| hidePoster | no | boolean | Weither if the poster image displayed before the first play of the video should be hidden | false |
9291
| chromeless | no | boolean | Chromeless mode: all controls are hidden | false |
9392
| loop | no | boolean | Once the video is finished it automatically starts again | false |
@@ -100,7 +99,7 @@ The following properties are used to configure the player. The value of each of
10099
| responsive | no | boolean | Weither if the player shoulb be responsive. See below [responsiveness](#responsiveness) | false |
101100
| videoStyleObjectFit | no | "contain" \| "cover" \| "fill" \| "none" \| "scale-down" | The `object-fit` CSS value of the video tag | undefined |
102101
| videoStyleTransform | no | string | The `transform` CSS value of the video tag (examples: "rotateY(180deg)") | undefined |
103-
| ads | no | `{adTagUrl: string}` | see below [ads](#ads) | |
102+
| ads | no | {adTagUrl: string} | see below [ads](#ads) | |
104103
| customDomain | no | string | if you've enabled Custom Domains for your account, the complete 'embed' domain (eg. embed.mydomain.com) |
105104
| hotkeys | no (default: true) | boolean | if false, deactivate the player's hotkeys to prevent it from capturing focus, which can be beneficial in certain scenarios |
106105

0 commit comments

Comments
 (0)