@vonage/client-sdk-video 2.26.3 → 2.26.5

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 CHANGED
@@ -1,19 +1,19 @@
1
- # OpenTok.js
1
+ # Vonage Video API
2
2
 
3
- [![npm version](https://badge.fury.io/js/%40opentok%2Fclient.svg)](https://badge.fury.io/js/%40opentok%2Fclient)
3
+ [![npm version](https://badge.fury.io/js/%40vonage%2Fclient-sdk-video.svg)](https://badge.fury.io/js/%40vonage%2Fclient-sdk-video)
4
4
 
5
- The OpenTok.js library lets you use OpenTok-powered video sessions on the web.
5
+ The Vonage Video API library lets you use Vonage-powered video sessions on the web.
6
6
 
7
7
  ## Installation
8
8
 
9
9
  ```sh
10
- yarn add @opentok/client
10
+ yarn add @vonage/client-sdk-video
11
11
  ```
12
12
 
13
13
  or
14
14
 
15
15
  ```sh
16
- npm install --save @opentok/client
16
+ npm install --save @vonage/client-sdk-video
17
17
  ```
18
18
 
19
19
  ## Usage
@@ -25,11 +25,11 @@ The library is bundled as a standalone UMD module so it is CommonJS compatible.
25
25
  Create your application file `app.js`:
26
26
 
27
27
  ```js
28
- const OT = require('@opentok/client');
28
+ const OT = require('@vonage/client-sdk-video');
29
29
  const publisher = OT.initPublisher();
30
30
  ```
31
31
 
32
- Bundle the application with your favourite bundler. For browserify just run:
32
+ Bundle the application with your favorite bundler. For browserify just run:
33
33
 
34
34
  ```sh
35
35
  browserify app.js > bundle.js
@@ -50,14 +50,14 @@ Include the `dist/js/opentok.min.js` script in your webpage.
50
50
  Then use the `OT` object exposed in the global scope.
51
51
 
52
52
  ```html
53
- <script src="node_modules/@opentok/client/dist/js/opentok.min.js"></script>
53
+ <script src="node_modules/@vonage/client-sdk-video/dist/js/opentok.min.js"></script>
54
54
  <script>
55
55
  const publisher = OT.initPublisher();
56
56
  </script>
57
57
  ```
58
58
 
59
- *Note:* OpenTok.js automatically loads CSS and image files from the TokBox CDN when included in a webpage.
59
+ *Note:* Vonage Video API automatically loads CSS and image files from the TokBox CDN when included in a webpage.
60
60
 
61
61
  ## Documentation
62
62
 
63
- The API reference and tutorials can be found at https://tokbox.com/developer/sdks/js/
63
+ The API reference and tutorials can be found at https://developer.vonage.com/en/video/client-sdks/web/overview
@@ -61,7 +61,7 @@ declare namespace OT {
61
61
 
62
62
  export function setProxyUrl(proxyUrl: string): void;
63
63
 
64
- export function getSupportedCodecs(): Promise<{ videoEncoders: ('H264' | 'VP8')[], videoDecoders: ('H264' | 'VP8')[] }>;
64
+ export function getSupportedCodecs(): Promise<{ videoEncoders: ('H264' | 'VP8' | 'VP9')[], videoDecoders: ('H264' | 'VP8' | 'VP9')[] }>;
65
65
 
66
66
  export function hasMediaProcessorSupport(): boolean;
67
67
 
@@ -558,6 +558,7 @@ declare namespace OT {
558
558
  setAudioVolume(volume: number): void;
559
559
  setPreferredFrameRate(frameRate: number): void;
560
560
  setPreferredResolution(resolution: Dimensions): void;
561
+ setAudioMediaProcessorConnector(connector: MediaProcessorConnector | null): Promise<void>;
561
562
  setVideoMediaProcessorConnector(connector: MediaProcessorConnector | null): Promise<void>;
562
563
  subscribeToAudio(value: boolean): void;
563
564
  subscribeToVideo(value: boolean): void;
@@ -590,6 +591,6 @@ declare namespace OT {
590
591
  export function unblockAudio(): Promise<undefined>;
591
592
  }
592
593
 
593
- declare module "@opentok/client" {
594
+ declare module "@vonage/client-sdk-video" {
594
595
  export = OT;
595
596
  }