mux_ruby 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f06799d3527381141aa85e61bb4ced77393cd093737749d367af058109ee1857
-  data.tar.gz: 31ba3d499a958823f814d721be3dc2673427a652f05d454b6ba24083204f6fe7
+  metadata.gz: eb2b29c567025de72eb9d0189c6e1fa2ec9ea8689ac93e55863bb12695b9af2c
+  data.tar.gz: b5526bace178c2d507bdf6749eb941c3f6112b3359bebe8f7cc916a4654e2625
 SHA512:
-  metadata.gz: 6d42942a820771f914aa2954e1317422f8960d89fac567729e6373ffb0157d6851cfb1080a655f934f779067adb7c9bfdbd9c54f060230a11901c50a931116b8
-  data.tar.gz: 869f8926e6f4e5f5b034ca5ae49f0b5713fd3b508feccf7bb61c22f48b5e8b5d1279bbb993dce76efad1414cc967172cc7f768a45634a66a6fd3d1c01ad73f5f
+  metadata.gz: ae1c009ff5fdbc689afe779a07f42761c39bb3f0d3ba026474bfe3aa8464fb5f44e61cd0403986a1d3cae6c9d6ec3ade7d3976e7e0a2b128a117f2486980b24a
+  data.tar.gz: ff95553d55ab84a4baa91bc0ccab2d9f8ea68092dcde483bd3befcd6c05c88e94cff82589c81f30a8824805945bd565f7f59021f184c55738f60d33e043756d2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mux_ruby (3.5.0)
+    mux_ruby (3.6.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -13,7 +13,7 @@ GEM
     diff-lcs (1.3)
     ethon (0.15.0)
       ffi (>= 1.15.0)
-    ffi (1.15.5)
+    ffi (1.15.4)
     jaro_winkler (1.5.4)
     method_source (1.0.0)
     parallel (1.20.1)

data/README.md

@@ -23,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 3.5.0
+- Package version: 3.6.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://docs.mux.com](https://docs.mux.com)
 
@@ -40,16 +40,16 @@ gem build mux_ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./mux_ruby-3.5.0.gem
+gem install ./mux_ruby-3.6.0.gem
 ```
 
-(for development, run `gem install --dev ./mux_ruby-3.5.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./mux_ruby-3.6.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'mux_ruby', '~> 3.5.0'
+    gem 'mux_ruby', '~> 3.6.0'
 
 ### Install from Git
 

data/docs/CreateLiveStreamRequest.md

@@ -10,6 +10,7 @@
 | **passthrough** | **String** |  | [optional] |
 | **audio_only** | **Boolean** | Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted. | [optional] |
 | **embedded_subtitles** | [**Array<LiveStreamEmbeddedSubtitleSettings>**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional] |
+| **generated_subtitles** | [**Array<LiveStreamGeneratedSubtitleSettings>**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with `generated_subtitles` configured will automatically receive two text tracks. The first of these will have a `text_source` value of `generated_live`, and will be available with `ready` status as soon as the stream is live. The second text track will have a `text_source` value of `generated_live_final` and will contain subtitles with improved accuracy, timing, and formatting. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] |
 | **reduced_latency** | **Boolean** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] |
 | **low_latency** | **Boolean** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] |
 | **latency_mode** | **String** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Note: Reconnect windows are incompatible with Reduced Latency and Low Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] |
