Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEVX-5914 Add 1080p for Archive and Broadcast #246

Merged
merged 5 commits into from
Oct 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

<img src="https://assets.tokbox.com/img/vonage/Vonage_VideoAPI_black.svg" height="48px" alt="Tokbox is now known as Vonage" />
Expand Down Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion lib/opentok/archive.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 6 additions & 5 deletions lib/opentok/archives.rb
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,16 @@ def initialize(client)
# (<code>:individual</code>). 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.
Expand Down
5 changes: 4 additions & 1 deletion lib/opentok/broadcast.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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").
Expand Down
4 changes: 3 additions & 1 deletion lib/opentok/broadcasts.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down