diff --git a/README.md b/README.md index d53cc7e3..6dce622c 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,38 @@ The `OTSession` component manages the connection to an OpenTok Session. It passe | properties | Object | No | Properties passed into the native publisher instance | eventHandlers | Object<Function> | No | Event handlers passed into native publsiher instance +* **Properties** + * **audioBitrate** (Number) — The desired bitrate for the published audio, in bits per second. The supported range of values is 6,000 - 510,000. (Invalid values are ignored.) Set this value to enable high-quality audio (or to reduce bandwidth usage with lower-quality audio). + The following are recommended settings: + + * **8,000 - 12,000 for narrowband (NB) speech** + * **16,000 - 20,000 for wideband (WB) speech** + * **28,000 - 40,000 for full-band (FB) speech** + * **48,000 - 64,000 for full-band (FB) music** + * **64,000 - 128,000 for full-band (FB) stereo music** + + * **The default value is 40,000.** + + * **audioFallbackEnabled** (Boolean) — Whether to turn on audio fallback or not. + + * **audioTrack** (Boolean) — If this property is set to false, the audio subsystem will not be initialized for the publisher, and setting the publishAudio property will have no effect. If your application does not require the use of audio, it is recommended to set this property rather than use the publishAudio property, which only temporarily disables the audio track. + + * **cameraPosition** (String) - The preferred camera position. When setting this property, if the change is possible, the publisher will use the camera with the specified position. Valid Inputs: 'front' or 'back' + + * **frameRate** (Number) - The desired frame rate, in frames per second, of the video. Valid values are 30, 15, 7, and 1. The published stream will use the closest value supported on the publishing client. The frame rate can differ slightly from the value you set, depending on the device of the client. And the video will only use the desired frame rate if the client configuration supports it. + + * **name** (String) — A string that will be associated with this publisher’s stream. This string is displayed at the bottom of publisher videos and at the bottom of subscriber videos associated with the published stream. If you do not specify a value, the name is set to the device name. + + * **publishAudio** (Boolean) — Whether to publish audio. + + * **publishVideo** (Boolean) — Whether to publish video. + + * **resolution** (String) - The desired resolution of the video. The format of the string is "widthxheight", where the width and height are represented in pixels. Valid values are "1280x720", "640x480", and "320x240". The published video will only use the desired resolution if the client configuration supports it. Some devices and clients do not support each of these resolution settings. + + * **videoTrack** (Boolean) — If this property is set to false, the video subsystem will not be initialized for the publisher, and setting the publishVideo property will have no effect. If your application does not require the use of video, it is recommended to set this property rather than use the publishVideo property, which only temporarily disables the video track. + + + The `OTPublisher` component will initialize a publisher and publish to a specified session upon mounting. To destroy the publisher, unmount the `OTPublisher` component. ```html @@ -191,6 +223,12 @@ Please keep in mind that `OT` is not the same as `OT` in the JS SDK, the `OT` in | properties | Object | No | Properties passed into the native subscriber instance | eventHandlers | Object<Function> | No | Event handlers passed into the native subscriber instance +* **Properties** + * **subscribeToAudio** (Boolean) — Whether to subscribe to audio. + + * **subscribeToVideo** (Boolean) — Whether to subscribe video. + + The `OTSubscriber` component will subscribe to a specified stream from a specified session upon mounting. The `OTSubscriber` component will stop subscribing and unsubscribing when it's unmounting. ## Contributing diff --git a/package-lock.json b/package-lock.json index 8f3b12d8..71ac5dee 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "opentok-react-native", - "version": "0.3.3", + "version": "0.3.4", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index b75c51ac..9d446ea5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "opentok-react-native", - "version": "0.3.3", + "version": "0.3.4", "description": "React Native components for OpenTok iOS and Android SDKs", "main": "src/index.js", "homepage": "www.tokbox.com",