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
{{ message }}
This repository was archived by the owner on Aug 30, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+18-16Lines changed: 18 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@
4
4
5
5
The application available in this repository demonstrates the capabilities of Dolby.io's video call solution for browser applications, built using React.
6
6
7
-
This repository will demonstrate how to develop the core Dolby.io features and will also provide an understanding of how our service works. If you run into problems, the full Dolby.io React SDK documentation can be found at <https://docs.dolby.io/communications-apis/docs/js-overview>
7
+
This repository demonstrates how to develop the core Dolby.io features and also provides an understanding of how our service works. If you run into problems, the full Dolby.io Communications SDK for JavaScript documentation can be found at <https://docs.dolby.io/communications-apis/docs/js-overview>.
8
8
9
-
The application provided allows you to evaluate solutions offered by Dolby.io Comms API. You can download the repository yourself, run the application locally and verify that it meets your requirements. If you are interested in more details about Dolby.io’s video conference call capabilities, more information can be found here:
9
+
The application provided allows you to evaluate solutions offered by Dolby.io Communications APIs. You can download the repository yourself, run the application locally and verify that it meets your requirements. If you are interested in more details about Dolby.io’s video conference call capabilities, more information can be found here:
10
10
<https://dolby.io/products/video-call/>
11
11
12
12
Its scope covers:
@@ -19,11 +19,11 @@ Its scope covers:
19
19
20
20
## Getting Started
21
21
22
-
The steps below will quickly get you started testing Dolby.io’s capabilities
22
+
The steps below will quickly get you started testing Dolby.io’s capabilities.
23
23
24
24
### How to get a Dolby.io account
25
25
26
-
Dolby.io Comms API requires you to create a Dolby.io account.
26
+
Dolby.io Communications APIs requires you to create a Dolby.io account.
27
27
To set it up, you need to go to <https://dashboard.dolby.io/signup/> and complete the form. After confirming your email address, you will be logged in.
28
28
29
29
### Dolby.io dashboard
@@ -34,7 +34,7 @@ From this page <https://dashboard.dolby.io/dashboard/applications/summary> you c
34
34
35
35
### How to obtain access token
36
36
37
-
To run the application, you need to generate a special access token and paste it into the source code of the app. Go to the _Dashboard_, and find the _Launch Demos_ button. On the next screen, will be a token field where you can copy the client access token to your clipboard. The generated token is active for 12 hours.
37
+
To run the application, you need to generate a special access token and paste it into the source code of the app. Go to the _Dashboard_, and find the _Launch Demos_ button. On the next screen, there is a token field where you can copy the client access token to your clipboard. The generated token is active for 12 hours.
38
38
39
39
## How to run the Video Conferencing app
40
40
@@ -44,25 +44,25 @@ Below is a list of steps necessary to run the application locally.
or simply download using the green button on the top of this page and unzip the repository
47
+
or simply download using the green button on the top of this page and unzip the repository.
48
48
49
49
### Install dependencies
50
50
51
-
Open the main directory with the terminal. If you are using [Yarn](https://yarnpkg.com/), install dependencies with command
51
+
Open the main directory with the terminal. If you are using [Yarn](https://yarnpkg.com/), install dependencies with the following command:
52
52
53
53
```bash
54
54
yarn
55
55
```
56
56
57
-
and if you are using [NPM](https://www.npmjs.com/), type command
57
+
and if you are using [NPM](https://www.npmjs.com/), type the following command:
58
58
59
59
```bash
60
60
npm install
61
61
```
62
62
63
63
### Paste the token
64
64
65
-
Open file [src/App.tsx](https://github.com/dolbyio-samples/comms-app-react-videocall/blob/main/src/App.tsx), find and replace `{YOUR_TOKEN}` with your access token string, prepared previously in [this step](#how-to-obtain-access-token). It should look like this:
65
+
Open file [src/App.tsx](./src/App.tsx), find line 14 and replace `{YOUR_TOKEN}` with your access token string, prepared previously in [this step](#how-to-obtain-access-token). It should look like this:
66
66
67
67
```javascript
68
68
return (
@@ -78,7 +78,7 @@ Open file [src/App.tsx](https://github.com/dolbyio-samples/comms-app-react-video
78
78
79
79
### Start the app
80
80
81
-
After installing the dependencies, execute the command
81
+
After installing the dependencies, execute the following command:
82
82
83
83
```bash
84
84
yarn dev
@@ -98,7 +98,7 @@ After printing the appropriate message in the terminal window, open <http://loca
98
98
99
99
#### Base URL configuration
100
100
101
-
In case you need to fully configure the application path (e.g. extend localhost:3000/ to localhost:3000/videoconference/) please add the `/.env.production` file with such content:
101
+
In case you need to fully configure the application path (e.g. extend localhost:3000/ to localhost:3000/videoconference/) please add the `/.env.production` file with the following content:
102
102
103
103
```
104
104
BASE_URL=<YOUR BASE URL PATH>
@@ -108,18 +108,20 @@ Change the BASE_URL environment variable and restart the application.
108
108
109
109
## How to build the Video Conferencing app
110
110
111
-
Follow the steps of installing dependencies & token configuration from "How to run" section
111
+
Follow the steps of installing dependencies & token configuration from the "How to run the Video Conferencing app" section
112
+
113
+
After installing the dependencies, execute the following command:
112
114
113
-
After installing the dependencies, execute the command
114
115
`yarn build`
116
+
115
117
This command generated distribution packages in `/dist` directory.
116
118
117
119
## Known issues & limitations
118
120
119
-
- Speaker device output selection available only on Chrome
121
+
- Speaker selection is available only on Chrome
120
122
- Copy conference link works only for root directories by default
121
-
- In some cases entering conference may take more than 3 seconds
122
-
- On Safari 15.4 and below local user can hear echo
123
+
- In some cases entering a conference may take more than three seconds
124
+
- On Safari 15.4 and below, the local user can hear echo
|`url`| string | - | The conference URL that will be copied to clipboard after clicking. |
10
+
|`tooltipText`?| string | - | The informative text to display inside the Tooltip component.|
11
+
|`successText`?| string | - | The text to display for one second in the Tooltip component after a successful completion of the copy action.|
12
+
|`tooltipPosition`? | TooltipProps['position']| top | The position of the Tooltip element. |
13
+
|`...IconButtonProps`? | Partial(IconButtonProps) | - | Props to pass to the IconButton component. |
14
+
|`testID` ? | string | - | The unique E2E test handler. |
15
+
|`children`? | ReactNode | - | Children prop for labeled copy button - while using children component is rendered as a regular button with share functionalities |
0 commit comments