You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,9 +31,8 @@
31
31
-[Define your own controls](#define-your-own-controls)
32
32
33
33
<!--</documentation_excluded>-->
34
-
35
-
## <!--<documentation_only>
36
-
34
+
<!--<documentation_only>
35
+
---
37
36
title: api.video React Player component
38
37
meta:
39
38
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
45
44
[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.
46
45
47
46
</documentation_only>-->
48
-
47
+
49
48
## Project description
50
49
51
50
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
| 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 |{} |
88
87
| autoplay | no | boolean | Define if the video should start playing as soon as it is loaded | false |
89
88
| 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) |{} |
91
90
| hidePoster | no | boolean | Weither if the poster image displayed before the first play of the video should be hidden | false |
92
91
| chromeless | no | boolean | Chromeless mode: all controls are hidden | false |
93
92
| 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
100
99
| responsive | no | boolean | Weither if the player shoulb be responsive. See below [responsiveness](#responsiveness)| false |
101
100
| videoStyleObjectFit | no | "contain" \| "cover" \| "fill" \| "none" \| "scale-down" | The `object-fit` CSS value of the video tag | undefined |
102
101
| 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)||
104
103
| customDomain | no | string | if you've enabled Custom Domains for your account, the complete 'embed' domain (eg. embed.mydomain.com) |
105
104
| 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 |
0 commit comments