Skip to content

Commit

Permalink
Merge pull request #137 from opentok/develop
Browse files Browse the repository at this point in the history
v2.2.0 -- audioSource/videoSource options, Node module updates
  • Loading branch information
jeffswartz authored Apr 21, 2020
2 parents 9d1910e + deca975 commit adaba87
Show file tree
Hide file tree
Showing 7 changed files with 271 additions and 235 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ The `OTNetworkTest()` constructor includes the following parameters:
The `sessionInfo` parameter is required.

* `options` --The `options` parameter is an object containing the following properties,
both of which are optional:
each of which are optional:

* `audioOnly` (Boolean) -- Set this property to `true` to run audio-only tests.

Expand All @@ -217,6 +217,24 @@ The `OTNetworkTest()` constructor includes the following parameters:

Setting a lower timeout duration may result in less accurate results, including MOS ratings.

* `audioSource` (String) -- The ID of the audio input device (such as a microphone)
to be used by the test publisher. You can obtain a list of available devices,
including audio input devices, by calling the `OT.getDevices()` method.

You may want to set this to have the OpenTok Network Test use the same device that
will be used in the real OpenTok session. This way, the test prompts the end user
to grant permission to the correct device. Note that changing the audio device may not
influence the quality test score.

* `videoSource` (String) -- The ID of the video input device (such as a camera)
to be used by the test publisher. You can obtain a list of available devices,
including audio input devices, by calling the `OT.getDevices()` method.

You may want to set this to have the OpenTok Network Test use the same device that
will be used in the real OpenTok session. This way, the test prompts the end user
to grant permission to the correct device. Note that changing the video device may not
influence the quality test score.

The `options` parameter is optional.

The constructor throws an Error object with a `message` property and a `name` property. The
Expand Down
71 changes: 49 additions & 22 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "opentok-network-test-js",
"version": "2.1.0",
"version": "2.2.0",
"description": "Precall network test for applications using the OpenTok platform.",
"main": "dist/NetworkTest/index.js",
"types": "dist/NetworkTest/index.d.ts",
Expand Down
Loading

0 comments on commit adaba87

Please sign in to comment.