mux_ruby 3.9.0 → 3.11.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (112) hide show
  1. checksums.yaml +4 -4
  2. data/CODEOWNERS +1 -1
  3. data/Gemfile.lock +2 -2
  4. data/README.md +4 -4
  5. data/docs/Asset.md +7 -1
  6. data/docs/AssetGeneratedSubtitleSettings.md +22 -0
  7. data/docs/AssetNonStandardInputReasons.md +3 -1
  8. data/docs/AssetsApi.md +1 -1
  9. data/docs/CreateAssetRequest.md +5 -1
  10. data/docs/CreateLiveStreamRequest.md +3 -3
  11. data/docs/CreateTrackRequest.md +2 -2
  12. data/docs/DeliveryReport.md +2 -0
  13. data/docs/DeliveryReportDeliveredSecondsByResolution.md +5 -1
  14. data/docs/DirectUploadsApi.md +1 -1
  15. data/docs/GetMonitoringBreakdownTimeseriesResponse.md +22 -0
  16. data/docs/InputSettings.md +7 -5
  17. data/docs/LiveStream.md +4 -4
  18. data/docs/MetricsApi.md +2 -2
  19. data/docs/MonitoringApi.md +93 -6
  20. data/docs/MonitoringBreakdownTimeseriesDatapoint.md +22 -0
  21. data/docs/MonitoringBreakdownTimeseriesValues.md +20 -0
  22. data/docs/RealTimeApi.md +8 -6
  23. data/docs/SigningKeysApi.md +291 -0
  24. data/docs/Track.md +4 -4
  25. data/docs/URLSigningKeysApi.md +4 -4
  26. data/docs/UpdateLiveStreamRequest.md +1 -1
  27. data/docs/VideoView.md +33 -1
  28. data/examples/video/exercise-signing-keys.rb +5 -4
  29. data/gen/generator-config.json +1 -1
  30. data/gen/package.json +1 -1
  31. data/gen/yarn.lock +593 -129
  32. data/lib/mux_ruby/api/assets_api.rb +2 -2
  33. data/lib/mux_ruby/api/direct_uploads_api.rb +2 -2
  34. data/lib/mux_ruby/api/metrics_api.rb +9 -9
  35. data/lib/mux_ruby/api/monitoring_api.rb +110 -9
  36. data/lib/mux_ruby/api/real_time_api.rb +9 -6
  37. data/lib/mux_ruby/api/signing_keys_api.rb +266 -0
  38. data/lib/mux_ruby/api/url_signing_keys_api.rb +8 -8
  39. data/lib/mux_ruby/models/asset.rb +68 -2
  40. data/lib/mux_ruby/models/asset_generated_subtitle_settings.rb +275 -0
  41. data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +14 -4
  42. data/lib/mux_ruby/models/create_asset_request.rb +48 -4
  43. data/lib/mux_ruby/models/create_live_stream_request.rb +3 -3
  44. data/lib/mux_ruby/models/create_track_request.rb +4 -3
  45. data/lib/mux_ruby/models/delivery_report.rb +23 -1
  46. data/lib/mux_ruby/models/delivery_report_delivered_seconds_by_resolution.rb +22 -2
  47. data/lib/mux_ruby/models/get_monitoring_breakdown_timeseries_response.rb +240 -0
  48. data/lib/mux_ruby/models/input_settings.rb +18 -6
  49. data/lib/mux_ruby/models/live_stream.rb +4 -4
  50. data/lib/mux_ruby/models/live_stream_embedded_subtitle_settings.rb +2 -2
  51. data/lib/mux_ruby/models/monitoring_breakdown_timeseries_datapoint.rb +236 -0
  52. data/lib/mux_ruby/models/monitoring_breakdown_timeseries_values.rb +229 -0
  53. data/lib/mux_ruby/models/track.rb +4 -4
  54. data/lib/mux_ruby/models/update_live_stream_request.rb +1 -1
  55. data/lib/mux_ruby/models/video_view.rb +162 -5
  56. data/lib/mux_ruby/version.rb +1 -1
  57. data/lib/mux_ruby.rb +5 -0
  58. data/spec/api/signing_keys_api_spec.rb +83 -0
  59. data/spec/models/asset_generated_subtitle_settings_spec.rb +50 -0
  60. data/spec/models/get_monitoring_breakdown_timeseries_response_spec.rb +46 -0
  61. data/spec/models/monitoring_breakdown_timeseries_datapoint_spec.rb +46 -0
  62. data/spec/models/monitoring_breakdown_timeseries_values_spec.rb +40 -0
  63. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/byebug/byebug.so +0 -0
  64. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +6 -6
  65. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/ffi_c.so +0 -0
  66. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/gem_make.out +6 -6
  67. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/mkmf.log +15 -15
  68. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/gem_make.out +14 -14
  69. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/jaro_winkler/jaro_winkler_ext.so +0 -0
  70. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/gem_make.out +6 -6
  71. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/mkmf.log +4 -4
  72. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/psych.so +0 -0
  73. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/gem_make.out +6 -6
  74. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/mkmf.log +2 -2
  75. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/stringio.so +0 -0
  76. data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug/Makefile +6 -6
  77. data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
  78. data/vendor/bundle/ruby/3.2.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +6 -6
  79. data/vendor/bundle/ruby/3.2.0/gems/ffi-1.15.5/lib/ffi_c.so +0 -0
  80. data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +6 -6
  81. data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
  82. data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/ext/psych/Makefile +6 -6
  83. data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/lib/psych.so +0 -0
  84. data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/ext/stringio/Makefile +6 -6
  85. data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/lib/stringio.so +0 -0
  86. data/vendor/bundle/ruby/3.2.0/specifications/ast-2.4.2.gemspec +2 -2
  87. data/vendor/bundle/ruby/3.2.0/specifications/byebug-11.1.3.gemspec +2 -2
  88. data/vendor/bundle/ruby/3.2.0/specifications/coderay-1.1.3.gemspec +2 -2
  89. data/vendor/bundle/ruby/3.2.0/specifications/diff-lcs-1.5.0.gemspec +2 -2
  90. data/vendor/bundle/ruby/3.2.0/specifications/ethon-0.16.0.gemspec +2 -2
  91. data/vendor/bundle/ruby/3.2.0/specifications/ffi-1.15.5.gemspec +2 -2
  92. data/vendor/bundle/ruby/3.2.0/specifications/jaro_winkler-1.5.4.gemspec +2 -2
  93. data/vendor/bundle/ruby/3.2.0/specifications/method_source-1.0.0.gemspec +2 -2
  94. data/vendor/bundle/ruby/3.2.0/specifications/parallel-1.22.1.gemspec +2 -2
  95. data/vendor/bundle/ruby/3.2.0/specifications/parser-3.1.2.0.gemspec +2 -2
  96. data/vendor/bundle/ruby/3.2.0/specifications/pry-0.13.1.gemspec +2 -2
  97. data/vendor/bundle/ruby/3.2.0/specifications/pry-byebug-3.9.0.gemspec +2 -2
  98. data/vendor/bundle/ruby/3.2.0/specifications/psych-4.0.4.gemspec +2 -2
  99. data/vendor/bundle/ruby/3.2.0/specifications/rainbow-3.1.1.gemspec +2 -2
  100. data/vendor/bundle/ruby/3.2.0/specifications/rake-13.0.6.gemspec +2 -2
  101. data/vendor/bundle/ruby/3.2.0/specifications/rspec-3.11.0.gemspec +2 -2
  102. data/vendor/bundle/ruby/3.2.0/specifications/rspec-core-3.11.0.gemspec +2 -2
  103. data/vendor/bundle/ruby/3.2.0/specifications/rspec-expectations-3.11.0.gemspec +2 -2
  104. data/vendor/bundle/ruby/3.2.0/specifications/rspec-mocks-3.11.1.gemspec +2 -2
  105. data/vendor/bundle/ruby/3.2.0/specifications/rspec-support-3.11.0.gemspec +2 -2
  106. data/vendor/bundle/ruby/3.2.0/specifications/rubocop-0.66.0.gemspec +2 -2
  107. data/vendor/bundle/ruby/3.2.0/specifications/ruby-progressbar-1.11.0.gemspec +2 -2
  108. data/vendor/bundle/ruby/3.2.0/specifications/solid_assert-1.1.0.gemspec +2 -2
  109. data/vendor/bundle/ruby/3.2.0/specifications/stringio-3.0.2.gemspec +2 -2
  110. data/vendor/bundle/ruby/3.2.0/specifications/typhoeus-1.4.0.gemspec +2 -2
  111. data/vendor/bundle/ruby/3.2.0/specifications/unicode-display_width-1.5.0.gemspec +2 -2
  112. metadata +160 -140
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 15c9dcca547fff38377905355e23d468a23f1704d60053dc8b058d53ad8ab141
4
- data.tar.gz: 70b446084b0dfe5df85565fb054a5b9d3088a0dc03b08d6398981e5ec1fddcfb
3
+ metadata.gz: bf7de9e3cd1c0041f471a5cce7ccd753a1056fc399e3c4ae44d5def2bdace2f0
4
+ data.tar.gz: 8cc15702ca1f9a5f5e86e8c4769c79eca171924f7a42f2cf8f89dd5163217695
5
5
  SHA512:
