mux_ruby 2.0.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  3. data/README.md +4 -4
  4. data/docs/AssetNonStandardInputReasons.md +2 -0
  5. data/docs/AssetsApi.md +2 -0
  6. data/docs/CreateLiveStreamRequest.md +4 -0
  7. data/docs/ExportsApi.md +1 -1
  8. data/docs/FiltersApi.md +2 -2
  9. data/docs/GetLiveStreamPlaybackIDResponse.md +18 -0
  10. data/docs/LiveStream.md +2 -0
  11. data/docs/LiveStreamEmbeddedSubtitleSettings.md +24 -0
  12. data/docs/LiveStreamsApi.md +144 -0
  13. data/docs/RealTimeApi.md +2 -2
  14. data/docs/RealTimeBreakdownValue.md +2 -2
  15. data/docs/RealTimeTimeseriesDatapoint.md +2 -2
  16. data/docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md +18 -0
  17. data/examples/data/exercise-errors.rb +1 -2
  18. data/examples/video/exercise-assets.rb +1 -0
  19. data/gen/generator-config.json +2 -1
  20. data/gen/templates/gemspec.mustache +1 -0
  21. data/lib/mux_ruby/api/assets_api.rb +2 -0
  22. data/lib/mux_ruby/api/exports_api.rb +2 -2
  23. data/lib/mux_ruby/api/filters_api.rb +4 -4
  24. data/lib/mux_ruby/api/live_streams_api.rb +138 -0
  25. data/lib/mux_ruby/api/real_time_api.rb +4 -4
  26. data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +23 -1
  27. data/lib/mux_ruby/models/create_live_stream_request.rb +23 -1
  28. data/lib/mux_ruby/models/get_live_stream_playback_id_response.rb +218 -0
  29. data/lib/mux_ruby/models/live_stream.rb +11 -1
  30. data/lib/mux_ruby/models/live_stream_embedded_subtitle_settings.rb +287 -0
  31. data/lib/mux_ruby/models/real_time_breakdown_value.rb +7 -7
  32. data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +7 -7
  33. data/lib/mux_ruby/models/track.rb +0 -12
  34. data/lib/mux_ruby/models/update_live_stream_embedded_subtitles_request.rb +221 -0
  35. data/lib/mux_ruby/version.rb +1 -1
  36. data/lib/mux_ruby.rb +3 -0
  37. data/mux_ruby.gemspec +1 -0
  38. data/spec/models/get_live_stream_playback_id_response_spec.rb +34 -0
  39. data/spec/models/live_stream_embedded_subtitle_settings_spec.rb +56 -0
  40. data/spec/models/update_live_stream_embedded_subtitles_request_spec.rb +34 -0
  41. metadata +106 -93
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5ed2c3425506d9d2215a1b270685a1521fab33b7461b6df8ae7f2d1598f01be7
4
- data.tar.gz: 51534c33cf08abb639b122d7ee2e0def4039da598f5165f63c8ab94ac4795993
3
+ metadata.gz: f7a99cd8098b01ddad710e7153232db2cac36c4d31d2d53fce6bb58dfa382784
4
+ data.tar.gz: 8784940c59311b4cae0ff0baf15fc31a9c28970b8ce39e75520715fc21fdaba0
5
5
  SHA512:
