From 21b60ca8871e34bfb2a87391d6fec615d2482732 Mon Sep 17 00:00:00 2001 From: superchilled Date: Wed, 3 Aug 2022 18:48:18 +0100 Subject: [PATCH 1/5] Updating comments for `resolution` property of `Archive` class --- lib/opentok/archive.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/opentok/archive.rb b/lib/opentok/archive.rb index dd73edf..588b862 100644 --- a/lib/opentok/archive.rb +++ b/lib/opentok/archive.rb @@ -34,7 +34,9 @@ module OpenTok # reason the archive stopped (such as "maximum duration exceeded") or failed. # # @attr [string] resolution - # The resolution of the archive (either "640x480", "1280x720", "480x640", or "720x1280"). + # 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 From 53cb230a78e53e3e27403bde7be2b78f869f5139 Mon Sep 17 00:00:00 2001 From: superchilled Date: Wed, 3 Aug 2022 18:50:27 +0100 Subject: [PATCH 2/5] Updating comments for `resolution` property of Broadcast class --- lib/opentok/broadcast.rb | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lib/opentok/broadcast.rb b/lib/opentok/broadcast.rb index a7a2c1e..59c9929 100644 --- a/lib/opentok/broadcast.rb +++ b/lib/opentok/broadcast.rb @@ -20,7 +20,10 @@ module OpenTok # For this start method, this timestamp matches the createdAt timestamp. # # @attr [string] resolution - # The resolution of the broadcast: either "640x480" (SD, the default) or "1280x720" (HD). This property is optional. + # The resolution of the broadcast: 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 broadcasts that include video streams from mobile devices (which often use the portrait aspect ratio). + # This property is optional. # # @attr [string] streamMode # Whether streams included in the broadcast are selected automatically ("auto", the default) or manually ("manual"). From 48849080b7fcb2639f28dcae7a75a6c02a1ba7d7 Mon Sep 17 00:00:00 2001 From: superchilled Date: Wed, 3 Aug 2022 18:54:11 +0100 Subject: [PATCH 3/5] Updating comments for `resolution` param of Archives#create method --- lib/opentok/archives.rb | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/lib/opentok/archives.rb b/lib/opentok/archives.rb index f29971f..62b9f0e 100644 --- a/lib/opentok/archives.rb +++ b/lib/opentok/archives.rb @@ -44,15 +44,16 @@ def initialize(client) # (:individual). For more information on archiving and the archive file # formats, see the {https://tokbox.com/opentok/tutorials/archiving OpenTok archiving} # programming guide. - # @option options [String] :resolution The resolution of the archive, either "640x480" (SD, the - # default) or "1280x720" (HD). This property only applies to composed archives. If you set - # this property and set the outputMode property to "individual", the call the method - # results in an error. + # @option options [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). This property only applies to composed archives. If you set + # this property and set the outputMode property to "individual", a call to the method + # results in an error. # @option options [String] :streamMode (Optional) Whether streams included in the archive are selected # automatically ("auto", the default) or manually ("manual"). When streams are selected automatically ("auto"), # all streams in the session can be included in the archive. When streams are selected manually ("manual"), # you specify streams to be included based on calls to the {Archives#add_stream} method. You can specify whether a - # stream's audio, video, or both are included in the archive. + # stream's audio, video, or both are included in the archive. # In composed archives, in both automatic and manual modes, the archive composer includes streams based # on {https://tokbox.com/developer/guides/archive-broadcast-layout/#stream-prioritization-rules stream prioritization rules}. # Important: this feature is currently available in the Standard environment only. From 7a1c980a5a44cd2b21e2cf332402542914dbac92 Mon Sep 17 00:00:00 2001 From: superchilled Date: Wed, 3 Aug 2022 18:59:17 +0100 Subject: [PATCH 4/5] Updating comments for `resolution` param of Broadcasts#create method --- lib/opentok/broadcasts.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/opentok/broadcasts.rb b/lib/opentok/broadcasts.rb index 1ea2246..d3da4ea 100644 --- a/lib/opentok/broadcasts.rb +++ b/lib/opentok/broadcasts.rb @@ -75,7 +75,9 @@ def initialize(client) # Broadcasts#find method. # # @option options [string] resolution - # The resolution of the broadcast: either "640x480" (SD, the default) or "1280x720" (HD). + # The resolution of the broadcast: either "640x480" (SD landscape, the default), "1280x720" (HD landscape), + # "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" + # (FHD portrait). # # @option options [String] :streamMode (Optional) Whether streams included in the broadcast are selected # automatically ("auto", the default) or manually ("manual"). When streams are selected automatically ("auto"), From bfd9af0ebb6a7b36d8a23206b6e710178c30f6b3 Mon Sep 17 00:00:00 2001 From: superchilled Date: Wed, 3 Aug 2022 19:01:42 +0100 Subject: [PATCH 5/5] Updating resolution information in the README --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d97975d..5095ebe 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # OpenTok Ruby SDK ![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) +[![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) Tokbox is now known as Vonage @@ -185,8 +185,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