6
- metadata.gz: 31f394b0944f843cd5bbf752d3b415405e280395cfad0a52043a99abc60564d7acca987cb9a3f31dc2010bf8abaa76f9d732fe451eb4dfe767b60116d3a0d4b0
7
- data.tar.gz: 193ead708baffb08e8c8f072df661598ccef63ef0e1a395ca2e406b8207bac147c46f184246d7ccb709006341140c7e86c57811f7983b86da56153b8fe72a133
6
+ metadata.gz: 597c57a1b949ef0c7eb620941c7ec6cd041ff4cb64cd6632991372c9d8274d728e42c3d4dd874ccc8286ade3d30bead75d8fbeba91c5a5772b7f13890cd88cbc
7
+ data.tar.gz: 9928f3eed58a694cb6bb58e3ee8964740cbee1171298fc7f5d790047f5de56c4d8336f60b614610b2fbc2d345b2779c741fabad34b47b1e0fcbf3ad29943cc32
data/CODEOWNERS CHANGED
@@ -1,2 +1,2 @@
1
1
  * @muxinc/techops
2
- /CODEOWNERS @muxinc/platform-team
2
+ /CODEOWNERS @muxinc/platform-engineering
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mux_ruby (3.9.0)
4
+ mux_ruby (3.11.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -69,4 +69,4 @@ DEPENDENCIES
69
69
  solid_assert
70
70
 
71
71
  BUNDLED WITH
72
- 2.2.25
72
+ 2.4.4
data/README.md CHANGED
@@ -23,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
23
23
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
24
24
 
25
25
  - API version: v1
26
- - Package version: 3.9.0
26
+ - Package version: 3.11.0
27
27
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
28
28
  For more information, please visit [https://docs.mux.com](https://docs.mux.com)
29
29
 
@@ -40,16 +40,16 @@ gem build mux_ruby.gemspec
40
40
  Then either install the gem locally:
41
41
 
42
42
  ```shell
43
- gem install ./mux_ruby-3.9.0.gem
43
+ gem install ./mux_ruby-3.11.0.gem
44
44
  ```
45
45
 
46
- (for development, run `gem install --dev ./mux_ruby-3.9.0.gem` to install the development dependencies)
46
+ (for development, run `gem install --dev ./mux_ruby-3.11.0.gem` to install the development dependencies)
47
47
 
48
48
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
49
49
 
50
50
  Finally add this to the Gemfile:
51
51
 
52
- gem 'mux_ruby', '~> 3.9.0'
52
+ gem 'mux_ruby', '~> 3.11.0'
53
53
 
54
54
  ### Install from Git
55
55
 
data/docs/Asset.md CHANGED
@@ -8,7 +8,10 @@
8
8
  | **created_at** | **String** | Time the Asset was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
9
9
  | **status** | **String** | The status of the asset. | [optional] |
10
10
  | **duration** | **Float** | The duration of the asset in seconds (max duration for a single asset is 12 hours). | [optional] |
11
- | **max_stored_resolution** | **String** | The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. | [optional] |
11
+ | **max_stored_resolution** | **String** | This field is deprecated. Please use `resolution_tier` instead. The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. | [optional] |
12
+ | **resolution_tier** | **String** | The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset. | [optional] |
13
+ | **max_resolution_tier** | **String** | Max resolution tier can be used to control the maximum `resolution_tier` your asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`. | [optional] |
14
+ | **encoding_tier** | **String** | The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. | [optional] |
12
15
  | **max_stored_frame_rate** | **Float** | The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined. | [optional] |
13
16
  | **aspect_ratio** | **String** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional] |
14
17
  | **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] |
@@ -40,6 +43,9 @@ instance = MuxRuby::Asset.new(
40
43
  status: null,
41
44
  duration: null,
42
45
  max_stored_resolution: null,
46
+ resolution_tier: null,
47
+ max_resolution_tier: null,
48
+ encoding_tier: null,
43
49
  max_stored_frame_rate: null,
44
50
  aspect_ratio: null,
45
51
  playback_ids: null,
@@ -0,0 +1,22 @@
1
+ # MuxRuby::AssetGeneratedSubtitleSettings
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | A name for this subtitle track. | [optional] |
8
+ | **passthrough** | **String** | Arbitrary metadata set for the subtitle track. Max 255 characters. | [optional] |
9
+ | **language_code** | **String** | The language to generate subtitles in. | [optional][default to 'en'] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::AssetGeneratedSubtitleSettings.new(
17
+ name: null,
18
+ passthrough: null,
19
+ language_code: null
20
+ )
21
+ ```
22
+
@@ -14,6 +14,7 @@
14
14
  | **video_edit_list** | **String** | Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. | [optional] |
15
15
  | **audio_edit_list** | **String** | Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. | [optional] |
16
16
  | **unexpected_media_file_parameters** | **String** | A catch-all reason when the input file in created with non-standard encoding parameters. | [optional] |
17
+ | **unsupported_pixel_format** | **String** | The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p. | [optional] |
17
18
 
18
19
  ## Example
19
20
 
@@ -30,7 +31,8 @@ instance = MuxRuby::AssetNonStandardInputReasons.new(
30
31
  pixel_aspect_ratio: null,
31
32
  video_edit_list: null,
32
33
  audio_edit_list: null,
33
- unexpected_media_file_parameters: null
34
+ unexpected_media_file_parameters: null,
35
+ unsupported_pixel_format: null
34
36
  )
35
37
  ```
36
38
 
data/docs/AssetsApi.md CHANGED
@@ -167,7 +167,7 @@ end
167
167
 
168
168
  Create an asset track
169
169
 
170
- Adds an asset track (for example, subtitles) to an asset.
170
+ Adds an asset track (for example, subtitles, or an alternate audio track) to an asset.
171
171
 
172
172
  ### Examples
173
173
 
@@ -12,6 +12,8 @@
12
12
  | **normalize_audio** | **Boolean** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional][default to false] |
13
13
  | **master_access** | **String** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] |
14
14
  | **test** | **Boolean** | Marks the asset as a test asset when the value is set to true. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs. | [optional] |
15
+ | **max_resolution_tier** | **String** | Max resolution tier can be used to control the maximum `resolution_tier` your asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`. | [optional] |
16
+ | **encoding_tier** | **String** | The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. | [optional] |
15
17
 
16
18
  ## Example
17
19
 
@@ -26,7 +28,9 @@ instance = MuxRuby::CreateAssetRequest.new(
26
28
  mp4_support: null,
27
29
  normalize_audio: null,
28
30
  master_access: null,
29
- test: null
31
+ test: null,
32
+ max_resolution_tier: null,
33
+ encoding_tier: null
30
34
  )
31
35
  ```
32
36
 
@@ -6,15 +6,15 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | | [optional] |
8
8
  | **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] |
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. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional][default to 60] |
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. If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional][default to 60] |
10
10
  | **use_slate_for_standard_latency** | **Boolean** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional][default to false] |
11
11
  | **reconnect_slate_url** | **String** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. | [optional] |
12
12
  | **passthrough** | **String** | | [optional] |
13
13
  | **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] |
14
14
  | **embedded_subtitles** | [**Array<LiveStreamEmbeddedSubtitleSettings>**](LiveStreamEmbeddedSubtitleSettings.md) | Describe the embedded closed caption contents of the incoming live stream. | [optional] |
15
15
  | **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] |
16
- | **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. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] |
17
- | **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. | [optional] |
16
+ | **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. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] |
17
+ | **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. | [optional] |
18
18
  | **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. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] |
19
19
  | **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] |
20
20
  | **simulcast_targets** | [**Array<CreateSimulcastTargetRequest>**](CreateSimulcastTargetRequest.md) | | [optional] |
@@ -4,11 +4,11 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **url** | **String** | | |
7
+ | **url** | **String** | The URL of the file that Mux should download and use. * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/video/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. | |
8
8
  | **type** | **String** | | |
9
9
  | **text_type** | **String** | | |
10
10
  | **language_code** | **String** | The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English. | |
11
- | **name** | **String** | The name of the track containing a human-readable description. This value must be unique across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \"English\" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional] |
11
+ | **name** | **String** | The name of the track containing a human-readable description. This value must be unique within each group of `text` or `audio` track types. The HLS manifest will associate the `text` or `audio` track with this value. For example, set the value to \"English\" for subtitles text track with `language_code` as en-US. If this parameter is not included, Mux will auto-populate a value based on the `language_code` value. | [optional] |
12
12
  | **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional] |
13
13
  | **passthrough** | **String** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. | [optional] |
14
14
 
@@ -11,6 +11,7 @@
11
11
  | **deleted_at** | **String** | If exists, time at which the asset was deleted. Measured in seconds since the Unix epoch. | [optional] |
12
12
  | **asset_state** | **String** | The state of the asset. | [optional] |
13
13
  | **asset_duration** | **Float** | The duration of the asset in seconds. | [optional] |
14
+ | **asset_resolution_tier** | **String** | The resolution tier that the asset was ingested at, affecting billing for ingest & storage | [optional] |
14
15
  | **delivered_seconds** | **Float** | Total number of delivered seconds during this time window. | [optional] |
15
16
  | **delivered_seconds_by_resolution** | [**DeliveryReportDeliveredSecondsByResolution**](DeliveryReportDeliveredSecondsByResolution.md) | | [optional] |
16
17
 
@@ -27,6 +28,7 @@ instance = MuxRuby::DeliveryReport.new(
27
28
  deleted_at: null,
28
29
  asset_state: null,
29
30
  asset_duration: null,
31
+ asset_resolution_tier: null,
30
32
  delivered_seconds: null,
31
33
  delivered_seconds_by_resolution: null
32
34
  )
@@ -4,7 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **tier_1080p** | **Float** | Total number of delivered seconds during this time window that had a resolution larger than the 720p tier (over 921,600 pixels total). | [optional] |
7
+ | **tier_2160p** | **Float** | Total number of delivered seconds during this time window that had a resolution larger than the 1440p tier (over 4,194,304 pixels total). | [optional] |
8
+ | **tier_1440p** | **Float** | Total number of delivered seconds during this time window that had a resolution larger than the 1080p tier but less than or equal to the 2160p tier (over 2,073,600 and <= 4,194,304 pixels total). | [optional] |
9
+ | **tier_1080p** | **Float** | Total number of delivered seconds during this time window that had a resolution larger than the 720p tier but less than or equal to the 1440p tier (over 921,600 and <= 2,073,600 pixels total). | [optional] |
8
10
  | **tier_720p** | **Float** | Total number of delivered seconds during this time window that had a resolution within the 720p tier (up to 921,600 pixels total, based on typical 1280x720). | [optional] |
9
11
  | **tier_audio_only** | **Float** | Total number of delivered seconds during this time window that had a resolution of audio only. | [optional] |
10
12
 
@@ -14,6 +16,8 @@
14
16
  require 'mux_ruby'
15
17
 
16
18
  instance = MuxRuby::DeliveryReportDeliveredSecondsByResolution.new(
19
+ tier_2160p: null,
20
+ tier_1440p: null,
17
21
  tier_1080p: null,
18
22
  tier_720p: null,
19
23
  tier_audio_only: null
@@ -226,7 +226,7 @@ end
226
226
 
227
227
  List direct uploads
228
228
 
229
- Lists currently extant direct uploads in the current environment.
229
+ Lists direct uploads in the current environment.
230
230
 
231
231
  ### Examples
232
232
 
@@ -0,0 +1,22 @@
1
+ # MuxRuby::GetMonitoringBreakdownTimeseriesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array<MonitoringBreakdownTimeseriesValues>**](MonitoringBreakdownTimeseriesValues.md) | | [optional] |
8
+ | **total_row_count** | **Integer** | | [optional] |
9
+ | **timeframe** | **Array<Integer>** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::GetMonitoringBreakdownTimeseriesResponse.new(
17
+ data: null,
18
+ total_row_count: null,
19
+ timeframe: null
20
+ )
21
+ ```
22
+
@@ -4,16 +4,17 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **url** | **String** | The URL of the file that Mux should download and use. * For subtitles text tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) format for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. | [optional] |
7
+ | **url** | **String** | The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/video/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/video/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input. | [optional] |
8
8
  | **overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) | | [optional] |