6
- metadata.gz: abf234c5087e5bf38026f7593c2952b600cd54225cee8aa1d3d0de20ea0a2735b38c9d6bc95ff827a7d0cd45cee32346ba3e79efc0286ee3804e84d6a257e3db
7
- data.tar.gz: d5297872e8d6a496756a197f0e9f4ed478ed68732a3ae8dfbfa3eb7287bdc2f1168718fb7a8282e3202294dd569f9052eb1fcdb0549ee0538faeed198b7e75ab
6
+ metadata.gz: 942398ee0cd547f3e0e2ef124e67b47017feab7a0c3865ac61254fc4ac72040980a91b62bc1e558f04b5af23476ef2dee86e9ce38ee8b8e0946847907fc16287
7
+ data.tar.gz: 74e58bf7aa0ff96bb4affc8fcb1917dba3a285a2b80785699201c5c0433e17d0c00ad68dc02eeed9e0dd43540b7faaa4eb719c7e9bcfc2152e96297c961ae29a
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mux_ruby (2.0.0)
4
+ mux_ruby (3.0.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -11,9 +11,9 @@ GEM
11
11
  byebug (11.1.1)
12
12
  coderay (1.1.2)
13
13
  diff-lcs (1.3)
14
- ethon (0.14.0)
14
+ ethon (0.15.0)
15
15
  ffi (>= 1.15.0)
16
- ffi (1.15.3)
16
+ ffi (1.15.4)
17
17
  jaro_winkler (1.5.4)
18
18
  method_source (1.0.0)
19
19
  parallel (1.20.1)
data/README.md CHANGED
@@ -17,7 +17,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
17
17
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
18
18
 
19
19
  - API version: v1
20
- - Package version: 2.0.0
20
+ - Package version: 3.0.0
21
21
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
22
22
  For more information, please visit [https://docs.mux.com](https://docs.mux.com)
23
23
 
@@ -34,16 +34,16 @@ gem build mux_ruby.gemspec
34
34
  Then either install the gem locally:
35
35
 
36
36
  ```shell
37
- gem install ./mux_ruby-2.0.0.gem
37
+ gem install ./mux_ruby-3.0.0.gem
38
38
  ```
39
39
 
40
- (for development, run `gem install --dev ./mux_ruby-2.0.0.gem` to install the development dependencies)
40
+ (for development, run `gem install --dev ./mux_ruby-3.0.0.gem` to install the development dependencies)
41
41
 
42
42
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
43
43
 
44
44
  Finally add this to the Gemfile:
45
45
 
46
- gem 'mux_ruby', '~> 2.0.0'
46
+ gem 'mux_ruby', '~> 3.0.0'
47
47
 
48
48
  ### Install from Git
49
49
 
@@ -9,6 +9,7 @@
9
9
  | **video_gop_size** | **String** | The video key frame Interval (also called as Group of Picture or GOP) of the input file is `high`. This parameter is present when the gop is greater than 10 seconds. | [optional] |
10
10
  | **video_frame_rate** | **String** | The video frame rate of the input file. Video with average frames per second (fps) less than 10 or greater than 120 is non-standard. A `-1` frame rate value indicates Mux could not determine the frame rate of the video track. | [optional] |
11
11
  | **video_resolution** | **String** | The video resolution of the input file. Video resolution higher than 2048 pixels on any one dimension (height or width) is considered non-standard, The resolution value is presented as `width` x `height` in pixels. | [optional] |
12
+ | **video_bitrate** | **String** | The video bitrate of the input file is `high`. This parameter is present when the average bitrate of any key frame interval (also known as Group of Pictures or GOP) is higher than what's considered standard which typically is 16 Mbps. | [optional] |
12
13
  | **pixel_aspect_ratio** | **String** | The video pixel aspect ratio of the input file. | [optional] |
13
14
  | **video_edit_list** | **String** | Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. | [optional] |
14
15
  | **audio_edit_list** | **String** | Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. | [optional] |
@@ -25,6 +26,7 @@ instance = MuxRuby::AssetNonStandardInputReasons.new(
25
26
  video_gop_size: null,
26
27
  video_frame_rate: null,
27
28
  video_resolution: null,
29
+ video_bitrate: null,
28
30
  pixel_aspect_ratio: null,
29
31
  video_edit_list: null,
30
32
  audio_edit_list: null,
data/docs/AssetsApi.md CHANGED
@@ -372,6 +372,8 @@ nil (empty response body)
372
372
 
373
373
  Delete an asset track
374
374
 
375
+ Removes a text track from an asset. Audio and video tracks on assets cannot be removed.
376
+
375
377
  ### Examples
376
378
 
377
379
  ```ruby
@@ -9,7 +9,9 @@
9
9
  | **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. Defaults to 60 seconds on the API if not specified. | [optional] |
10
10
  | **passthrough** | **String** | | [optional] |
11
11
  | **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] |
12
+ | **embedded_subtitles** | [**Array<LiveStreamEmbeddedSubtitleSettings>**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional] |
12
13
  | **reduced_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen 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] |
14
+ | **low_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen 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] |
13
15
  | **test** | **Boolean** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] |
14
16
  | **simulcast_targets** | [**Array<CreateSimulcastTargetRequest>**](CreateSimulcastTargetRequest.md) | | [optional] |
15
17
 
@@ -24,7 +26,9 @@ instance = MuxRuby::CreateLiveStreamRequest.new(
24
26
  reconnect_window: null,
25
27
  passthrough: null,
26
28
  audio_only: null,
29
+ embedded_subtitles: null,
27
30
  reduced_latency: null,
31
+ low_latency: null,
28
32
  test: null,
29
33
  simulcast_targets: null
30
34
  )
data/docs/ExportsApi.md CHANGED
@@ -14,7 +14,7 @@ All URIs are relative to *https://api.mux.com*
14
14
 
15
15
  List property video view export links
16
16
 
17
- Deprecated: The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
17
+ The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
18
18
 
19
19
  ### Examples
20
20
 
data/docs/FiltersApi.md CHANGED
@@ -14,7 +14,7 @@ All URIs are relative to *https://api.mux.com*
14
14
 
15
15
  Lists values for a specific filter
16
16
 
17
- Deprecated: The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.
17
+ The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.
18
18
 
19
19
  ### Examples
20
20
 
@@ -94,7 +94,7 @@ end
94
94
 
95
95
  List Filters
96
96
 
97
- Deprecated: The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
97
+ The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
98
98
 
99
99
  ### Examples
100
100
 
@@ -0,0 +1,18 @@
1
+ # MuxRuby::GetLiveStreamPlaybackIDResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**PlaybackID**](.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::GetLiveStreamPlaybackIDResponse.new(
15
+ data: null
16
+ )
17
+ ```
18
+
data/docs/LiveStream.md CHANGED
@@ -16,6 +16,7 @@
16
16
  | **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] |
17
17
  | **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] |
18
18
  | **reduced_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen 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] |
