opentok 4.1.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 348ea4d3600d65e0e68b7078f4b694144c1eb03410ef46dccf2b27f235fd4c34
-  data.tar.gz: 900521793c8e747b77b50a081a83328a004df84231a048f6f5b6e07a75d7bbbd
+  metadata.gz: 78dc7ec3b0d8d3097e687cc0e7b76d2c9d18e3969372c54a00e3c4f3c95846ed
+  data.tar.gz: e8c10144c89329205734d7d0dd5c8fb37197c2af0a50401a1d97ec1cbfe9e837
 SHA512:
-  metadata.gz: ac9f2f38462314084442b364b63af518569bc1931ffd70300be797a295303648236c28cb910a88804b0d63cc110194ae30334c7ea1a4e25be7f0ccaa148c676a
-  data.tar.gz: aa8d99ffc987557ed346c3e9188057aa3239d77f88da4d94f09cb39c4283447a27bc0e39da2fff007095a8268bf9b14aed623d7748371a0d3385fa329cb91a2f
+  metadata.gz: 9b481dc1985ffa39e3c371c2d67fc3b6e7b1cdc696db7e21274bea45e0784984facb5cdfdda92bc14f3366af243e8c01f448bc5ddb7cba52e935a8c97bd15694
+  data.tar.gz: f776558162063de46f8e7e4da99032ec771171098f7cc2e4a2c260374061ec0c840d479e530b2efb24f8ad3754f0da95a27c12a24cdd97c0013680ac31e5b5f7

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, dev, beta ]
+  pull_request:
+    branches: [ main, dev, beta ]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7, 3.0]
+        exclude:
+          - os: windows-latest
+            ruby: 3.0
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake spec
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

data/.github/workflows/metrics.yml

@@ -0,0 +1,17 @@
+name: Aggregit
+
+on:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  recordMetrics:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: michaeljolley/aggregit@v1
+      with:
+        githubToken: ${{ secrets.GITHUB_TOKEN }}
+        project_id: ${{ secrets.project_id }}
+        private_key: ${{ secrets.private_key }}
+        client_email: ${{ secrets.client_email }}
+        firebaseDbUrl: ${{ secrets.firebaseDbUrl }}

data/CHANGES.md

