mux_ruby 3.16.0 → 3.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (81) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -0
  3. data/Gemfile.lock +3 -2
  4. data/README.md +5 -5
  5. data/docs/Asset.md +3 -1
  6. data/docs/CreateAssetRequest.md +7 -3
  7. data/docs/CreateLiveStreamRequest.md +2 -0
  8. data/docs/CreatePlaybackIDRequest.md +3 -1
  9. data/docs/CreateUploadRequest.md +1 -1
  10. data/docs/DRMConfiguration.md +18 -0
  11. data/docs/DRMConfigurationResponse.md +18 -0
  12. data/docs/DRMConfigurationsApi.md +153 -0
  13. data/docs/DeliveryReport.md +3 -1
  14. data/docs/ListDRMConfigurationsResponse.md +18 -0
  15. data/docs/MetricsApi.md +8 -8
  16. data/docs/PlaybackID.md +3 -1
  17. data/gen/generator-config.json +1 -1
  18. data/gen/templates/README.mustache +1 -1
  19. data/lib/mux_ruby/api/drm_configurations_api.rb +148 -0
  20. data/lib/mux_ruby/api/metrics_api.rb +8 -8
  21. data/lib/mux_ruby/models/asset.rb +24 -2
  22. data/lib/mux_ruby/models/create_asset_request.rb +40 -6
  23. data/lib/mux_ruby/models/create_live_stream_request.rb +13 -1
  24. data/lib/mux_ruby/models/create_playback_id_request.rb +14 -4
  25. data/lib/mux_ruby/models/create_upload_request.rb +1 -0
  26. data/lib/mux_ruby/models/delivery_report.rb +24 -2
  27. data/lib/mux_ruby/models/drm_configuration.rb +219 -0
  28. data/lib/mux_ruby/models/drm_configuration_response.rb +218 -0
  29. data/lib/mux_ruby/models/list_drm_configurations_response.rb +220 -0
  30. data/lib/mux_ruby/models/playback_id.rb +14 -4
  31. data/lib/mux_ruby/models/playback_policy.rb +1 -0
  32. data/lib/mux_ruby/version.rb +1 -1
  33. data/lib/mux_ruby.rb +4 -0
  34. data/spec/api/drm_configurations_api_spec.rb +60 -0
  35. data/spec/models/drm_configuration_response_spec.rb +34 -0
  36. data/spec/models/drm_configuration_spec.rb +34 -0
  37. data/spec/models/list_drm_configurations_response_spec.rb +34 -0
  38. data/vendor/bundle/ruby/3.2.0/cache/jaro_winkler-1.5.6.gem +0 -0
  39. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/byebug/byebug.so +0 -0
  40. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +6 -6
  41. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/ffi_c.so +0 -0
  42. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +6 -6
  43. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/mkmf.log +18 -18
  44. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +29 -0
  45. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/jaro_winkler/jaro_winkler_ext.so +0 -0
  46. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/gem_make.out +6 -6
  47. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/mkmf.log +4 -4
  48. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/psych.so +0 -0
  49. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/gem_make.out +6 -6
  50. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/mkmf.log +2 -2
  51. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/stringio.so +0 -0
  52. data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug/Makefile +3 -3
  53. data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
  54. data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c/Makefile +3 -3
  55. data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/lib/ffi_c.so +0 -0
  56. data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/ext/jaro_winkler/Makefile +3 -3
  57. data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/ext/jaro_winkler/jaro_winkler.c +12 -7
  58. data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
  59. data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/lib/jaro_winkler/version.rb +1 -1
  60. data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/ext/psych/Makefile +3 -3
  61. data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/lib/psych.so +0 -0
  62. data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/ext/stringio/Makefile +3 -3
  63. data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/lib/stringio.so +0 -0
  64. data/vendor/bundle/ruby/3.2.0/specifications/{jaro_winkler-1.5.4.gemspec → jaro_winkler-1.5.6.gemspec} +5 -5
  65. metadata +191 -175
  66. data/vendor/bundle/ruby/3.2.0/cache/jaro_winkler-1.5.4.gem +0 -0
  67. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/gem_make.out +0 -66
  68. 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
  69. data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
  70. /data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/gem.build_complete +0 -0
  71. /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/LICENSE.txt +0 -0
  72. /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/ext/jaro_winkler/adj_matrix.c +0 -0
  73. /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/ext/jaro_winkler/adj_matrix.h +0 -0
  74. /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/ext/jaro_winkler/codepoints.c +0 -0
  75. /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/ext/jaro_winkler/codepoints.h +0 -0
  76. /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/ext/jaro_winkler/extconf.rb +0 -0
  77. /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/ext/jaro_winkler/jaro.c +0 -0
  78. /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/ext/jaro_winkler/jaro.h +0 -0
  79. /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/lib/jaro_winkler/adjusting_table.rb +0 -0
  80. /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/lib/jaro_winkler/jaro_winkler_pure.rb +0 -0
  81. /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/lib/jaro_winkler.rb +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 801d9952af44a42a85c2e26f35b5c6d999191d0861bbb55ad7a4bf9b1ddf94fb
