@webex/internal-media-core 0.0.12-beta → 0.0.14-beta
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 +2 -78
- package/dist/cjs/index.js +22774 -0
- package/dist/esm/index.js +438 -125
- package/dist/types/MediaConnection/MediaConnection.d.ts.map +1 -1
- package/dist/types/MediaConnection/MultistreamRoapMediaConnection.d.ts.map +1 -1
- package/dist/types/MediaConnection/MultistreamRoapMediaConnection.test.d.ts +2 -0
- package/dist/types/MediaConnection/MultistreamRoapMediaConnection.test.d.ts.map +1 -0
- package/dist/types/MediaConnection/errors/IceGatheringError.d.ts +10 -0
- package/dist/types/MediaConnection/errors/IceGatheringError.d.ts.map +1 -0
- package/dist/types/MediaConnection/errors/MediaConnectionError.d.ts +10 -0
- package/dist/types/MediaConnection/errors/MediaConnectionError.d.ts.map +1 -0
- package/dist/types/MediaConnection/errors/SdpAnswerHandlingError.d.ts +10 -0
- package/dist/types/MediaConnection/errors/SdpAnswerHandlingError.d.ts.map +1 -0
- package/dist/types/MediaConnection/errors/SdpError.d.ts +10 -0
- package/dist/types/MediaConnection/errors/SdpError.d.ts.map +1 -0
- package/dist/types/MediaConnection/errors/SdpOfferCreationError.d.ts +10 -0
- package/dist/types/MediaConnection/errors/SdpOfferCreationError.d.ts.map +1 -0
- package/dist/types/MediaConnection/errors/SdpOfferHandlingError.d.ts +10 -0
- package/dist/types/MediaConnection/errors/SdpOfferHandlingError.d.ts.map +1 -0
- package/dist/types/MediaConnection/errors/constants.d.ts +9 -0
- package/dist/types/MediaConnection/errors/constants.d.ts.map +1 -0
- package/dist/types/MediaConnection/errors/index.d.ts +9 -0
- package/dist/types/MediaConnection/errors/index.d.ts.map +1 -0
- package/dist/types/MediaConnection/errors/index.test.d.ts +2 -0
- package/dist/types/MediaConnection/errors/index.test.d.ts.map +1 -0
- package/dist/types/MediaConnection/eventTypes.d.ts +2 -2
- package/dist/types/MediaConnection/eventTypes.d.ts.map +1 -1
- package/dist/types/MediaConnection/index.d.ts +3 -1
- package/dist/types/MediaConnection/index.d.ts.map +1 -1
- package/dist/types/MediaConnection/utils.d.ts +2 -2
- package/dist/types/MediaConnection/utils.d.ts.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,80 +1,4 @@
|
|
|
1
1
|

|
|
2
|
-
#
|
|
2
|
+
# internal-media-core
|
|
3
3
|
|
|
4
|
-
>
|
|
5
|
-
|
|
6
|
-
> https://confluence-eng-gpk2.cisco.com/conf/display/WBXT/Webrtc+Media+Core+Framework
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
## Developing
|
|
10
|
-
|
|
11
|
-
```shell
|
|
12
|
-
git clone https://sqbu-github.cisco.com/WebExSquared/webrtc-media-core
|
|
13
|
-
cd webrtc-media-core/
|
|
14
|
-
yarn install
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
### Building
|
|
18
|
-
|
|
19
|
-
If your project needs some additional steps for the developer to build the
|
|
20
|
-
project after some code changes, state them here:
|
|
21
|
-
|
|
22
|
-
```shell
|
|
23
|
-
yarn build
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
### Testing
|
|
27
|
-
|
|
28
|
-
```shell
|
|
29
|
-
yarn test
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
### Testing in debug mode
|
|
33
|
-
|
|
34
|
-
```shell
|
|
35
|
-
yarn test:debug
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
1. After the above command, open up http://localhost:9876/debug.html in browser and do inspect element. (Note - HTTP & not HTTPS)
|
|
39
|
-
1. Here, the test files would be available in sources tab, where debuggers can be set and refresh the page to run tests again.
|
|
40
|
-
1. It also looks out for changes. So, whenever the test file changes, the test cases re-run in terminal and latest changes reflect in debug.html upon page refresh.
|
|
41
|
-
|
|
42
|
-
### Integration Testing
|
|
43
|
-
|
|
44
|
-
```shell
|
|
45
|
-
yarn run test:integration
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
### Integration Testing with Sauce Labs
|
|
49
|
-
|
|
50
|
-
1. Add ```.env``` file in your project.
|
|
51
|
-
```shell
|
|
52
|
-
#.env
|
|
53
|
-
# Update your SAUCE_USERNAME and SAUCE_ACCESS_KEY environment variables below
|
|
54
|
-
SAUCE_USERNAME="YOUR_SAUCE_USERNAME"
|
|
55
|
-
SAUCE_ACCESS_KEY="YOUR_SAUCE_ACCESS_KEY"
|
|
56
|
-
```
|
|
57
|
-
2. Make sure your `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables are set in ```.env``` file.
|
|
58
|
-
|
|
59
|
-
`SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` are credentials from your [SauceLabs account](https://docs.saucelabs.com/basics/environment-variables/)
|
|
60
|
-
|
|
61
|
-
3. Run the below command in the terminal.
|
|
62
|
-
```shell
|
|
63
|
-
SAUCE=true yarn run test:integration
|
|
64
|
-
```
|
|
65
|
-
4. Sauce labs link in the results or Open your Sauce labs and filter test with your name and see the test case.
|
|
66
|
-
|
|
67
|
-
### Deploying / Publishing
|
|
68
|
-
|
|
69
|
-
In case there's some step you have to take that publishes this project to a
|
|
70
|
-
server, this is the right time to state it.
|
|
71
|
-
|
|
72
|
-
```shell
|
|
73
|
-
yarn release
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
### Contribute
|
|
77
|
-
|
|
78
|
-
Thank you for considering contributing to this repository!
|
|
79
|
-
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more details about testing, building the packages
|
|
80
|
-
and submitting pull requests for suggested changes. Pull requests welcome.
|
|
4
|
+
> This package is for webex internal conception only
|