19
+ | **low_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen 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] |
19
20
  | **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] |
20
21
  | **test** | **Boolean** | True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] |
21
22
 
@@ -37,6 +38,7 @@ instance = MuxRuby::LiveStream.new(
37
38
  audio_only: null,
38
39
  reconnect_window: null,
39
40
  reduced_latency: null,
41
+ low_latency: null,
40
42
  simulcast_targets: null,
41
43
  test: null
42
44
  )
@@ -0,0 +1,24 @@
1
+ # MuxRuby::LiveStreamEmbeddedSubtitleSettings
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | A name for this live stream closed caption track. | [optional] |
8
+ | **passthrough** | **String** | Arbitrary metadata set for the live stream closed caption track. Max 255 characters. | [optional] |
9
+ | **language_code** | **String** | The language of the closed caption stream. Value must be BCP 47 compliant. | [optional][default to 'en'] |
10
+ | **language_channel** | **String** | CEA-608 caption channel to read data from. | [optional][default to 'cc1'] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'mux_ruby'
16
+
17
+ instance = MuxRuby::LiveStreamEmbeddedSubtitleSettings.new(
18
+ name: null,
19
+ passthrough: null,
20
+ language_code: null,
21
+ language_channel: null
22
+ )
23
+ ```
24
+
@@ -13,10 +13,12 @@ All URIs are relative to *https://api.mux.com*
13
13
  | [**disable_live_stream**](LiveStreamsApi.md#disable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream |
14
14
  | [**enable_live_stream**](LiveStreamsApi.md#enable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream |
15
15
  | [**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream |
16
+ | [**get_live_stream_playback_id**](LiveStreamsApi.md#get_live_stream_playback_id) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a live stream playback ID |
16
17
  | [**get_live_stream_simulcast_target**](LiveStreamsApi.md#get_live_stream_simulcast_target) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a Live Stream Simulcast Target |
17
18
  | [**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams |
18
19
  | [**reset_stream_key**](LiveStreamsApi.md#reset_stream_key) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream’s stream key |
19
20
  | [**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 |
21
+ | [**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 |
20
22
 
21
23
 
22
24
  ## create_live_stream
@@ -646,6 +648,76 @@ end
646
648
  - **Accept**: application/json
647
649
 
648
650
 
651
+ ## get_live_stream_playback_id
652
+
653
+ > <GetLiveStreamPlaybackIDResponse> get_live_stream_playback_id(live_stream_id, playback_id)
654
+
655
+ Retrieve a live stream playback ID
656
+
657
+ ### Examples
658
+
659
+ ```ruby
660
+ require 'time'
661
+ require 'mux_ruby'
662
+ # setup authorization
663
+ MuxRuby.configure do |config|
664
+ # Configure HTTP basic authorization: accessToken
665
+ config.username = 'YOUR USERNAME'
666
+ config.password = 'YOUR PASSWORD'
667
+ end
668
+
669
+ api_instance = MuxRuby::LiveStreamsApi.new
670
+ live_stream_id = 'live_stream_id_example' # String | The live stream ID
671
+ playback_id = 'playback_id_example' # String | The live stream's playback ID.
672
+
673
+ begin
674
+ # Retrieve a live stream playback ID
675
+ result = api_instance.get_live_stream_playback_id(live_stream_id, playback_id)
676
+ p result
677
+ rescue MuxRuby::ApiError => e
678
+ puts "Error when calling LiveStreamsApi->get_live_stream_playback_id: #{e}"
679
+ end
680
+ ```
681
+
682
+ #### Using the get_live_stream_playback_id_with_http_info variant
683
+
684
+ This returns an Array which contains the response data, status code and headers.
685
+
686
+ > <Array(<GetLiveStreamPlaybackIDResponse>, Integer, Hash)> get_live_stream_playback_id_with_http_info(live_stream_id, playback_id)
687
+
688
+ ```ruby
689
+ begin
690
+ # Retrieve a live stream playback ID
691
+ data, status_code, headers = api_instance.get_live_stream_playback_id_with_http_info(live_stream_id, playback_id)
692
+ p status_code # => 2xx
693
+ p headers # => { ... }
694
+ p data # => <GetLiveStreamPlaybackIDResponse>
695
+ rescue MuxRuby::ApiError => e
696
+ puts "Error when calling LiveStreamsApi->get_live_stream_playback_id_with_http_info: #{e}"
697
+ end
698
+ ```
699
+
700
+ ### Parameters
701
+
702
+ | Name | Type | Description | Notes |
703
+ | ---- | ---- | ----------- | ----- |
704
+ | **live_stream_id** | **String** | The live stream ID | |
705
+ | **playback_id** | **String** | The live stream&#39;s playback ID. | |
706
+
707
+ ### Return type
708
+
709
+ [**GetLiveStreamPlaybackIDResponse**](GetLiveStreamPlaybackIDResponse.md)
710
+
711
+ ### Authorization
712
+
713
+ [accessToken](../README.md#accessToken)
714
+
715
+ ### HTTP request headers
716
+
717
+ - **Content-Type**: Not defined
718
+ - **Accept**: application/json
719
+
720
+
649
721
  ## get_live_stream_simulcast_target
650
722
 
651
723
  > <SimulcastTargetResponse> get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
@@ -931,3 +1003,75 @@ end
931
1003
  - **Content-Type**: Not defined
932
1004
  - **Accept**: application/json
933
1005
 
1006
+
1007
+ ## update_live_stream_embedded_subtitles
1008
+
1009
+ > <LiveStreamResponse> update_live_stream_embedded_subtitles(live_stream_id, update_live_stream_embedded_subtitles_request)
1010
+
1011
+ Update a live stream's embedded subtitles
1012
+
1013
+ Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have `closed_captions: true` set.
1014
+
1015
+ ### Examples
1016
+
1017
+ ```ruby
1018
+ require 'time'
1019
+ require 'mux_ruby'
1020
+ # setup authorization
1021
+ MuxRuby.configure do |config|
1022
+ # Configure HTTP basic authorization: accessToken
1023
+ config.username = 'YOUR USERNAME'
1024
+ config.password = 'YOUR PASSWORD'
1025
+ end
1026
+
1027
+ api_instance = MuxRuby::LiveStreamsApi.new
1028
+ live_stream_id = 'live_stream_id_example' # String | The live stream ID
1029
+ update_live_stream_embedded_subtitles_request = MuxRuby::UpdateLiveStreamEmbeddedSubtitlesRequest.new # UpdateLiveStreamEmbeddedSubtitlesRequest |
1030
+
1031
+ begin
1032
+ # Update a live stream's embedded subtitles
1033
+ result = api_instance.update_live_stream_embedded_subtitles(live_stream_id, update_live_stream_embedded_subtitles_request)
1034
+ p result
1035
+ rescue MuxRuby::ApiError => e
1036
+ puts "Error when calling LiveStreamsApi->update_live_stream_embedded_subtitles: #{e}"
1037
+ end
1038
+ ```
1039
+
1040
+ #### Using the update_live_stream_embedded_subtitles_with_http_info variant
1041
+
1042
+ This returns an Array which contains the response data, status code and headers.
1043
+
1044
+ > <Array(<LiveStreamResponse>, Integer, Hash)> update_live_stream_embedded_subtitles_with_http_info(live_stream_id, update_live_stream_embedded_subtitles_request)
1045
+
1046
+ ```ruby
1047
+ begin
1048
+ # Update a live stream's embedded subtitles
1049
+ data, status_code, headers = api_instance.update_live_stream_embedded_subtitles_with_http_info(live_stream_id, update_live_stream_embedded_subtitles_request)
1050
+ p status_code # => 2xx
1051
+ p headers # => { ... }
1052
+ p data # => <LiveStreamResponse>
1053
+ rescue MuxRuby::ApiError => e
1054
+ puts "Error when calling LiveStreamsApi->update_live_stream_embedded_subtitles_with_http_info: #{e}"
1055
+ end
1056
+ ```
1057
+
1058
+ ### Parameters
1059
+
1060
+ | Name | Type | Description | Notes |
1061
+ | ---- | ---- | ----------- | ----- |
1062
+ | **live_stream_id** | **String** | The live stream ID | |
1063
+ | **update_live_stream_embedded_subtitles_request** | [**UpdateLiveStreamEmbeddedSubtitlesRequest**](UpdateLiveStreamEmbeddedSubtitlesRequest.md) | | |
1064
+
1065
+ ### Return type
1066
+
1067
+ [**LiveStreamResponse**](LiveStreamResponse.md)
1068
+
1069
+ ### Authorization
1070
+
1071
+ [accessToken](../README.md#accessToken)
1072
+
1073
+ ### HTTP request headers
1074
+
1075
+ - **Content-Type**: application/json
1076
+ - **Accept**: application/json
1077
+
data/docs/RealTimeApi.md CHANGED
@@ -247,7 +247,7 @@ end
247
247
 
248
248
  List Real-Time Dimensions
249
249
 
250
- Lists availiable real-time dimensions.
250
+ Lists available real-time dimensions.
251
251
 
252
252
  ### Examples
253
253
 
@@ -314,7 +314,7 @@ This endpoint does not need any parameter.
314
314
 
315
315
  List Real-Time Metrics
316
316
 
317
- Lists availiable real-time metrics.
317
+ Lists available real-time metrics.
318
318
 
319
319
  ### Examples
320
320
 
@@ -8,7 +8,7 @@
8
8
  | **negative_impact** | **Integer** | | [optional] |
9
9
  | **metric_value** | **Float** | | [optional] |
10
10
  | **display_value** | **String** | | [optional] |
11
- | **concurent_viewers** | **Integer** | | [optional] |
11
+ | **concurrent_viewers** | **Integer** | | [optional] |
12
12
 
13
13
  ## Example
14
14
 
@@ -20,7 +20,7 @@ instance = MuxRuby::RealTimeBreakdownValue.new(
20
20
  negative_impact: null,
21
21
  metric_value: null,
22
22
  display_value: null,
23
- concurent_viewers: null
23
+ concurrent_viewers: null
24
24
  )
25
25
  ```