4
- data.tar.gz: df9aafea70233c5f4bb20b297ddadf33a0b66c225ed14e8b9dc3b3c0499e2147
3
+ metadata.gz: 043f37c80f5a3227442e1138a80bbf7a3996e1bbb05cdf76746821da41afec53
4
+ data.tar.gz: de8c68d809fc242ad9c0d7682a826b4c8c8b825d9f715a01bcf63c501f352b22
5
5
  SHA512:
6
- metadata.gz: 87da656812866a9a8b5a09cb613dd1ab955e760504a133ca68870f53b60498258f4bc8fbc88749be90e9005079169320f3850c3f46372b533bae5146456466d1
7
- data.tar.gz: f801c56c20156feec118f58aeff35f5d83418a9ef5ceeebc0757ca5cf693eed9187116a7f11f54464860cde849dddbf2a4d929c1d0c299d0d2c216712c6be6c5
6
+ metadata.gz: b6388ad042e6df76b31aba484993e20e4286c8539a8ed55c5fb35b97b0f3eeb1ae89f34b349db18f9c12aaf74ea2bb48c36c9392d88ad3ea09d5232c2336f8ec
7
+ data.tar.gz: e8c56ac34dbf49e473a35affeb3f15c887044779ccc34f399af21d68fc4b972687cb633df091f05bdba793df42a7cd560fb717b642673f33ee7ff4ef18141973
data/Gemfile CHANGED
@@ -6,6 +6,7 @@ group :development, :test do
6
6
  gem 'rake', '~> 13.0.1'
7
7
  gem 'pry-byebug'
8
8
  gem 'rubocop', '~> 0.66.0'
9
+ gem 'jaro_winkler', '~>1.5.6'
9
10
 
10
11
  gem 'solid_assert'
11
12
  end
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mux_ruby (3.16.0)
4
+ mux_ruby (3.18.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -14,7 +14,7 @@ GEM
14
14
  ethon (0.16.0)
15
15
  ffi (>= 1.15.0)
16
16
  ffi (1.16.3)
17
- jaro_winkler (1.5.4)
17
+ jaro_winkler (1.5.6)
18
18
  method_source (1.0.0)
19
19
  parallel (1.22.1)
20
20
  parser (3.1.2.0)
@@ -61,6 +61,7 @@ PLATFORMS
61
61
  ruby
62
62
 
63
63
  DEPENDENCIES
64
+ jaro_winkler (~> 1.5.6)
64
65
  mux_ruby!
65
66
  pry-byebug
66
67
  rake (~> 13.0.1)
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.16.0
26
+ - Package version: 3.18.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.16.0.gem
43
+ gem install ./mux_ruby-3.18.0.gem
44
44
  ```
45
45
 
46
- (for development, run `gem install --dev ./mux_ruby-3.16.0.gem` to install the development dependencies)
46
+ (for development, run `gem install --dev ./mux_ruby-3.18.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.16.0'
52
+ gem 'mux_ruby', '~> 3.18.0'
53
53
 
54
54
  ### Install from Git
55
55
 
@@ -83,7 +83,7 @@ Its up to you to manage your token and secret. In our examples, we read them fro
83
83
  ### Example Usage
84
84
  Below is a quick example of using Mux Ruby to list the Video assets stored in your Mux account.
85
85
 
86
- Be sure to also checkout the [exmples directory](examples/):
86
+ Be sure to also checkout the [examples directory](examples/):
87
87
  * [List Assets, Live Streams, Signing Keys, and Uploads.](examples/video/list-everything.rb)
88
88
  * [Create an Asset, wait for it to become availiable, and print its playback URL](examples/video/ingest.rb)
89
89
  * [Create a new Live Stream and retrieve its Stream key.](examples/video/create-live-stream.rb)
data/docs/Asset.md CHANGED
@@ -11,7 +11,8 @@
11
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
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
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. [See the guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] |
14
+ | **encoding_tier** | **String** | This field is deprecated. Please use `video_quality` instead. The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. [See the video quality guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] |
15
+ | **video_quality** | **String** | The video quality controls the cost, quality, and available platform features for the asset. By default the `plus` video quality is used. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] |
15
16
  | **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] |
