Skip to content

Commit 213c3b4

Browse files
committed
Merge pull request #43 from jeffswartz/v2.2-documentation
Updating documentation on API changes.
2 parents d7a8f8a + 9b7fb2d commit 213c3b4

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ applications that run on the JVM. This version of the SDK also includes support
99
with [OpenTok 2.0 archives](http://tokbox.com/#archiving).
1010

1111
If you are updating from a previous version of this SDK, see
12-
[Important changes in v2.2](#important-changes-in-v22).
12+
[Important changes since v2.2.0](#important-changes-since-v220).
1313

1414

1515
# Installation
@@ -207,7 +207,18 @@ This project is tested on both OpenJDK and Oracle implementations.
207207
See the [Releases](https://github.com/opentok/opentok-java-sdk/releases) page for details
208208
about each release.
209209

210-
# Important changes in v2.2.1
210+
# Important changes since v2.2.0
211+
212+
**Changes in v2.2.1:**
213+
214+
The default setting for the `createSession()` method is to create a session with the media mode set
215+
to relayed. In previous versions of the SDK, the default setting was to use the OpenTok Media Router
216+
(with the media mode set to routed in v2.2.0, or with p2p.preference="disabled" in previous
217+
versions). In a relayed session, clients will attempt to send streams directly between each other
218+
(peer to peer); and if clients cannot connect due to firewall restrictions, the session uses the
219+
OpenTok TURN server to relay audio-video streams.
220+
221+
**Changes in v2.2.0:**
211222

212223
This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
213224
work with OpenTok 1.0 archives.)
@@ -220,12 +231,6 @@ The API_Config class has been removed. Store your OpenTok API key and API secret
220231
The `create_session()` method has been renamed `createSession()`. Also, the method has changed to
221232
take one parameter: a SessionProperties object. You now generate a SessionProperties object using a Builder pattern.
222233

223-
The default setting for the `createSession()` method is to create a session with the media mode set
224-
to relayed. In previous versions of the SDK, the default setting was to use the OpenTok Media Router
225-
(media mode set to routed). In a relayed session, clients will attempt to send streams directly between
226-
each other (peer-to-peer); if clients cannot connect due to firewall restrictions, the session uses the
227-
OpenTok TURN server to relay audio-video streams.
228-
229234
The `generate_token()` method has been renamed `generateToken()`. Also, the method has changed to
230235
take two parameters: the session ID and a TokenOptions object.
231236

0 commit comments

Comments
 (0)