26
26
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **value** | **Float** | | [optional] |
8
8
  | **date** | **String** | | [optional] |
9
- | **concurent_viewers** | **Integer** | | [optional] |
9
+ | **concurrent_viewers** | **Integer** | | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -16,7 +16,7 @@ require 'mux_ruby'
16
16
  instance = MuxRuby::RealTimeTimeseriesDatapoint.new(
17
17
  value: null,
18
18
  date: null,
19
- concurent_viewers: null
19
+ concurrent_viewers: null
20
20
  )
21
21
  ```
22
22
 
@@ -0,0 +1,18 @@
1
+ # MuxRuby::UpdateLiveStreamEmbeddedSubtitlesRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **embedded_subtitles** | [**Array&lt;LiveStreamEmbeddedSubtitleSettings&gt;**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::UpdateLiveStreamEmbeddedSubtitlesRequest.new(
15
+ embedded_subtitles: null
16
+ )
17
+ ```
18
+
@@ -16,8 +16,7 @@ errors_api = MuxRuby::ErrorsApi.new
16
16
 
17
17
  # ========== list-errors ==========
18
18
  errors = errors_api.list_errors(:filters => ['browser:Safari'], :timeframe => ['7:days'])
19
+ require 'pry'; binding.pry
19
20
  assert errors != nil