16
17
  | **aspect_ratio** | **String** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional] |
17
18
  | **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/play-your-videos) for more details. | [optional] |
@@ -47,6 +48,7 @@ instance = MuxRuby::Asset.new(
47
48
  resolution_tier: null,
48
49
  max_resolution_tier: null,
49
50
  encoding_tier: null,
51
+ video_quality: null,
50
52
  max_stored_frame_rate: null,
51
53
  aspect_ratio: null,
52
54
  playback_ids: null,
@@ -5,7 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **input** | [**Array<InputSettings>**](InputSettings.md) | An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements. | [optional] |
8
- | **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: `\"public\"` (anyone with the playback URL can stream the asset). And `\"signed\"` (an additional access token is required to play the asset). If no playback_policy is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] |
8
+ | **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: * `\"public\"` (anyone with the playback URL can stream the asset). * `\"signed\"` (an additional access token is required to play the asset). If no `playback_policy` is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] |
9
+ | **advanced_playback_policies** | [**Array<CreatePlaybackIDRequest>**](CreatePlaybackIDRequest.md) | An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policy` when creating a DRM playback ID. | [optional] |
9
10
  | **per_title_encode** | **Boolean** | | [optional] |
10
11
  | **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] |
11
12
  | **mp4_support** | **String** | Specify what level of support for mp4 playback. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). MP4 files are not produced for `none` (default). In most cases you should use our default HLS-based streaming playback (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional] |
@@ -13,7 +14,8 @@
13
14
  | **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](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional] |
14
15
  | **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
16
  | **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. [See the guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] |
17
+ | **encoding_tier** | **String** | This field is deprecated. Please use `video_quality` instead. The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. [See the video quality guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] |
18
+ | **video_quality** | **String** | The video quality controls the cost, quality, and available platform features for the asset. By default the `plus` video quality is used. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] |
17
19
 
18
20
  ## Example
19
21
 
@@ -23,6 +25,7 @@ require 'mux_ruby'
23
25
  instance = MuxRuby::CreateAssetRequest.new(
24
26
  input: null,
25
27
  playback_policy: null,
28
+ advanced_playback_policies: null,
26
29
  per_title_encode: null,
27
30
  passthrough: null,
28
31
  mp4_support: null,
@@ -30,7 +33,8 @@ instance = MuxRuby::CreateAssetRequest.new(
30
33
  master_access: null,
31
34
  test: null,
32
35
  max_resolution_tier: null,
33
- encoding_tier: null
36
+ encoding_tier: null,
37
+ video_quality: null
34
38
  )
35
39
  ```
36
40
 
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | | [optional] |
8
+ | **advanced_playback_policies** | [**Array<CreatePlaybackIDRequest>**](CreatePlaybackIDRequest.md) | An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policy` when creating a DRM playback ID. | [optional] |
8
9
  | **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] |
9
10
  | **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
11
  | **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] |
@@ -27,6 +28,7 @@ require 'mux_ruby'
27
28
 
28
29
  instance = MuxRuby::CreateLiveStreamRequest.new(
29
30
  playback_policy: null,
31
+ advanced_playback_policies: null,
30
32
  new_asset_settings: null,
31
33
  reconnect_window: null,
32
34
  use_slate_for_standard_latency: null,
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional] |
8
+ | **drm_configuration_id** | **String** | The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`. | [optional] |
8
9
 
9
10
  ## Example
10
11
 
@@ -12,7 +13,8 @@
12
13
  require 'mux_ruby'
13
14
 
14
15
  instance = MuxRuby::CreatePlaybackIDRequest.new(
15
- policy: null
16
+ policy: null,
17
+ drm_configuration_id: null
16
18
  )