@@ -29,6 +30,7 @@ instance = MuxRuby::CreateLiveStreamRequest.new(
   passthrough: null,
   audio_only: null,
   embedded_subtitles: null,
+  generated_subtitles: null,
   reduced_latency: null,
   low_latency: null,
   latency_mode: null,

data/docs/CreateTranscriptionVocabularyRequest.md

@@ -0,0 +1,22 @@
+# MuxRuby::CreateTranscriptionVocabularyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The user-supplied name of the Transcription Vocabulary. | [optional] |
+| **phrases** | **Array<String>** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's `generated_subtitles`, the probability of successful speech recognition for these words or phrases is boosted. |  |
+| **passthrough** | **String** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::CreateTranscriptionVocabularyRequest.new(
+  name: null,
+  phrases: null,
+  passthrough: null
+)
+```
+

data/docs/ListTranscriptionVocabulariesResponse.md

@@ -0,0 +1,18 @@
+# MuxRuby::ListTranscriptionVocabulariesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<TranscriptionVocabulary>**](TranscriptionVocabulary.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::ListTranscriptionVocabulariesResponse.new(
+  data: null
+)
+```
+

data/docs/LiveStream.md

@@ -15,7 +15,8 @@
 | **passthrough** | **String** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] |
 | **audio_only** | **Boolean** | The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted. | [optional] |
 | **embedded_subtitles** | [**Array<LiveStreamEmbeddedSubtitleSettings>**](LiveStreamEmbeddedSubtitleSettings.md) | Describes the embedded closed caption configuration of the incoming live stream. | [optional] |
-| **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. **Min**: 0.1s. **Max**: 300s (5 minutes). | [optional][default to 60] |
+| **generated_subtitles** | [**Array<LiveStreamGeneratedSubtitleSettings>**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with `generated_subtitles` configured will automatically receive two text tracks. The first of these will have a `text_source` value of `generated_live`, and will be available with `ready` status as soon as the stream is live. The second text track will have a `text_source` value of `generated_live_final` and will contain subtitles with improved accuracy, timing, and formatting. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] |
+| **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. **Min**: 0.1s. **Max**: 1800s (30 minutes). | [optional][default to 60] |
 | **reduced_latency** | **Boolean** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. **Note**: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] |
 | **low_latency** | **Boolean** | This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] |
 | **simulcast_targets** | [**Array<SimulcastTarget>**](SimulcastTarget.md) | Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms). | [optional] |