20
21
  assert errors.data != nil
21
- assert errors.data.length > 0
22
- assert errors.data.first.id != nil
23
22
  puts "list-errors OK ✅"
@@ -119,6 +119,7 @@ assert asset_with_2_captions.data.tracks.length == 4 # Audio, Video, French that
119
119
  puts "create-asset-track OK ✅"
120
120
 
121
121
  # ========== delete-asset-track ==========
122
+ Kernel.sleep(5)
122
123
  assets_api.delete_asset_track(create_response.data.id, subtitles_track.data.id)
123
124
  asset_with_1_captions = assets_api.get_asset(create_response.data.id)
124
125
  assert asset_with_1_captions.data.tracks.length == 3 # Audio, Video, French that we ingested with the asset
@@ -5,7 +5,8 @@
5
5
  "gemAuthorEmail": "devex@mux.com",
6
6
  "gemDescription": "The Ruby client for Mux Data and Mux Video.",
7
7
  "gemHomepage": "https://docs.mux.com",
8
+ "gemSourceLocation": "https://github.com/muxinc/mux-ruby",
8
9
  "gemLicense": "MIT",
9
10
  "moduleName": "MuxRuby",
10
- "gemVersion": "2.0.0"
11
+ "gemVersion": "3.0.0"
11
12
  }