17
19
  ```
18
20
 
@@ -7,7 +7,7 @@
7
7
  | **timeout** | **Integer** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked `timed_out` | [optional][default to 3600] |
8
8
  | **cors_origin** | **String** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] |
9
9
  | **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] |
10
- | **test** | **Boolean** | | [optional] |
10
+ | **test** | **Boolean** | Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a `test` Asset. | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -0,0 +1,18 @@
1
+ # MuxRuby::DRMConfiguration
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier for the DRM Configuration. Max 255 characters. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::DRMConfiguration.new(
15
+ id: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MuxRuby::DRMConfigurationResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**DRMConfiguration**](DRMConfiguration.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::DRMConfigurationResponse.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,153 @@
1
+ # MuxRuby::DRMConfigurationsApi
2
+
3
+ All URIs are relative to *https://api.mux.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_drm_configuration**](DRMConfigurationsApi.md#get_drm_configuration) | **GET** /video/v1/drm-configurations/{DRM_CONFIGURATION_ID} | Retrieve a DRM Configuration |
8
+ | [**list_drm_configurations**](DRMConfigurationsApi.md#list_drm_configurations) | **GET** /video/v1/drm-configurations | List DRM Configurations |
9
+
10
+
11
+ ## get_drm_configuration
12
+
13
+ > <DRMConfigurationResponse> get_drm_configuration(drm_configuration_id)
14
+
15
+ Retrieve a DRM Configuration
16
+
17
+ Retrieves a single DRM Configuration.
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'mux_ruby'
24
+ # setup authorization
25
+ MuxRuby.configure do |config|
26
+ # Configure HTTP basic authorization: accessToken
27
+ config.username = 'YOUR USERNAME'
28
+ config.password = 'YOUR PASSWORD'
29
+ end
30
+
31
+ api_instance = MuxRuby::DRMConfigurationsApi.new
32
+ drm_configuration_id = 'drm_configuration_id_example' # String | The DRM Configuration ID.
33
+
34
+ begin
35
+ # Retrieve a DRM Configuration
36
+ result = api_instance.get_drm_configuration(drm_configuration_id)
37
+ p result
38
+ rescue MuxRuby::ApiError => e
39
+ puts "Error when calling DRMConfigurationsApi->get_drm_configuration: #{e}"
40
+ end
41
+ ```
42
+
43
+ #### Using the get_drm_configuration_with_http_info variant
44
+
45
+ This returns an Array which contains the response data, status code and headers.
46
+
47
+ > <Array(<DRMConfigurationResponse>, Integer, Hash)> get_drm_configuration_with_http_info(drm_configuration_id)
48
+
49
+ ```ruby
50
+ begin
51
+ # Retrieve a DRM Configuration
52
+ data, status_code, headers = api_instance.get_drm_configuration_with_http_info(drm_configuration_id)
53
+ p status_code # => 2xx
54
+ p headers # => { ... }
55
+ p data # => <DRMConfigurationResponse>
56
+ rescue MuxRuby::ApiError => e
57
+ puts "Error when calling DRMConfigurationsApi->get_drm_configuration_with_http_info: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ | Name | Type | Description | Notes |
64
+ | ---- | ---- | ----------- | ----- |
65
+ | **drm_configuration_id** | **String** | The DRM Configuration ID. | |
66
+
67
+ ### Return type
68
+
69
+ [**DRMConfigurationResponse**](DRMConfigurationResponse.md)
70
+
71
+ ### Authorization
72
+
73
+ [accessToken](../README.md#accessToken)
74
+
75
+ ### HTTP request headers
76
+
77
+ - **Content-Type**: Not defined
78
+ - **Accept**: application/json
79
+
80
+
81
+ ## list_drm_configurations
82
+
83
+ > <ListDRMConfigurationsResponse> list_drm_configurations(opts)
84
+
85
+ List DRM Configurations
86
+
87
+ Returns a list of DRM Configurations
88
+
89
+ ### Examples
90
+
91
+ ```ruby
92
+ require 'time'
93
+ require 'mux_ruby'
94
+ # setup authorization
95
+ MuxRuby.configure do |config|
96
+ # Configure HTTP basic authorization: accessToken
97
+ config.username = 'YOUR USERNAME'
98
+ config.password = 'YOUR PASSWORD'
99
+ end
100
+
101
+ api_instance = MuxRuby::DRMConfigurationsApi.new
102
+ opts = {
103
+ page: 56, # Integer | Offset by this many pages, of the size of `limit`
104
+ limit: 56 # Integer | Number of items to include in the response
105
+ }
106
+
107
+ begin
108
+ # List DRM Configurations
109
+ result = api_instance.list_drm_configurations(opts)
110
+ p result
111
+ rescue MuxRuby::ApiError => e
112
+ puts "Error when calling DRMConfigurationsApi->list_drm_configurations: #{e}"
113
+ end
114
+ ```
115
+
116
+ #### Using the list_drm_configurations_with_http_info variant
117
+
118
+ This returns an Array which contains the response data, status code and headers.
119
+
120
+ > <Array(<ListDRMConfigurationsResponse>, Integer, Hash)> list_drm_configurations_with_http_info(opts)
121
+
122
+ ```ruby
123
+ begin
124
+ # List DRM Configurations
125
+ data, status_code, headers = api_instance.list_drm_configurations_with_http_info(opts)
126
+ p status_code # => 2xx
127
+ p headers # => { ... }
128
+ p data # => <ListDRMConfigurationsResponse>
129
+ rescue MuxRuby::ApiError => e
130
+ puts "Error when calling DRMConfigurationsApi->list_drm_configurations_with_http_info: #{e}"
131
+ end
132
+ ```
133
+
134
+ ### Parameters
135
+
136
+ | Name | Type | Description | Notes |
137
+ | ---- | ---- | ----------- | ----- |
138
+ | **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
139
+ | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
140
+
141
+ ### Return type
142
+
143
+ [**ListDRMConfigurationsResponse**](ListDRMConfigurationsResponse.md)
144
+
145
+ ### Authorization
146
+
147
+ [accessToken](../README.md#accessToken)
148
+
149
+ ### HTTP request headers
150
+
151
+ - **Content-Type**: Not defined
152
+ - **Accept**: application/json
153
+
@@ -12,7 +12,8 @@
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
14
  | **asset_resolution_tier** | **String** | The resolution tier that the asset was ingested at, affecting billing for ingest &amp; storage | [optional] |
15
- | **asset_encoding_tier** | **String** | The encoding tier that the asset was ingested at. [See the encoding tiers guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] |
15
+ | **asset_encoding_tier** | **String** | This field is deprecated. Please use &#x60;asset_video_quality&#x60; instead. The encoding tier that the asset was ingested at. [See the video quality guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] |
16
+ | **asset_video_quality** | **String** | The video quality that the asset was ingested at. This field replaces &#x60;asset_encoding_tier&#x60;. [See the video quality guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] |
16
17
  | **delivered_seconds** | **Float** | Total number of delivered seconds during this time window. | [optional] |
17
18
  | **delivered_seconds_by_resolution** | [**DeliveryReportDeliveredSecondsByResolution**](DeliveryReportDeliveredSecondsByResolution.md) | | [optional] |
18
19
 
@@ -31,6 +32,7 @@ instance = MuxRuby::DeliveryReport.new(
31
32
  asset_duration: null,
32
33
  asset_resolution_tier: null,
33
34
  asset_encoding_tier: null,
35
+ asset_video_quality: null,
34
36
  delivered_seconds: null,
35
37
  delivered_seconds_by_resolution: null
36
38
  )
@@ -0,0 +1,18 @@
1
+ # MuxRuby::ListDRMConfigurationsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;DRMConfiguration&gt;**](DRMConfiguration.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::ListDRMConfigurationsResponse.new(
15
+ data: null
16
+ )
17
+ ```
18
+
data/docs/MetricsApi.md CHANGED
@@ -37,7 +37,7 @@ opts = {
37
37
  timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
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
  metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
40
- measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
40
+ measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
41
41
  order_direction: 'asc', # String | Sort order.
42
42
  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.
43
43
  }