@@ -0,0 +1,171 @@
+# 4.5.1
+
+* Fixes issue with uninitialized constant by adding missing `require` statement [#256](https://github.com/opentok/OpenTok-Ruby-SDK/pull/256)
+* Fixes RubyGems info by adding repo link to gemspec [#255](https://github.com/opentok/OpenTok-Ruby-SDK/pull/255)
+
+Thanks to [`@sailor`](https://github.com/sailor) for the contributions! :raised_hands:
+
+# 4.5.0
+
+* Adds support for multiple archives and records feature [#248](https://github.com/opentok/OpenTok-Ruby-SDK/pull/248)
+* Adds Experience Composer functionality [#249](https://github.com/opentok/OpenTok-Ruby-SDK/pull/249)
+* Updates code comments to make explicit support for 1080p resolution for Archive and Broadcast [#246](https://github.com/opentok/OpenTok-Ruby-SDK/pull/246)
+* Updates various other documentation/code comments [#250](https://github.com/opentok/OpenTok-Ruby-SDK/pull/250)
+
+# 4.4.0
+
+* Implements DVR Pause/Resume and HLS Low-Latency options for Broadcasts [#243](https://github.com/opentok/OpenTok-Ruby-SDK/pull/243)
+
+# 4.3.0
+
+* Fixes an issue with `activesupport` [#238](https://github.com/opentok/OpenTok-Ruby-SDK/pull/238)
+* Adds Force Mute feature [#233](https://github.com/opentok/OpenTok-Ruby-SDK/pull/233) and [#237](https://github.com/opentok/OpenTok-Ruby-SDK/pull/237)
+* Adds Listing Live Streaming Broadcasts feature [#236](https://github.com/opentok/OpenTok-Ruby-SDK/pull/236). Thanks [@ihors-livestorm](https://github.com/ihors-livestorm)!
+* Adds Selective Stream feature [#235](https://github.com/opentok/OpenTok-Ruby-SDK/pull/235)
+* Adds Dial DTMF feature [#234](https://github.com/opentok/OpenTok-Ruby-SDK/pull/234)
+* Adds Observe Force Mute flag to `Sip#dial` method [#232](https://github.com/opentok/OpenTok-Ruby-SDK/pull/232)
+* Updates dependency version (`rake`) [#231](https://github.com/opentok/OpenTok-Ruby-SDK/pull/231)
+* Adds Video Outbound flag to `Sip#dial` method [#227](https://github.com/opentok/OpenTok-Ruby-SDK/pull/227)
+
+# 4.2.0
+
+* A new `screenshare_type` parameter has been added to the layout options for archives and broadcasts, and this release makes it available in the SDK: https://tokbox.com/developer/rest/
+
+# 4.1.2 Release
+
+Fixes an issue with custom broadcast layout [#218](https://github.com/opentok/OpenTok-Ruby-SDK/pull/218)
+
+# 4.1.1
+
+Patch release to address issue corrected in [#214](https://github.com/opentok/OpenTok-Ruby-SDK/pull/214)
+
+# Release v4.1.0
+
+Add a `timeout_length` custom parameter that allows for the specification in seconds to wait before timing out for HTTP requests.
+
+# Release 4.0.1
+
+* Addresses an issue with invocation of `Set` in rubies v2.5
+* Updates cassettes for request header changes in HTTParty
+
+# Release 4.0.0
+
+* Update gems (thanks [@fidalgo](https://github.com/fidalgo))
+* Adds Ruby 2.7 support
+* Removes Ruby 2.0 support. (For Ruby v2.0.0 please continue to use the OpenTok Ruby SDK v3.0.0.)
+* Add layout to archive create (thanks [@mjthompsgb](https://github.com/mjthompsgb))
+* Broadcast sample (thanks [@IGitGotIt](https://github.com/IGitGotIt))
+
+# Release v3.1.0
+
+Adds the following APIs (Thanks @JayTokBox  & [@normanargueta](https://github.com/normanargueta)):
+- Force Disconnect
+- Signaling
+- Resolution Support
+- Archive Layouts
+- Broadcasting APIs
+- Get & List streams
+
+Updates and improves documentation! (Thanks [@jeffswartz](https://github.com/jeffswartz) )
+
+# Release v3.0.3
+
+Fixes internal logging and useragent issue
+
+# Release v3.0.1
+
+Upgraded dependency version ([#155](https://github.com/opentok/OpenTok-Ruby-SDK/pull/155))
+
+# Release v3.0.0
+
+Updating the version of httparty to 0.15. This is a breaking change because we require Ruby >= 2.0.0 now.
+
+
+# Release v2.5.0
+
+This updates includes the following change:
+
+- [Add a dial method to initiate a SIP call](https://github.com/opentok/OpenTok-Ruby-SDK/pull/133)
+
+Thanks @herestomwiththeweather!
+
+# Release v2.4.1
+
+This updates includes the following changes:
+
+- [Support for the initial_layout_class_list feature of tokens](https://github.com/opentok/OpenTok-Ruby-SDK/pull/146)
+- [Remove unnecessary info param from JS samples](https://github.com/opentok/OpenTok-Ruby-SDK/pull/147)
+
+# Release v2.4.0
+
+This updates includes the following changes:
+
+- [Adds support for filtering archives by session ID](https://github.com/opentok/OpenTok-Ruby-SDK/pull/143)
+- [Adds support for JWT `X-OPENTOK-AUTH` header, replacing the deprecated `X-TB-PARTNER-AUTH` header](https://github.com/opentok/OpenTok-Ruby-SDK/pull/134)
+- [Updates the REST API endpoint URL to use `/project/` replacing the deprecated `/partner/`](https://github.com/opentok/OpenTok-Ruby-SDK/pull/129)
+
+As well as:
+
+- Updates JS code in samples to use latest API and best practices ([#140](https://github.com/opentok/OpenTok-Ruby-SDK/pull/140) and [#144](https://github.com/opentok/OpenTok-Ruby-SDK/pull/144))
+- Removes generated HTML docs from this repo
+- Updates documentation
+
+# Release v2.4.0.beta.1
+
+This update includes support for the `initial_layout_class_list` feature of tokens.
+
+# Release v2.3.4
+
+This update addresses an issue with loading the opentok gem in certain Rails based projects. (see: [#109](https://github.com/opentok/OpenTok-Ruby-SDK/issues/109), [#113](https://github.com/opentok/OpenTok-Ruby-SDK/pull/113). thanks [@LuckDragon82](https://github.com/LuckDragon82)!)
+
+# Release v2.3.3
+
+This release adds an internal option on the OpenTok initializer used to customize the User Agent string. ([#108](https://github.com/opentok/OpenTok-Ruby-SDK/pull/108))
+
+# Release v2.3.2
+
+This release fixes an issue where connection timeouts are too aggressive. It doubles the time allowed while also only counting the time it takes for TCP connect to finish, not the entire HTTP response to be received ([#106](https://github.com/opentok/OpenTok-Ruby-SDK/pull/106) thanks [@dramalho](https://github.com/dramalho))
+
+# Release v2.3.0
+
+New archiving features:
+-  Automatically archived sessions -- See the `:archive_mode` option of the `OpenTok#create_session()` method.
+-  Audio-only or video-only archives -- See the `:has_audio` and `:has_video` parameters of the `OpenTok#archives.create()` method.
+-  Individual archiving -- See the `:output_mode` parameter of the `OpenTok#archives.create()` method.
+-  Paused archives -- When no clients are publishing to a session being archived, its status changes to "paused". See `Archive#status`.
+
+Other improvements:
+-  Adds default HTTP timeout for requests ([#78](https://github.com/opentok/OpenTok-Ruby-SDK/pull/78) thanks [@dramalho](https://github.com/dramalho))
+-  Fixes Archiving sample app ([#96](https://github.com/opentok/OpenTok-Ruby-SDK/pull/96) thanks [@matsubo](https://github.com/matsubo))
+
+# Release v2.2.4
+
+-  Ruby 2.2.0 compatibility (thanks [@superacidjax](https://github.com/superacidjax)) [#80](https://github.com/opentok/OpenTok-Ruby-SDK/pull/80)
+-  Uses updated REST API for `archives.create` and `archives.stop_by_id` [#49](https://github.com/opentok/OpenTok-Ruby-SDK/issues/49) [#88](https://github.com/opentok/OpenTok-Ruby-SDK/issues/88)
+-  Adds `rake console` task for gem authors [#91](https://github.com/opentok/OpenTok-Ruby-SDK/pull/91)
+
+# Release v2.2.3
+
+This version fixes a bug related to users on Windows receiving an `OpenTokAuthenticationError` exception because of a bug in an older version of the `httparty` gem. See [#60](https://github.com/opentok/OpenTok-Ruby-SDK/issues/60)
+
+# Release v2.2.2
+
+The default setting for the `create_session()` method is to create a session with the media mode set
+to relayed. In previous versions of the SDK, the default setting was to use the OpenTok Media Router
+(media mode set to routed). In a relayed session, clients will attempt to send streams directly
+between each other (peer-to-peer); if clients cannot connect due to firewall restrictions, the
+session uses the OpenTok TURN server to relay audio-video streams.
+
+# Release v2.2.0
+
+This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
+work with OpenTok 1.0 archives.)
+
+Note also that the `options` parameter of the `OpenTok.create_session()` method has a `media_mode`
+property instead of a `p2p` property.
+
+# v0.1.3
+
+Fixes issues:
+
+- [#48](https://github.com/opentok/OpenTok-Ruby-SDK/issues/48) - OpenTokException given invalid number or parameters

data/README.md

@@ -1,22 +1,27 @@
 # OpenTok Ruby SDK
 
-[![Build Status](https://travis-ci.org/opentok/OpenTok-Ruby-SDK.png)](https://travis-ci.org/opentok/OpenTok-Ruby-SDK) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+![Coverage Status](https://github.com/opentok/OpenTok-Ruby-SDK/workflows/CI/badge.svg)
+[![codecov](https://codecov.io/gh/opentok/OpenTok-Ruby-SDK/branch/master/graph/badge.svg)](https://codecov.io/gh/opentok/opentok-ruby-sdk)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
 
 <img src="https://assets.tokbox.com/img/vonage/Vonage_VideoAPI_black.svg" height="48px" alt="Tokbox is now known as Vonage" />
 
-The OpenTok Ruby SDK lets you generate
-[sessions](https://tokbox.com/developer/guides/create-session/) and
-[tokens](https://tokbox.com/developer/guides/create-token/) for
-[OpenTok](http://www.tokbox.com/) applications. It also includes methods for
-working with OpenTok [archives](https://tokbox.com/developer/guides/archiving),
-working with OpenTok [live streaming
-broadcasts](https://tokbox.com/developer/guides/broadcast/live-streaming/),
-working with OpenTok [SIP interconnect](https://tokbox.com/developer/guides/sip),
-and [disconnecting clients from sessions](https://tokbox.com/developer/guides/moderation/rest/).
+The OpenTok Ruby SDK provides methods for:
 
-# Installation
+* Generating [sessions](https://tokbox.com/developer/guides/create-session/) and
+  [tokens](https://tokbox.com/developer/guides/create-token/) for
+  [OpenTok](https://www.vonage.com/communications-apis/video/) applications
+* Working with OpenTok [archives](https://tokbox.com/developer/guides/archiving)
+* Working with OpenTok [live streaming broadcasts](https://tokbox.com/developer/guides/broadcast/live-streaming/)
+* Working with OpenTok [SIP interconnect](https://tokbox.com/developer/guides/sip)
+* [Sending signals to clients connected to a session](https://tokbox.com/developer/guides/signaling/)
+* [Disconnecting clients from sessions](https://tokbox.com/developer/guides/moderation/rest/)
+* [Forcing clients in a session to disconnect or mute published audio](https://tokbox.com/developer/guides/moderation/)
+* Working with OpenTok [Experience Composers](https://tokbox.com/developer/guides/experience-composer)
 
-## Bundler (recommended):
+## Installation
+
+### Bundler (recommended):
 
 Bundler helps manage dependencies for Ruby projects. Find more info here: <http://bundler.io>
 
@@ -32,15 +37,15 @@ Allow bundler to install the change.
 $ bundle install
 ```
 
-## RubyGems:
+### RubyGems:
 
 ```
 $ gem install opentok
 ```
 
-# Usage
+## Usage
 
-## Initializing
+### Initializing
 
 Load the gem at the top of any file where it will be used. Then initialize an `OpenTok::OpenTok`
 object with your OpenTok API key and API secret.
@@ -51,7 +56,7 @@ require "opentok"
 opentok = OpenTok::OpenTok.new api_key, api_secret
 ```
 
-### Initialization Options
+#### Initialization Options
 
 You can specify a custom timeout value for HTTP requests when initializing a new `OpenTok::OpenTok`
 object:
@@ -65,7 +70,7 @@ opentok = OpenTok::OpenTok.new api_key, api_secret, :timeout_length => 10
 The value for `:timeout_length` is an integer representing the number of seconds to wait for an HTTP
 request to complete. The default is set to 2 seconds.
 
-## Creating Sessions
+### Creating Sessions
 
 To create an OpenTok Session, use the `OpenTok#create_session(properties)` method.
 The `properties` parameter is an optional Hash used to specify the following:
@@ -99,7 +104,7 @@ session = opentok.create_session :archive_mode => :always, :media_mode => :route
 session_id = session.session_id
 ```
 
-## Generating Tokens
+### Generating Tokens
 
 Once a Session is created, you can start generating Tokens for clients to use when connecting to it.
 You can generate a token either by calling the `opentok.generate_token(session_id, options)` method,
@@ -109,7 +114,7 @@ the Token. For layout control in archives and broadcasts, the initial layout cla
 published from connections using this token can be set as well.
 
 ```ruby
-# Generate a Token from just a session_id (fetched from a database)
+## Generate a Token from just a session_id (fetched from a database)
 token = opentok.generate_token session_id
 
 # Generate a Token by calling the method on the Session (returned from createSession)
@@ -124,7 +129,7 @@ token = session.generate_token({
 });
 ```
 
-## Working with Streams
+### Working with Streams
 
 Use this method to get information for an OpenTok stream or for all streams in a session.
 For example, you can call this method to get information about layout classes used by an
@@ -150,7 +155,7 @@ expect(all_streams.total).to eq 2
 expect(all_streams[0].layoutClassList[1]).to eq "focus"
 ```
 
-## Working with Archives
+### Working with Archives
 
 You can only archive sessions that use the OpenTok Media Router
 (sessions with the media mode set to routed).
@@ -183,8 +188,7 @@ archive = opentok.archives.create session_id :output_mode => :individual
 The `:output_mode => :composed` setting (the default) causes all streams in the archive to be
 recorded to a single (composed) file.
 
-For composed archives you can set the resolution of the archive, either "640x480" (SD, the default)
-or "1280x720" (HD). The `resolution` parameter is optional and could be included in the options
+For composed archives you can set the resolution of the archive, either "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait).. The `resolution` parameter is optional and could be included in the options
 hash (second argument) of the `opentok.archives.create()` method.
 
 ```ruby
@@ -314,9 +318,9 @@ stream](https://tokbox.com/developer/rest/#change-stream-layout-classes-composed
 Please keep in mind that the `streams.layout` method applies to archive and broadcast streams only.
 
 For more information on archiving, see the
-[OpenTok archiving](https://tokbox.com/opentok/tutorials/archiving/) programming guide.
+[OpenTok archiving](/developer/guides/archiving/) developer guide.
 
-## Signaling
+### Signaling
 
 You can send a signal using the `opentok.signals.send(session_id, connection_id, opts)` method.  
 If `connection_id` is nil or an empty string, then the signal is send to all valid connections in
@@ -341,16 +345,13 @@ use `opentok.signals.send(session_id)`
 For more information on signaling, see the
 [OpenTok Signaling](https://tokbox.com/developer/guides/signaling/js/) programming guide.
 
-## Broadcasting
+### Broadcasting
 
 You can broadcast your streams to a HLS or RTMP servers.
 
 To successfully start broadcasting a session, at least one publishing client must be connected to
 the session.
 
-You can only have one active live streaming broadcast at a time for a session (however, having more
-than one would not be useful).
-
 The live streaming broadcast can target one HLS endpoint and up to five RTMP servers simultaneously
 for a session.
 
@@ -449,12 +450,25 @@ for more details.
 You can also change the layout of an individual stream dynamically. Refer to
 [working with Streams](#working-with-streams).
 
-## Force disconnect
+### Force disconnect
 
 You can cause a client to be forced to disconnect from a session by using the
 `opentok.connections.forceDisconnect(session_id, connection_id)` method.
 
-## Initiating a SIP call
+### Forcing clients in a session to mute published audio
+
+You can force the publisher of a specific stream to stop publishing audio using the 
+`opentok.streams.force_mute(session_id, stream_id)` method.
+
+You can force the publisher of all streams in a session (except for an optional list of streams)
+to stop publishing audio using the `opentok.streams.force_mute_all(session_id, opts)`
+method. You can then disable the mute state of the session by calling the
+`opentok.streams.disable_force_mute(session_id)` method.
+
+For more information, see
+[Muting the audio of streams in a session](https://tokbox.com/developer/guides/moderation/#force_mute).
+
+### Initiating a SIP call
 
 You can initiate a SIP call using the `opentok.sip.dial(session_id, token, sip_uri, opts)` method.
 This requires a SIP URL. You will often need to pass options for authenticating to the SIP provider
@@ -471,7 +485,17 @@ response = opentok.sip.dial(session_id, token, "sip:+15128675309@acme.pstn.examp
 For more information on SIP Interconnect, see the
 [OpenTok SIP Interconnect](https://tokbox.com/developer/guides/sip/) developer guide.
 
-# Samples
+### Working with Experience Composers
+
+You can start an [Experience Composer](https://tokbox.com/developer/guides/experience-composer)
+by calling the `opentok.renders.start(session_id, options)` method.
+
+You can stop an Experience Composer by calling the `opentok.renders.stop(render_id, options)` method.
+
+You can get information about Experience Composers by calling the `opentok.renders.find(render_id)`
+and `opentok.renders.list(options)` methods.
+
+## Samples
 
 There are three sample applications included in this repository. To get going as fast as possible, clone the whole
 repository and read the README in each of the sample directories:
@@ -480,23 +504,23 @@ repository and read the README in each of the sample directories:
 - [Archiving](sample/Archiving/README.md)
 - [Broadcast](sample/Broadcast/README.md)
 
-# Documentation
+## Documentation
 
 Reference documentation is available at <http://www.tokbox.com//opentok/libraries/server/ruby/reference/index.html>.
 
-# Requirements
+## Requirements
 
 You need an OpenTok API key and API secret, which you can obtain by logging into your
-[TokBox account](https://tokbox.com/account).
+[Vonage Video API account](https://tokbox.com/account).
 
 The OpenTok Ruby SDK requires Ruby 2.1.0 or greater.
 
-# Release Notes
+## Release Notes
 
 See the [Releases](https://github.com/opentok/opentok-ruby-sdk/releases) page for details
 about each release.
 
-## Important changes since v2.2.0
+### Important changes since v2.2.0
 
 **Changes in v4.0.0:**
 
@@ -528,7 +552,7 @@ See the reference documentation
 <http://www.tokbox.com/opentok/libraries/server/ruby/reference/index.html> and in the
 docs directory of the SDK.
 
-# Development and Contributing
+## Development and Contributing
 
 Interested in contributing? We :heart: pull requests! See the [Development](DEVELOPING.md) and
 [Contribution](CONTRIBUTING.md) guidelines.

data/lib/opentok/archive.rb

@@ -7,7 +7,7 @@ module OpenTok
     #   The time at which the archive was created, in milliseconds since the UNIX epoch.
     #
     # @attr [string] duration
-    #   The duration of the archive, in milliseconds.
+    #   The duration of the archive, in seconds.
     #
     # @attr [string] id
     #   The archive ID.
@@ -26,19 +26,28 @@ module OpenTok
     #   Whether all streams in the archive are recorded to a single file (<code>:composed</code>)
     #   or to individual files (<code>:individual</code>).
     #
-    # @attr [string] partner_id
+    # @attr [string] projectId
     #   The API key associated with the archive.
     #
     # @attr [string] reason
     #   For archives with the status "stopped" or "failed", this string describes the
     #   reason the archive stopped (such as "maximum duration exceeded") or failed.
     #
+    # @attr [string] resolution
+    #   The resolution of the archive, either "640x480" (SD landscape, the default), "1280x720" (HD landscape),
+    #  "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait).
+    #   You may want to use a portrait aspect ratio for archives that include video streams from mobile devices (which often use the portrait aspect ratio).
+    #   This property is only set for composed archives.
+    #
     # @attr [string] session_id
     #   The session ID of the OpenTok session associated with this archive.
     #
     # @attr [float] size
     #   The size of the MP4 file. For archives that have not been generated, this value is set to 0.
     #
+    # @attr [string] streamMode
+    #   Whether streams included in the archive are selected automatically ("auto", the default) or manually ("manual").
+    #
     # @attr [string] status
     #   The status of the archive, which can be one of the following:
     #
@@ -63,12 +72,13 @@ module OpenTok
     #   set to null. The download URL is obfuscated, and the file is only available from the URL for
     #   10 minutes. To generate a new URL, call the Archive.listArchives() or OpenTok.getArchive() method.
   class Archive
-
+    attr_reader :multi_archive_tag
     # @private
     def initialize(interface, json)
       @interface = interface
       # TODO: validate json fits schema
       @json = json
+      @multi_archive_tag = @json['multiArchiveTag']
     end
 
     # A JSON-encoded string representation of the archive.
@@ -99,7 +109,7 @@ module OpenTok
     # {https://tokbox.com/developer/guides/archiving/layout-control.html Customizing
     # the video layout for composed archives}.
     #
-    # @option options [String] :type 
+    # @option options [String] :type
     #   The layout type. Set this to "bestFit", "pip", "verticalPresentation",
     #   "horizontalPresentation", "focus", or "custom".
     #
@@ -136,6 +146,46 @@ module OpenTok
       @json = @interface.layout(@json['id'], opts)
     end
 
+    # Adds a stream to currently running composed archive that was started with the
+    # streamMode set to "manual". For a description of the feature, see
+    # {https://tokbox.com/developer/rest/#selecting-archive-streams}.
+    #
+    # @param [String] stream_id
+    #   The ID for the stream to be added to the archive
+    #
+    # @option opts [true, false] :has_audio
+    #   (Boolean, optional) — Whether the composed archive should include the stream's
+    #   audio (true, the default) or not (false).
+    #
+    # @option opts [true, false] :has_video
+    #   (Boolean, optional) — Whether the composed archive should include the stream's
+    #   video (true, the default) or not (false).
+    #
+    # @raise [OpenTokArchiveError]
+    #   The streamMode for the archive is not set to "manual".
+    #
+    # You can call the method repeatedly with add_stream set to the same stream ID, to
+    # toggle the stream's audio or video in the archive. If you set both has_audio and
+    # has_video to false, you will get error response.
+    def add_stream(stream_id, opts = {})
+      raise OpenTokArchiveError, "stream_mode must be manual in order to add a stream" unless @json['streamMode'] == 'manual'
+      @interface.add_stream(@json['id'], stream_id, opts)
+    end
+
+    # Removes a stream to currently running composed archive that was started with the
+    # streamMode set to "manual". For a description of the feature, see
+    # {https://tokbox.com/developer/rest/#selecting-archive-streams}.
+    #
+    # @param [String] stream_id
+    #   The ID for the stream to be removed from the archive
+    #
+    # @raise [OpenTokArchiveError]
+    #   The streamMode for the archive is not set to "manual".
+    def remove_stream(stream_id)
+      raise OpenTokArchiveError, "stream_mode must be manual in order to remove a stream" unless @json['streamMode'] == 'manual'
+      @interface.remove_stream(@json['id'], stream_id)
+    end
+
     # @private ignore
     def method_missing(method, *args, &block)
       camelized_method = method.to_s.camelize(:lower)