diff --git a/README.md b/README.md index 32fbf2a..2b73a82 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,8 @@ - [Define your own controls](#define-your-own-controls) - -## - + ## Project description 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 | Property | Mandatory | Type | Description | Default | | ------------------- | ------------------ | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------- | -| video | **yes** | `{id: string;live?: boolean; token?: string;}` | `id`: id of the video to play
`token` (optional): secret video token
`live` (optional): true for live videos | | -| style | no | React.CSSProperties | CSS style to apply to the player container | `{}` | +| video | **yes** | `{id: string;live?: boolean; token?: string;}` | `id`: id of the video to play
`token` (optional): secret video token
`live` (optional): true for live videos | | +| style | no | React.CSSProperties | CSS style to apply to the player container | {} | | autoplay | no | boolean | Define if the video should start playing as soon as it is loaded | false | | muted | no | boolean | The video is muted | false | -| metadata | no | `{ [key: string]: string }` | Object containing [metadata](https://api.video/blog/tutorials/dynamic-metadata/) (see **example** below) | `{}` | +| metadata | no | `{ [key: string]: string }` | Object containing [metadata](https://api.video/blog/tutorials/dynamic-metadata/) (see **example** below) | {} | | hidePoster | no | boolean | Weither if the poster image displayed before the first play of the video should be hidden | false | | chromeless | no | boolean | Chromeless mode: all controls are hidden | false | | 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 | responsive | no | boolean | Weither if the player shoulb be responsive. See below [responsiveness](#responsiveness) | false | | videoStyleObjectFit | no | "contain" \| "cover" \| "fill" \| "none" \| "scale-down" | The `object-fit` CSS value of the video tag | undefined | | videoStyleTransform | no | string | The `transform` CSS value of the video tag (examples: "rotateY(180deg)") | undefined | -| ads | no | `{adTagUrl: string}` | see below [ads](#ads) | | +| ads | no | {adTagUrl: string} | see below [ads](#ads) | | | customDomain | no | string | if you've enabled Custom Domains for your account, the complete 'embed' domain (eg. embed.mydomain.com) | | 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 |