@@ -77,7 +77,7 @@ end
77
77
  | **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;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
78
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
79
  | **metric_filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60; | [optional] |
80
- | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
80
+ | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \&quot;sum\&quot; : &#x60;ad_attempt_count&#x60;, &#x60;ad_break_count&#x60;, &#x60;ad_break_error_count&#x60;, &#x60;ad_error_count&#x60;, &#x60;ad_impression_count&#x60;, &#x60;playing_time&#x60; \&quot;median\&quot; : &#x60;ad_preroll_startup_time&#x60;, &#x60;ad_watch_time&#x60;, &#x60;aggregate_startup_time&#x60;, &#x60;content_startup_time&#x60;, &#x60;content_watch_time&#x60;, &#x60;max_downscale_percentage&#x60;, &#x60;max_upscale_percentage&#x60;, &#x60;page_load_time&#x60;, &#x60;player_average_live_latency&#x60;, &#x60;player_startup_time&#x60;, &#x60;rebuffer_count&#x60;, &#x60;rebuffer_duration&#x60;, &#x60;requests_for_first_preroll&#x60;, &#x60;video_startup_preroll_load_time&#x60;, &#x60;video_startup_preroll_request_time&#x60;, &#x60;video_startup_time&#x60;, &#x60;view_average_request_latency&#x60;, &#x60;view_average_request_throughput&#x60;, &#x60;view_max_request_latency&#x60;, &#x60;weighted_average_bitrate&#x60; \&quot;avg\&quot; : &#x60;ad_break_error_percentage&#x60;, &#x60;ad_error_percentage&#x60;, &#x60;ad_exit_before_start_count&#x60;, &#x60;ad_exit_before_start_percentage&#x60;, &#x60;ad_playback_failure_percentage&#x60;, &#x60;ad_startup_error_count&#x60;, &#x60;ad_startup_error_percentage&#x60;, &#x60;content_playback_failure_percentage&#x60;, &#x60;downscale_percentage&#x60;, &#x60;exits_before_video_start&#x60;, &#x60;playback_business_exception_percentage&#x60;, &#x60;playback_failure_percentage&#x60;, &#x60;playback_success_score&#x60;, &#x60;rebuffer_frequency&#x60;, &#x60;rebuffer_percentage&#x60;, &#x60;seek_latency&#x60;, &#x60;smoothness_score&#x60;, &#x60;startup_time_score&#x60;, &#x60;upscale_percentage&#x60;, &#x60;video_quality_score&#x60;, &#x60;video_startup_business_exception_percentage&#x60;, &#x60;video_startup_failure_percentage&#x60;, &#x60;viewer_experience_score&#x60; \&quot;count\&quot; : &#x60;started_views&#x60;, &#x60;unique_viewers&#x60; | [optional] |
81
81
  | **order_direction** | **String** | Sort order. | [optional] |
