@100mslive/roomkit-web 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,8 +23,8 @@ import '@100mslive/roomkit-web';
|
|
|
23
23
|
|
|
24
24
|
`hms-prebuilt` accepts the following props:
|
|
25
25
|
|
|
26
|
-
`room-code` (optional if
|
|
27
|
-
- The room code of the room you want to join. You can get the room code from the [100ms dashboard](https://dashboard.100ms.live). This prop can be skipped if the
|
|
26
|
+
`room-code` (optional if room-id and role are being used instead)
|
|
27
|
+
- The room code of the room you want to join. You can get the room code from the [100ms dashboard](https://dashboard.100ms.live). This prop can be skipped if the room-id and role are being provided instead.
|
|
28
28
|
|
|
29
29
|
`logo` (optional)
|
|
30
30
|
- An image URL as a string which is displayed in the preview screen and header.
|
|
@@ -32,11 +32,11 @@ import '@100mslive/roomkit-web';
|
|
|
32
32
|
`auth-token` (optional)
|
|
33
33
|
- This token is room and role specific. It can be copied from the join room modal on the [dashboard](https://dashboard.100ms.live). Read more about it [here](/get-started/v2/get-started/security-and-tokens#auth-token-for-client-sdks).
|
|
34
34
|
|
|
35
|
-
`
|
|
36
|
-
- The room ID of the room you want to join. You can get the room ID from the [dashboard](https://dashboard.100ms.live). It should be specified with the role prop if the room
|
|
35
|
+
`room-id` (optional unless room-code is not being used)
|
|
36
|
+
- The room ID of the room you want to join. You can get the room ID from the [dashboard](https://dashboard.100ms.live). It should be specified with the role prop if the room-code is not being provided.
|
|
37
37
|
|
|
38
|
-
`role` (optional unless
|
|
39
|
-
- A string specifying the role of the peer. Should be specified if the
|
|
38
|
+
`role` (optional unless room-id is specified)
|
|
39
|
+
- A string specifying the role of the peer. Should be specified if the room-id is being used to join the room.
|
|
40
40
|
|
|
41
41
|
`on-join` (optional)
|
|
42
42
|
- A callback function that will be executed after the peer joins the call.
|
|
@@ -50,4 +50,4 @@ import '@100mslive/roomkit-web';
|
|
|
50
50
|
|
|
51
51
|
- `userId` (optional): The user ID to be assigned to the peer.
|
|
52
52
|
|
|
53
|
-
> NOTE: The callbacks on-join and on-leave
|
|
53
|
+
> NOTE: The callbacks on-join and on-leave have to be present on the `window` as of now for them to be triggered.
|