@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
16
16
  s.homepage = "{{gemHomepage}}{{^gemHomepage}}https://openapi-generator.tech{{/gemHomepage}}"
17
17
  s.summary = "{{gemSummary}}{{^gemSummary}}{{{appName}}} Ruby Gem{{/gemSummary}}"
18
18
  s.description = "{{gemDescription}}{{^gemDescription}}{{{appDescription}}}{{^appDescription}}{{{appName}}} Ruby Gem{{/appDescription}}{{/gemDescription}}"
19
+ s.metadata = { "source_code_uri" => "{{gemSourceLocation}}" }
19
20
  s.license = "{{{gemLicense}}}{{^gemLicense}}Unlicense{{/gemLicense}}"
20
21
  s.required_ruby_version = "{{{gemRequiredRubyVersion}}}{{^gemRequiredRubyVersion}}>= 2.4{{/gemRequiredRubyVersion}}"
21
22
 
@@ -349,6 +349,7 @@ module MuxRuby
349
349
  end
350
350
 
351
351
  # Delete an asset track
352
+ # Removes a text track from an asset. Audio and video tracks on assets cannot be removed.
352
353
  # @param asset_id [String] The asset ID.
353
354
  # @param track_id [String] The track ID.
354
355
  # @param [Hash] opts the optional parameters
@@ -359,6 +360,7 @@ module MuxRuby
359
360
  end
360
361
 
361
362
  # Delete an asset track
363
+ # Removes a text track from an asset. Audio and video tracks on assets cannot be removed.
362
364
  # @param asset_id [String] The asset ID.
363
365
  # @param track_id [String] The track ID.
364
366
  # @param [Hash] opts the optional parameters
@@ -20,7 +20,7 @@ module MuxRuby
20
20
  @api_client = api_client
21
21
  end
22
22
  # List property video view export links
23
- # Deprecated: The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
23
+ # The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @return [ListExportsResponse]
26
26
  def list_exports(opts = {})
@@ -29,7 +29,7 @@ module MuxRuby
29
29
  end
30
30
 
31
31
  # List property video view export links
32
- # Deprecated: The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
32
+ # The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
33
33
  # @param [Hash] opts the optional parameters
34
34
  # @return [Array<(ListExportsResponse, Integer, Hash)>] ListExportsResponse data, response status code and response headers
35
35
  def list_exports_with_http_info(opts = {})
@@ -20,7 +20,7 @@ module MuxRuby
20
20
  @api_client = api_client
21
21
  end
22
22
  # Lists values for a specific filter
23
- # Deprecated: The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.
23
+ # The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.
24
24
  # @param filter_id [String] ID of the Filter
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [Integer] :limit Number of items to include in the response (default to 25)
@@ -34,7 +34,7 @@ module MuxRuby
34
34
  end
35
35
 
36
36
  # Lists values for a specific filter
37
- # Deprecated: The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.
37
+ # The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.
38
38
  # @param filter_id [String] ID of the Filter
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @option opts [Integer] :limit Number of items to include in the response
@@ -95,7 +95,7 @@ module MuxRuby
95
95
  end
96
96
 
97
97
  # List Filters
98
- # Deprecated: The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
98
+ # The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
99
99
  # @param [Hash] opts the optional parameters
100
100
  # @return [ListFiltersResponse]
101
101
  def list_filters(opts = {})
@@ -104,7 +104,7 @@ module MuxRuby
104
104
  end
105
105
 
106
106
  # List Filters
107
- # Deprecated: The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
107
+ # The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
108
108
  # @param [Hash] opts the optional parameters
109
109
  # @return [Array<(ListFiltersResponse, Integer, Hash)>] ListFiltersResponse data, response status code and response headers
110
110
  def list_filters_with_http_info(opts = {})