82
82
  | **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] |
83
83
 
@@ -121,7 +121,7 @@ opts = {
121
121
  timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
122
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 Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
123
123
  metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
124
- measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
124
+ measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
125
125
  }
126
126
 
127
127
  begin
@@ -159,7 +159,7 @@ end
159
159
  | **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;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
160
160
  | **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] |
161
161
  | **metric_filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60; | [optional] |
162
- | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
162
+ | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \&quot;sum\&quot; : &#x60;ad_attempt_count&#x60;, &#x60;ad_break_count&#x60;, &#x60;ad_break_error_count&#x60;, &#x60;ad_error_count&#x60;, &#x60;ad_impression_count&#x60;, &#x60;playing_time&#x60; \&quot;median\&quot; : &#x60;ad_preroll_startup_time&#x60;, &#x60;ad_watch_time&#x60;, &#x60;aggregate_startup_time&#x60;, &#x60;content_startup_time&#x60;, &#x60;content_watch_time&#x60;, &#x60;max_downscale_percentage&#x60;, &#x60;max_upscale_percentage&#x60;, &#x60;page_load_time&#x60;, &#x60;player_average_live_latency&#x60;, &#x60;player_startup_time&#x60;, &#x60;rebuffer_count&#x60;, &#x60;rebuffer_duration&#x60;, &#x60;requests_for_first_preroll&#x60;, &#x60;video_startup_preroll_load_time&#x60;, &#x60;video_startup_preroll_request_time&#x60;, &#x60;video_startup_time&#x60;, &#x60;view_average_request_latency&#x60;, &#x60;view_average_request_throughput&#x60;, &#x60;view_max_request_latency&#x60;, &#x60;weighted_average_bitrate&#x60; \&quot;avg\&quot; : &#x60;ad_break_error_percentage&#x60;, &#x60;ad_error_percentage&#x60;, &#x60;ad_exit_before_start_count&#x60;, &#x60;ad_exit_before_start_percentage&#x60;, &#x60;ad_playback_failure_percentage&#x60;, &#x60;ad_startup_error_count&#x60;, &#x60;ad_startup_error_percentage&#x60;, &#x60;content_playback_failure_percentage&#x60;, &#x60;downscale_percentage&#x60;, &#x60;exits_before_video_start&#x60;, &#x60;playback_business_exception_percentage&#x60;, &#x60;playback_failure_percentage&#x60;, &#x60;playback_success_score&#x60;, &#x60;rebuffer_frequency&#x60;, &#x60;rebuffer_percentage&#x60;, &#x60;seek_latency&#x60;, &#x60;smoothness_score&#x60;, &#x60;startup_time_score&#x60;, &#x60;upscale_percentage&#x60;, &#x60;video_quality_score&#x60;, &#x60;video_startup_business_exception_percentage&#x60;, &#x60;video_startup_failure_percentage&#x60;, &#x60;viewer_experience_score&#x60; \&quot;count\&quot; : &#x60;started_views&#x60;, &#x60;unique_viewers&#x60; | [optional] |
163
163
 