9
+ | **generated_subtitles** | [**Array<AssetGeneratedSubtitleSettings>**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition using this configuration. This may only be provided for the first input object (the main input file). For direct uploads, this first input should omit the url parameter, as the main input file is provided via the direct upload. This will create subtitles based on the audio track ingested from that main input file. Note that subtitle generation happens after initial ingest, so the generated tracks will be in the `preparing` state when the asset transitions to `ready`. | [optional] |
9
10
  | **start_time** | **Float** | The time offset in seconds from the beginning of the video indicating the clip's starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. | [optional] |
10
11
  | **end_time** | **Float** | The time offset in seconds from the beginning of the video, indicating the clip's ending marker. The default value is the duration of the video when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. | [optional] |
11
12
  | **type** | **String** | This parameter is required for `text` type tracks. | [optional] |
12
13
  | **text_type** | **String** | Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text` type tracks. | [optional] |
13
- | **language_code** | **String** | The language code value must be a valid [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 required for text type and subtitles text type track. | [optional] |
14
- | **name** | **String** | The name of the track containing a human-readable description. This value must be unique across all text type and subtitles `text` type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be \"English\" for subtitles text track with language_code as en. This optional parameter should be used only for `text` type and subtitles `text` type tracks. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value. | [optional] |
15
- | **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional] |
16
- | **passthrough** | **String** | This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional] |
14
+ | **language_code** | **String** | The language code value must be a valid [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 required for `text` and `audio` track types. | [optional] |
15
+ | **name** | **String** | The name of the track containing a human-readable description. This value must be unique within each group of `text` or `audio` track types. The HLS manifest will associate a subtitle text track with this value. For example, the value should be \"English\" for a subtitle text track with `language_code` set to `en`. This optional parameter should be used only for `text` and `audio` type tracks. This parameter can be optionally provided for the first video input to denote the name of the muxed audio track if present. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value. | [optional] |
16
+ | **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for tracks with `type` of `text` and `text_type` set to `subtitles`. | [optional] |
17
+ | **passthrough** | **String** | This optional parameter should be used tracks with `type` of `text` and `text_type` set to `subtitles`. | [optional] |
17
18
 
18
19
  ## Example
19
20
 
@@ -23,6 +24,7 @@ require 'mux_ruby'
23
24
  instance = MuxRuby::InputSettings.new(
24
25
  url: null,
25
26
  overlay_settings: null,
27
+ generated_subtitles: null,
26
28
  start_time: null,
27
29
  end_time: null,
28
30
  type: null,
data/docs/LiveStream.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | **created_at** | **String** | Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
9
9
  | **stream_key** | **String** | Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming. | [optional] |
10
10
  | **active_asset_id** | **String** | The Asset that is currently being created if there is an active broadcast. | [optional] |
11
- | **recent_asset_ids** | **Array<String>** | An array of strings with the most recent Assets that were created from this live stream. | [optional] |
11
+ | **recent_asset_ids** | **Array<String>** | An array of strings with the most recent Asset IDs that were created from this Live Stream. The most recently generated Asset ID is the last entry in the list. | [optional] |
12
12
  | **status** | [**LiveStreamStatus**](LiveStreamStatus.md) | | [optional] |
13
13
  | **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] |
14
14
  | **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] |
@@ -16,11 +16,11 @@
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
  | **embedded_subtitles** | [**Array<LiveStreamEmbeddedSubtitleSettings>**](LiveStreamEmbeddedSubtitleSettings.md) | Describes the embedded closed caption configuration of the incoming live stream. | [optional] |
18
18
  | **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] |
19
- | **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. **Max**: 1800s (30 minutes). Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional][default to 60] |
19
+ | **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. **Max**: 1800s (30 minutes). If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional][default to 60] |
20
20
  | **use_slate_for_standard_latency** | **Boolean** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional][default to false] |
21
21
  | **reconnect_slate_url** | **String** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. | [optional] |
22
- | **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. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] |
23
- | **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. | [optional] |
22
+ | **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. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] |
23
+ | **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. | [optional] |
24
24
  | **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] |
25
25
  | **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. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] |
26
26
  | **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] |
data/docs/MetricsApi.md CHANGED
@@ -38,7 +38,7 @@ opts = {
38
38
  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`
39
39
  measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
40
40
  order_direction: 'asc', # String | Sort order.
41
- group_by: 'ten_minutes' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.
41
+ group_by: 'minute' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.
42
42
  }