@@ -40,6 +41,7 @@ instance = MuxRuby::LiveStream.new(
   passthrough: null,
   audio_only: null,
   embedded_subtitles: null,
+  generated_subtitles: null,
   reconnect_window: null,
   reduced_latency: null,
   low_latency: null,

data/docs/LiveStreamGeneratedSubtitleSettings.md

@@ -0,0 +1,24 @@
+# MuxRuby::LiveStreamGeneratedSubtitleSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name for this live stream subtitle track. | [optional] |
+| **passthrough** | **String** | Arbitrary metadata set for the live stream subtitle track. Max 255 characters. | [optional] |
+| **language_code** | **String** | The language to generate subtitles in. | [optional][default to 'en'] |
+| **transcription_vocabulary_ids** | **Array<String>** | Unique identifiers for existing Transcription Vocabularies to use while generating subtitles for the live stream. If the Transcription Vocabularies provided collectively have more than 1000 phrases, only the first 1000 phrases will be included. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::LiveStreamGeneratedSubtitleSettings.new(
+  name: null,
+  passthrough: null,
+  language_code: null,
+  transcription_vocabulary_ids: null
+)
+```
+

data/docs/LiveStreamsApi.md

@@ -20,6 +20,7 @@ All URIs are relative to *https://api.mux.com*
 | [**signal_live_stream_complete**](LiveStreamsApi.md#signal_live_stream_complete) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished |
 | [**update_live_stream**](LiveStreamsApi.md#update_live_stream) | **PATCH** /video/v1/live-streams/{LIVE_STREAM_ID} | Update a live stream |
 | [**update_live_stream_embedded_subtitles**](LiveStreamsApi.md#update_live_stream_embedded_subtitles) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles | Update a live stream's embedded subtitles |
+| [**update_live_stream_generated_subtitles**](LiveStreamsApi.md#update_live_stream_generated_subtitles) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/generated-subtitles | Update a live stream's generated subtitles |
 
 
 ## create_live_stream
@@ -1162,3 +1163,75 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json
 
+
+## update_live_stream_generated_subtitles
+
+> <LiveStreamResponse> update_live_stream_generated_subtitles(live_stream_id, update_live_stream_generated_subtitles_request)
+
+Update a live stream's generated subtitles
+
+Updates a live stream's automatic-speech-recognition-generated subtitle configuration. Automatic speech recognition subtitles can be removed by sending an empty array in the request payload. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'mux_ruby'
+# setup authorization
+MuxRuby.configure do |config|
+  # Configure HTTP basic authorization: accessToken
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MuxRuby::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+update_live_stream_generated_subtitles_request = MuxRuby::UpdateLiveStreamGeneratedSubtitlesRequest.new # UpdateLiveStreamGeneratedSubtitlesRequest | 
+
+begin
+  # Update a live stream's generated subtitles
+  result = api_instance.update_live_stream_generated_subtitles(live_stream_id, update_live_stream_generated_subtitles_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->update_live_stream_generated_subtitles: #{e}"
+end
+```
+
+#### Using the update_live_stream_generated_subtitles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LiveStreamResponse>, Integer, Hash)> update_live_stream_generated_subtitles_with_http_info(live_stream_id, update_live_stream_generated_subtitles_request)
+
+```ruby
+begin
+  # Update a live stream's generated subtitles
+  data, status_code, headers = api_instance.update_live_stream_generated_subtitles_with_http_info(live_stream_id, update_live_stream_generated_subtitles_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LiveStreamResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->update_live_stream_generated_subtitles_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
+| **update_live_stream_generated_subtitles_request** | [**UpdateLiveStreamGeneratedSubtitlesRequest**](UpdateLiveStreamGeneratedSubtitlesRequest.md) |  |  |
+
+### Return type
+
+[**LiveStreamResponse**](LiveStreamResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/MetricsApi.md

@@ -17,7 +17,7 @@ All URIs are relative to *https://api.mux.com*
 
 Get metric timeseries data
 
-Returns timeseries data for a specific metric.  Each interval represented in the data array contains an array with the following values:   * the first element is the interval time   * the second element is the calculated metric value    * the third element is the number of views in the interval that have a valid metric value 
+Returns timeseries data for a specific metric.  Each interval represented in the data array contains an array with the following values:   * the first element is the interval time   * the second element is the calculated metric value   * the third element is the number of views in the interval that have a valid metric value 
 
 ### Examples
 

data/docs/RealTimeApi.md

@@ -35,7 +35,7 @@ api_instance = MuxRuby::RealTimeApi.new
 realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime Metric
 opts = {
   dimension: 'asn', # String | Dimension the specified value belongs to
-  timestamp: 8.14, # Float | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
+  timestamp: 56, # Integer | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
   filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US` 
   order_by: 'negative_impact', # String | Value to order the results by
   order_direction: 'asc' # String | Sort order.
@@ -74,7 +74,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **realtime_metric_id** | **String** | ID of the Realtime Metric |  |
 | **dimension** | **String** | Dimension the specified value belongs to | [optional] |
-| **timestamp** | **Float** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
+| **timestamp** | **Integer** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
 | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;  | [optional] |
 | **order_by** | **String** | Value to order the results by | [optional] |
 | **order_direction** | **String** | Sort order. | [optional] |

data/docs/SpacesApi.md

@@ -5,14 +5,14 @@ All URIs are relative to *https://api.mux.com*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**create_space**](SpacesApi.md#create_space) | **POST** /video/v1/spaces | Create a space |
-| [**create_space_broadcast**](SpacesApi.md#create_space_broadcast) | **POST** /video/v1/spaces/${SPACE_ID}/broadcasts | Create a space broadcast |
-| [**delete_space**](SpacesApi.md#delete_space) | **DELETE** /video/v1/spaces/${SPACE_ID} | Delete a space |
-| [**delete_space_broadcast**](SpacesApi.md#delete_space_broadcast) | **DELETE** /video/v1/spaces/${SPACE_ID}/broadcasts/${BROADCAST_ID} | Delete a space broadcast |
-| [**get_space**](SpacesApi.md#get_space) | **GET** /video/v1/spaces/${SPACE_ID} | Retrieve a space |
-| [**get_space_broadcast**](SpacesApi.md#get_space_broadcast) | **GET** /video/v1/spaces/${SPACE_ID}/broadcasts/${BROADCAST_ID} | Retrieve space broadcast |
+| [**create_space_broadcast**](SpacesApi.md#create_space_broadcast) | **POST** /video/v1/spaces/{SPACE_ID}/broadcasts | Create a space broadcast |
+| [**delete_space**](SpacesApi.md#delete_space) | **DELETE** /video/v1/spaces/{SPACE_ID} | Delete a space |
+| [**delete_space_broadcast**](SpacesApi.md#delete_space_broadcast) | **DELETE** /video/v1/spaces/{SPACE_ID}/broadcasts/{BROADCAST_ID} | Delete a space broadcast |
+| [**get_space**](SpacesApi.md#get_space) | **GET** /video/v1/spaces/{SPACE_ID} | Retrieve a space |
+| [**get_space_broadcast**](SpacesApi.md#get_space_broadcast) | **GET** /video/v1/spaces/{SPACE_ID}/broadcasts/{BROADCAST_ID} | Retrieve space broadcast |
 | [**list_spaces**](SpacesApi.md#list_spaces) | **GET** /video/v1/spaces | List spaces |
-| [**start_space_broadcast**](SpacesApi.md#start_space_broadcast) | **POST** /video/v1/spaces/${SPACE_ID}/broadcasts/${BROADCAST_ID}/start | Start a space broadcast |
-| [**stop_space_broadcast**](SpacesApi.md#stop_space_broadcast) | **POST** /video/v1/spaces/${SPACE_ID}/broadcasts/${BROADCAST_ID}/stop | Stop a space broadcast |
+| [**start_space_broadcast**](SpacesApi.md#start_space_broadcast) | **POST** /video/v1/spaces/{SPACE_ID}/broadcasts/{BROADCAST_ID}/start | Start a space broadcast |
+| [**stop_space_broadcast**](SpacesApi.md#stop_space_broadcast) | **POST** /video/v1/spaces/{SPACE_ID}/broadcasts/{BROADCAST_ID}/stop | Stop a space broadcast |
 
 
 ## create_space
@@ -91,7 +91,7 @@ end
 
 Create a space broadcast
 
-Creates a new broadcast. Broadcasts are used to create composited versions of your space, which can be broadcast to live streams.  **Note:** By default only a single broadcast destination can be specified. Contact Mux support if you need more.
+Creates a new broadcast. Broadcasts are used to create composited versions of your space, which can be broadcast to live streams. **Note:** By default only a single broadcast destination can be specified. Contact Mux support if you need more.
 
 ### Examples
 
@@ -519,7 +519,7 @@ end
 
 Start a space broadcast
 
-Starts broadcasting a space to the associated destination.
+Starts broadcasting a space to the associated destination. Broadcasts can only be started when the space is `active` (when there are participants connected).
 
 ### Examples
 

data/docs/Track.md

@@ -13,6 +13,7 @@
 | **max_channels** | **Integer** | The maximum number of audio channels the track supports. Only set for the `audio` type track. | [optional] |
 | **max_channel_layout** | **String** | Only set for the `audio` type track. | [optional] |
 | **text_type** | **String** | This parameter is only set for `text` type tracks. | [optional] |
+| **text_source** | **String** | The source of the text contained in a Track of type `text`. Valid `text_source` values are listed below. * `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API. * `embedded`: Tracks extracted from an embedded stream of CEA-608 closed captions. * `generated_live`: Tracks generated by automatic speech recognition on a live stream configured with `generated_subtitles`.  If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. * `generated_live_final`: Tracks generated by automatic speech recognition on a live stream using `generated_subtitles`. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding `generated_live` tracks. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback.  | [optional] |
 | **language_code** | **String** | The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is only set for `text` type and `subtitles` text type tracks. | [optional] |
 | **name** | **String** | The name of the track containing a human-readable description. The hls manifest will associate a subtitle text track with this value. For example, the value is \"English\" for subtitles text track for the `language_code` value of `en-US`. This parameter is only set for `text` type and `subtitles` text type tracks. | [optional] |
 | **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set for `text` type and `subtitles` text type tracks. | [optional] |
@@ -34,6 +35,7 @@ instance = MuxRuby::Track.new(
   max_channels: null,
   max_channel_layout: null,
   text_type: null,
+  text_source: null,
   language_code: null,
   name: null,
   closed_captions: null,