164
164
  ### Return type
165
165
 
@@ -279,7 +279,7 @@ api_instance = MuxRuby::MetricsApi.new
279
279
  metric_id = 'aggregate_startup_time' # String | ID of the Metric
280
280
  opts = {
281
281
  group_by: 'asn', # String | Breakdown value to group the results by
282
- measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
282
+ measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
283
283
  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`
284
284
  metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
285
285
  limit: 56, # Integer | Number of items to include in the response
@@ -322,7 +322,7 @@ end
322
322
  | ---- | ---- | ----------- | ----- |
323
323
  | **metric_id** | **String** | ID of the Metric | |
324
324
  | **group_by** | **String** | Breakdown value to group the results by | [optional] |
325
- | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
325
+ | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \&quot;sum\&quot; : &#x60;ad_attempt_count&#x60;, &#x60;ad_break_count&#x60;, &#x60;ad_break_error_count&#x60;, &#x60;ad_error_count&#x60;, &#x60;ad_impression_count&#x60;, &#x60;playing_time&#x60; \&quot;median\&quot; : &#x60;ad_preroll_startup_time&#x60;, &#x60;ad_watch_time&#x60;, &#x60;aggregate_startup_time&#x60;, &#x60;content_startup_time&#x60;, &#x60;content_watch_time&#x60;, &#x60;max_downscale_percentage&#x60;, &#x60;max_upscale_percentage&#x60;, &#x60;page_load_time&#x60;, &#x60;player_average_live_latency&#x60;, &#x60;player_startup_time&#x60;, &#x60;rebuffer_count&#x60;, &#x60;rebuffer_duration&#x60;, &#x60;requests_for_first_preroll&#x60;, &#x60;video_startup_preroll_load_time&#x60;, &#x60;video_startup_preroll_request_time&#x60;, &#x60;video_startup_time&#x60;, &#x60;view_average_request_latency&#x60;, &#x60;view_average_request_throughput&#x60;, &#x60;view_max_request_latency&#x60;, &#x60;weighted_average_bitrate&#x60; \&quot;avg\&quot; : &#x60;ad_break_error_percentage&#x60;, &#x60;ad_error_percentage&#x60;, &#x60;ad_exit_before_start_count&#x60;, &#x60;ad_exit_before_start_percentage&#x60;, &#x60;ad_playback_failure_percentage&#x60;, &#x60;ad_startup_error_count&#x60;, &#x60;ad_startup_error_percentage&#x60;, &#x60;content_playback_failure_percentage&#x60;, &#x60;downscale_percentage&#x60;, &#x60;exits_before_video_start&#x60;, &#x60;playback_business_exception_percentage&#x60;, &#x60;playback_failure_percentage&#x60;, &#x60;playback_success_score&#x60;, &#x60;rebuffer_frequency&#x60;, &#x60;rebuffer_percentage&#x60;, &#x60;seek_latency&#x60;, &#x60;smoothness_score&#x60;, &#x60;startup_time_score&#x60;, &#x60;upscale_percentage&#x60;, &#x60;video_quality_score&#x60;, &#x60;video_startup_business_exception_percentage&#x60;, &#x60;video_startup_failure_percentage&#x60;, &#x60;viewer_experience_score&#x60; \&quot;count\&quot; : &#x60;started_views&#x60;, &#x60;unique_viewers&#x60; | [optional] |
326
326
  | **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] |
327
327
  | **metric_filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60; | [optional] |
328
328
  | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
@@ -368,7 +368,7 @@ end
368
368
  api_instance = MuxRuby::MetricsApi.new
369
369
  metric_id = 'aggregate_startup_time' # String | ID of the Metric
370
370
  opts = {
371
- measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
371
+ measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
372
372
  order_direction: 'asc', # String | Sort order.
373
373
  timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
374
374
  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`
@@ -407,7 +407,7 @@ end
407
407
  | Name | Type | Description | Notes |
408
408
  | ---- | ---- | ----------- | ----- |
409
409
  | **metric_id** | **String** | ID of the Metric | |
410
- | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
410
+ | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \&quot;sum\&quot; : &#x60;ad_attempt_count&#x60;, &#x60;ad_break_count&#x60;, &#x60;ad_break_error_count&#x60;, &#x60;ad_error_count&#x60;, &#x60;ad_impression_count&#x60;, &#x60;playing_time&#x60; \&quot;median\&quot; : &#x60;ad_preroll_startup_time&#x60;, &#x60;ad_watch_time&#x60;, &#x60;aggregate_startup_time&#x60;, &#x60;content_startup_time&#x60;, &#x60;content_watch_time&#x60;, &#x60;max_downscale_percentage&#x60;, &#x60;max_upscale_percentage&#x60;, &#x60;page_load_time&#x60;, &#x60;player_average_live_latency&#x60;, &#x60;player_startup_time&#x60;, &#x60;rebuffer_count&#x60;, &#x60;rebuffer_duration&#x60;, &#x60;requests_for_first_preroll&#x60;, &#x60;video_startup_preroll_load_time&#x60;, &#x60;video_startup_preroll_request_time&#x60;, &#x60;video_startup_time&#x60;, &#x60;view_average_request_latency&#x60;, &#x60;view_average_request_throughput&#x60;, &#x60;view_max_request_latency&#x60;, &#x60;weighted_average_bitrate&#x60; \&quot;avg\&quot; : &#x60;ad_break_error_percentage&#x60;, &#x60;ad_error_percentage&#x60;, &#x60;ad_exit_before_start_count&#x60;, &#x60;ad_exit_before_start_percentage&#x60;, &#x60;ad_playback_failure_percentage&#x60;, &#x60;ad_startup_error_count&#x60;, &#x60;ad_startup_error_percentage&#x60;, &#x60;content_playback_failure_percentage&#x60;, &#x60;downscale_percentage&#x60;, &#x60;exits_before_video_start&#x60;, &#x60;playback_business_exception_percentage&#x60;, &#x60;playback_failure_percentage&#x60;, &#x60;playback_success_score&#x60;, &#x60;rebuffer_frequency&#x60;, &#x60;rebuffer_percentage&#x60;, &#x60;seek_latency&#x60;, &#x60;smoothness_score&#x60;, &#x60;startup_time_score&#x60;, &#x60;upscale_percentage&#x60;, &#x60;video_quality_score&#x60;, &#x60;video_startup_business_exception_percentage&#x60;, &#x60;video_startup_failure_percentage&#x60;, &#x60;viewer_experience_score&#x60; \&quot;count\&quot; : &#x60;started_views&#x60;, &#x60;unique_viewers&#x60; | [optional] |
411
411
  | **order_direction** | **String** | Sort order. | [optional] |
412
412
  | **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;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
413
413
  | **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] |