43
43
 
44
44
  begin
@@ -77,7 +77,7 @@ end
77
77
  | **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] |
78
78
  | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
79
79
  | **order_direction** | **String** | Sort order. | [optional] |
80
- | **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is &#x60;ten_minutes&#x60;. Between 6 hours and 15 days inclusive, the default granularity is &#x60;hour&#x60;. The granularity of timeframes that exceed 15 days is &#x60;day&#x60;. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity. | [optional] |
80
+ | **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of less than 90 minutes, the default granularity is &#x60;minute&#x60;. Between 90 minutes and 6 hours, the default granularity is &#x60;ten_minutes&#x60;. Between 6 hours and 15 days inclusive, the default granularity is &#x60;hour&#x60;. The granularity of timeframes that exceed 15 days is &#x60;day&#x60;. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity. | [optional] |
81
81
 
82
82
  ### Return type
83
83
 
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.mux.com*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**get_monitoring_breakdown**](MonitoringApi.md#get_monitoring_breakdown) | **GET** /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown | Get Monitoring Breakdown |
8
+ | [**get_monitoring_breakdown_timeseries**](MonitoringApi.md#get_monitoring_breakdown_timeseries) | **GET** /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown-timeseries | Get Monitoring Breakdown Timeseries |
8
9
  | [**get_monitoring_histogram_timeseries**](MonitoringApi.md#get_monitoring_histogram_timeseries) | **GET** /data/v1/monitoring/metrics/{MONITORING_HISTOGRAM_METRIC_ID}/histogram-timeseries | Get Monitoring Histogram Timeseries |
9
10
  | [**get_monitoring_timeseries**](MonitoringApi.md#get_monitoring_timeseries) | **GET** /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries | Get Monitoring Timeseries |
10
11
  | [**list_monitoring_dimensions**](MonitoringApi.md#list_monitoring_dimensions) | **GET** /data/v1/monitoring/dimensions | List Monitoring Dimensions |
@@ -36,7 +37,7 @@ monitoring_metric_id = 'current-concurrent-viewers' # String | ID of the Monitor
36
37
  opts = {
37
38
  dimension: 'asn', # String | Dimension the specified value belongs to
38
39
  timestamp: 56, # Integer | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
39
- 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`
40
+ 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 Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
40
41
  order_by: 'negative_impact', # String | Value to order the results by
41
42
  order_direction: 'asc' # String | Sort order.
42
43
  }
@@ -75,7 +76,7 @@ end
75
76
  | **monitoring_metric_id** | **String** | ID of the Monitoring Metric | |
76
77
  | **dimension** | **String** | Dimension the specified value belongs to | [optional] |
77
78
  | **timestamp** | **Integer** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
78
- | **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] |
79
+ | **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 Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
79
80
  | **order_by** | **String** | Value to order the results by | [optional] |
80
81
  | **order_direction** | **String** | Sort order. | [optional] |
81
82
 
@@ -93,6 +94,90 @@ end
93
94
  - **Accept**: application/json
94
95
 
95
96
 
97
+ ## get_monitoring_breakdown_timeseries
98
+
99
+ > <GetMonitoringBreakdownTimeseriesResponse> get_monitoring_breakdown_timeseries(monitoring_metric_id, opts)
100
+
101
+ Get Monitoring Breakdown Timeseries
102
+
103
+ Gets timeseries of breakdown information for a specific dimension and metric. Each datapoint in the response represents 5 seconds worth of data.
104
+
105
+ ### Examples
106
+
107
+ ```ruby
108
+ require 'time'
109
+ require 'mux_ruby'
110
+ # setup authorization
111
+ MuxRuby.configure do |config|
112
+ # Configure HTTP basic authorization: accessToken
113
+ config.username = 'YOUR USERNAME'
114
+ config.password = 'YOUR PASSWORD'
115
+ end
116
+
117
+ api_instance = MuxRuby::MonitoringApi.new
118
+ monitoring_metric_id = 'current-concurrent-viewers' # String | ID of the Monitoring Metric
119
+ opts = {
120
+ dimension: 'asn', # String | Dimension the specified value belongs to
121
+ timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). The default for this is the last 60 seconds of available data. Timeframes larger than 10 minutes are not allowed, and must be within the last 24 hours.
122
+ 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 Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
123
+ limit: 56, # Integer | Number of items to include in each timestamp's `value` list. The default is 10, and the maximum is 100.
124
+ order_by: 'negative_impact', # String | Value to order the results by
125
+ order_direction: 'asc' # String | Sort order.
126
+ }
127
+
128
+ begin
129
+ # Get Monitoring Breakdown Timeseries
130
+ result = api_instance.get_monitoring_breakdown_timeseries(monitoring_metric_id, opts)
131
+ p result
132
+ rescue MuxRuby::ApiError => e
133
+ puts "Error when calling MonitoringApi->get_monitoring_breakdown_timeseries: #{e}"
134
+ end
135
+ ```
136
+
137
+ #### Using the get_monitoring_breakdown_timeseries_with_http_info variant
138
+
139
+ This returns an Array which contains the response data, status code and headers.
140
+
141
+ > <Array(<GetMonitoringBreakdownTimeseriesResponse>, Integer, Hash)> get_monitoring_breakdown_timeseries_with_http_info(monitoring_metric_id, opts)
142
+
143
+ ```ruby
144
+ begin
145
+ # Get Monitoring Breakdown Timeseries
146
+ data, status_code, headers = api_instance.get_monitoring_breakdown_timeseries_with_http_info(monitoring_metric_id, opts)
147
+ p status_code # => 2xx
148
+ p headers # => { ... }
149
+ p data # => <GetMonitoringBreakdownTimeseriesResponse>
150
+ rescue MuxRuby::ApiError => e
151
+ puts "Error when calling MonitoringApi->get_monitoring_breakdown_timeseries_with_http_info: #{e}"
152
+ end
153
+ ```
154
+
155
+ ### Parameters
156
+
157
+ | Name | Type | Description | Notes |
158
+ | ---- | ---- | ----------- | ----- |
159
+ | **monitoring_metric_id** | **String** | ID of the Monitoring Metric | |
160
+ | **dimension** | **String** | Dimension the specified value belongs to | [optional] |
161
+ | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). The default for this is the last 60 seconds of available data. Timeframes larger than 10 minutes are not allowed, and must be within the last 24 hours. | [optional] |
162
+ | **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 Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
163
+ | **limit** | **Integer** | Number of items to include in each timestamp&#39;s &#x60;value&#x60; list. The default is 10, and the maximum is 100. | [optional][default to 10] |
164
+ | **order_by** | **String** | Value to order the results by | [optional] |
165
+ | **order_direction** | **String** | Sort order. | [optional] |
166
+
167
+ ### Return type
168
+
169
+ [**GetMonitoringBreakdownTimeseriesResponse**](GetMonitoringBreakdownTimeseriesResponse.md)
170
+
171
+ ### Authorization
172
+
173
+ [accessToken](../README.md#accessToken)
174
+
175
+ ### HTTP request headers
176
+
177
+ - **Content-Type**: Not defined
178
+ - **Accept**: application/json
179
+
180
+
96
181
  ## get_monitoring_histogram_timeseries
97
182
 
98
183
  > <GetMonitoringHistogramTimeseriesResponse> get_monitoring_histogram_timeseries(monitoring_histogram_metric_id, opts)
@@ -116,7 +201,7 @@ end
116
201
  api_instance = MuxRuby::MonitoringApi.new
117
202
  monitoring_histogram_metric_id = 'video-startup-time' # String | ID of the Monitoring Histogram Metric
118
203
  opts = {
119
- 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`
204
+ 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 Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
120
205
  }
121
206
 
122
207
  begin
@@ -151,7 +236,7 @@ end
151
236
  | Name | Type | Description | Notes |
152
237
  | ---- | ---- | ----------- | ----- |
153
238
  | **monitoring_histogram_metric_id** | **String** | ID of the Monitoring Histogram Metric | |
154
- | **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] |
239
+ | **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 Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
155
240
 
156
241
  ### Return type
157
242
 
@@ -190,7 +275,8 @@ end
190
275
  api_instance = MuxRuby::MonitoringApi.new
191
276
  monitoring_metric_id = 'current-concurrent-viewers' # String | ID of the Monitoring Metric
192
277
  opts = {
193
- 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`
278
+ 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 Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
279
+ timestamp: 56 # Integer | Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.
194
280
  }
195
281
 
196
282
  begin
@@ -225,7 +311,8 @@ end
225
311
  | Name | Type | Description | Notes |
226
312
  | ---- | ---- | ----------- | ----- |
227
313
  | **monitoring_metric_id** | **String** | ID of the Monitoring Metric | |
228
- | **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] |
314
+ | **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 Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
315
+ | **timestamp** | **Integer** | Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago. | [optional] |
229
316
 
230
317
  ### Return type
231
318
 
@@ -0,0 +1,22 @@
1
+ # MuxRuby::MonitoringBreakdownTimeseriesDatapoint
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | [optional] |
8
+ | **metric_value** | **Float** | | [optional] |
9
+ | **concurrent_viewers** | **Integer** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::MonitoringBreakdownTimeseriesDatapoint.new(
17
+ value: null,
18
+ metric_value: null,
19
+ concurrent_viewers: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # MuxRuby::MonitoringBreakdownTimeseriesValues
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **values** | [**Array&lt;MonitoringBreakdownTimeseriesDatapoint&gt;**](MonitoringBreakdownTimeseriesDatapoint.md) | | [optional] |
8
+ | **date** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mux_ruby'
14
+
15
+ instance = MuxRuby::MonitoringBreakdownTimeseriesValues.new(
16
+ values: null,
17
+ date: null
18
+ )
19
+ ```
20
+