data/docs/PlaybackID.md CHANGED
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | Unique identifier for the PlaybackID | [optional] |
8
8
  | **policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional] |
9
+ | **drm_configuration_id** | **String** | The DRM configuration used by this playback ID. Must only be set when &#x60;policy&#x60; is set to &#x60;drm&#x60;. | [optional] |
9
10
 
10
11
  ## Example
11
12
 
@@ -14,7 +15,8 @@ require 'mux_ruby'
14
15
 
15
16
  instance = MuxRuby::PlaybackID.new(
16
17
  id: null,
17
- policy: null
18
+ policy: null,
19
+ drm_configuration_id: null
18
20
  )
19
21
  ```
20
22
 
@@ -8,5 +8,5 @@
8
8
  "gemSourceLocation": "https://github.com/muxinc/mux-ruby",
9
9
  "gemLicense": "MIT",
10
10
  "moduleName": "MuxRuby",
11
- "gemVersion": "3.16.0"
11
+ "gemVersion": "3.18.0"
12
12
  }
@@ -88,7 +88,7 @@ Its up to you to manage your token and secret. In our examples, we read them fro
88
88
  ### Example Usage
89
89
  Below is a quick example of using Mux Ruby to list the Video assets stored in your Mux account.
90
90
 
91
- Be sure to also checkout the [exmples directory](examples/):
91
+ Be sure to also checkout the [examples directory](examples/):
92
92
  * [List Assets, Live Streams, Signing Keys, and Uploads.](examples/video/list-everything.rb)
93
93
  * [Create an Asset, wait for it to become availiable, and print its playback URL](examples/video/ingest.rb)
94
94
  * [Create a new Live Stream and retrieve its Stream key.](examples/video/create-live-stream.rb)