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.
- checksums.yaml +4 -4
- data/Gemfile +1 -0
- data/Gemfile.lock +3 -2
- data/README.md +5 -5
- data/docs/Asset.md +3 -1
- data/docs/CreateAssetRequest.md +7 -3
- data/docs/CreateLiveStreamRequest.md +2 -0
- data/docs/CreatePlaybackIDRequest.md +3 -1
- data/docs/CreateUploadRequest.md +1 -1
- data/docs/DRMConfiguration.md +18 -0
- data/docs/DRMConfigurationResponse.md +18 -0
- data/docs/DRMConfigurationsApi.md +153 -0
- data/docs/DeliveryReport.md +3 -1
- data/docs/ListDRMConfigurationsResponse.md +18 -0
- data/docs/MetricsApi.md +8 -8
- data/docs/PlaybackID.md +3 -1
- data/gen/generator-config.json +1 -1
- data/gen/templates/README.mustache +1 -1
- data/lib/mux_ruby/api/drm_configurations_api.rb +148 -0
- data/lib/mux_ruby/api/metrics_api.rb +8 -8
- data/lib/mux_ruby/models/asset.rb +24 -2
- data/lib/mux_ruby/models/create_asset_request.rb +40 -6
- data/lib/mux_ruby/models/create_live_stream_request.rb +13 -1
- data/lib/mux_ruby/models/create_playback_id_request.rb +14 -4
- data/lib/mux_ruby/models/create_upload_request.rb +1 -0
- data/lib/mux_ruby/models/delivery_report.rb +24 -2
- data/lib/mux_ruby/models/drm_configuration.rb +219 -0
- data/lib/mux_ruby/models/drm_configuration_response.rb +218 -0
- data/lib/mux_ruby/models/list_drm_configurations_response.rb +220 -0
- data/lib/mux_ruby/models/playback_id.rb +14 -4
- data/lib/mux_ruby/models/playback_policy.rb +1 -0
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +4 -0
- data/spec/api/drm_configurations_api_spec.rb +60 -0
- data/spec/models/drm_configuration_response_spec.rb +34 -0
- data/spec/models/drm_configuration_spec.rb +34 -0
- data/spec/models/list_drm_configurations_response_spec.rb +34 -0
- data/vendor/bundle/ruby/3.2.0/cache/jaro_winkler-1.5.6.gem +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/mkmf.log +18 -18
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +29 -0
- 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
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/mkmf.log +4 -4
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/psych.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/mkmf.log +2 -2
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/stringio.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/lib/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/ext/jaro_winkler/Makefile +3 -3
- 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
- data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
- 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
- data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/ext/psych/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/lib/psych.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/ext/stringio/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/lib/stringio.so +0 -0
- data/vendor/bundle/ruby/3.2.0/specifications/{jaro_winkler-1.5.4.gemspec → jaro_winkler-1.5.6.gemspec} +5 -5
- metadata +191 -175
- data/vendor/bundle/ruby/3.2.0/cache/jaro_winkler-1.5.4.gem +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/gem_make.out +0 -66
- 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
- data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
- /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
- /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/LICENSE.txt +0 -0
- /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
- /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
- /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
- /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
- /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
- /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
- /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
- /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
- /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
- /data/vendor/bundle/ruby/3.2.0/gems/{jaro_winkler-1.5.4 → jaro_winkler-1.5.6}/lib/jaro_winkler.rb +0 -0
@@ -0,0 +1,148 @@
|
|
1
|
+
=begin
|
2
|
+
#Mux API
|
3
|
+
|
4
|
+
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v1
|
7
|
+
Contact: devex@mux.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.0.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module MuxRuby
|
16
|
+
class DRMConfigurationsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Retrieve a DRM Configuration
|
23
|
+
# Retrieves a single DRM Configuration.
|
24
|
+
# @param drm_configuration_id [String] The DRM Configuration ID.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [DRMConfigurationResponse]
|
27
|
+
def get_drm_configuration(drm_configuration_id, opts = {})
|
28
|
+
data, _status_code, _headers = get_drm_configuration_with_http_info(drm_configuration_id, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Retrieve a DRM Configuration
|
33
|
+
# Retrieves a single DRM Configuration.
|
34
|
+
# @param drm_configuration_id [String] The DRM Configuration ID.
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(DRMConfigurationResponse, Integer, Hash)>] DRMConfigurationResponse data, response status code and response headers
|
37
|
+
def get_drm_configuration_with_http_info(drm_configuration_id, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: DRMConfigurationsApi.get_drm_configuration ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'drm_configuration_id' is set
|
42
|
+
if @api_client.config.client_side_validation && drm_configuration_id.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'drm_configuration_id' when calling DRMConfigurationsApi.get_drm_configuration"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/video/v1/drm-configurations/{DRM_CONFIGURATION_ID}'.sub('{' + 'DRM_CONFIGURATION_ID' + '}', CGI.escape(drm_configuration_id.to_s))
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
|
56
|
+
# form parameters
|
57
|
+
form_params = opts[:form_params] || {}
|
58
|
+
|
59
|
+
# http body (model)
|
60
|
+
post_body = opts[:debug_body]
|
61
|
+
|
62
|
+
# return_type
|
63
|
+
return_type = opts[:debug_return_type] || 'DRMConfigurationResponse'
|
64
|
+
|
65
|
+
# auth_names
|
66
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
67
|
+
|
68
|
+
new_options = opts.merge(
|
69
|
+
:operation => :"DRMConfigurationsApi.get_drm_configuration",
|
70
|
+
:header_params => header_params,
|
71
|
+
:query_params => query_params,
|
72
|
+
:form_params => form_params,
|
73
|
+
:body => post_body,
|
74
|
+
:auth_names => auth_names,
|
75
|
+
:return_type => return_type
|
76
|
+
)
|
77
|
+
|
78
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
79
|
+
if @api_client.config.debugging
|
80
|
+
@api_client.config.logger.debug "API called: DRMConfigurationsApi#get_drm_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
|
+
end
|
82
|
+
return data, status_code, headers
|
83
|
+
end
|
84
|
+
|
85
|
+
# List DRM Configurations
|
86
|
+
# Returns a list of DRM Configurations
|
87
|
+
# @param [Hash] opts the optional parameters
|
88
|
+
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
89
|
+
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
90
|
+
# @return [ListDRMConfigurationsResponse]
|
91
|
+
def list_drm_configurations(opts = {})
|
92
|
+
data, _status_code, _headers = list_drm_configurations_with_http_info(opts)
|
93
|
+
data
|
94
|
+
end
|
95
|
+
|
96
|
+
# List DRM Configurations
|
97
|
+
# Returns a list of DRM Configurations
|
98
|
+
# @param [Hash] opts the optional parameters
|
99
|
+
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|
100
|
+
# @option opts [Integer] :limit Number of items to include in the response
|
101
|
+
# @return [Array<(ListDRMConfigurationsResponse, Integer, Hash)>] ListDRMConfigurationsResponse data, response status code and response headers
|
102
|
+
def list_drm_configurations_with_http_info(opts = {})
|
103
|
+
if @api_client.config.debugging
|
104
|
+
@api_client.config.logger.debug 'Calling API: DRMConfigurationsApi.list_drm_configurations ...'
|
105
|
+
end
|
106
|
+
# resource path
|
107
|
+
local_var_path = '/video/v1/drm-configurations'
|
108
|
+
|
109
|
+
# query parameters
|
110
|
+
query_params = opts[:query_params] || {}
|
111
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
112
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
113
|
+
|
114
|
+
# header parameters
|
115
|
+
header_params = opts[:header_params] || {}
|
116
|
+
# HTTP header 'Accept' (if needed)
|
117
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
118
|
+
|
119
|
+
# form parameters
|
120
|
+
form_params = opts[:form_params] || {}
|
121
|
+
|
122
|
+
# http body (model)
|
123
|
+
post_body = opts[:debug_body]
|
124
|
+
|
125
|
+
# return_type
|
126
|
+
return_type = opts[:debug_return_type] || 'ListDRMConfigurationsResponse'
|
127
|
+
|
128
|
+
# auth_names
|
129
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
130
|
+
|
131
|
+
new_options = opts.merge(
|
132
|
+
:operation => :"DRMConfigurationsApi.list_drm_configurations",
|
133
|
+
:header_params => header_params,
|
134
|
+
:query_params => query_params,
|
135
|
+
:form_params => form_params,
|
136
|
+
:body => post_body,
|
137
|
+
:auth_names => auth_names,
|
138
|
+
:return_type => return_type
|
139
|
+
)
|
140
|
+
|
141
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
142
|
+
if @api_client.config.debugging
|
143
|
+
@api_client.config.logger.debug "API called: DRMConfigurationsApi#list_drm_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
144
|
+
end
|
145
|
+
return data, status_code, headers
|
146
|
+
end
|
147
|
+
end
|
148
|
+
end
|
@@ -26,7 +26,7 @@ module MuxRuby
|
|
26
26
|
# @option opts [Array<String>] :timeframe 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`
|
27
27
|
# @option opts [Array<String>] :filters 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`
|
28
28
|
# @option opts [Array<String>] :metric_filters 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`
|
29
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
29
|
+
# @option opts [String] :measurement 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`
|
30
30
|
# @option opts [String] :order_direction Sort order.
|
31
31
|
# @option opts [String] :group_by 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.
|
32
32
|
# @return [GetMetricTimeseriesDataResponse]
|
@@ -42,7 +42,7 @@ module MuxRuby
|
|
42
42
|
# @option opts [Array<String>] :timeframe 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`
|
43
43
|
# @option opts [Array<String>] :filters 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`
|
44
44
|
# @option opts [Array<String>] :metric_filters 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`
|
45
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
45
|
+
# @option opts [String] :measurement 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`
|
46
46
|
# @option opts [String] :order_direction Sort order.
|
47
47
|
# @option opts [String] :group_by 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.
|
48
48
|
# @return [Array<(GetMetricTimeseriesDataResponse, Integer, Hash)>] GetMetricTimeseriesDataResponse data, response status code and response headers
|
@@ -124,7 +124,7 @@ module MuxRuby
|
|
124
124
|
# @option opts [Array<String>] :timeframe 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`
|
125
125
|
# @option opts [Array<String>] :filters 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`
|
126
126
|
# @option opts [Array<String>] :metric_filters 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`
|
127
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
127
|
+
# @option opts [String] :measurement 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`
|
128
128
|
# @return [GetOverallValuesResponse]
|
129
129
|
def get_overall_values(metric_id, opts = {})
|
130
130
|
data, _status_code, _headers = get_overall_values_with_http_info(metric_id, opts)
|
@@ -138,7 +138,7 @@ module MuxRuby
|
|
138
138
|
# @option opts [Array<String>] :timeframe 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`
|
139
139
|
# @option opts [Array<String>] :filters 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`
|
140
140
|
# @option opts [Array<String>] :metric_filters 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`
|
141
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
141
|
+
# @option opts [String] :measurement 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`
|
142
142
|
# @return [Array<(GetOverallValuesResponse, Integer, Hash)>] GetOverallValuesResponse data, response status code and response headers
|
143
143
|
def get_overall_values_with_http_info(metric_id, opts = {})
|
144
144
|
if @api_client.config.debugging
|
@@ -282,7 +282,7 @@ module MuxRuby
|
|
282
282
|
# @param metric_id [String] ID of the Metric
|
283
283
|
# @param [Hash] opts the optional parameters
|
284
284
|
# @option opts [String] :group_by Breakdown value to group the results by
|
285
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
285
|
+
# @option opts [String] :measurement 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`
|
286
286
|
# @option opts [Array<String>] :filters 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`
|
287
287
|
# @option opts [Array<String>] :metric_filters 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`
|
288
288
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
@@ -301,7 +301,7 @@ module MuxRuby
|
|
301
301
|
# @param metric_id [String] ID of the Metric
|
302
302
|
# @param [Hash] opts the optional parameters
|
303
303
|
# @option opts [String] :group_by Breakdown value to group the results by
|
304
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
304
|
+
# @option opts [String] :measurement 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`
|
305
305
|
# @option opts [Array<String>] :filters 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`
|
306
306
|
# @option opts [Array<String>] :metric_filters 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`
|
307
307
|
# @option opts [Integer] :limit Number of items to include in the response
|
@@ -392,7 +392,7 @@ module MuxRuby
|
|
392
392
|
# Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric.
|
393
393
|
# @param metric_id [String] ID of the Metric
|
394
394
|
# @param [Hash] opts the optional parameters
|
395
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
395
|
+
# @option opts [String] :measurement 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`
|
396
396
|
# @option opts [String] :order_direction Sort order.
|
397
397
|
# @option opts [Array<String>] :timeframe 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`
|
398
398
|
# @option opts [Array<String>] :filters 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 @@ module MuxRuby
|
|
407
407
|
# Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric.
|
408
408
|
# @param metric_id [String] ID of the Metric
|
409
409
|
# @param [Hash] opts the optional parameters
|
410
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
410
|
+
# @option opts [String] :measurement 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`
|
411
411
|
# @option opts [String] :order_direction Sort order.
|
412
412
|
# @option opts [Array<String>] :timeframe 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`
|
413
413
|
# @option opts [Array<String>] :filters 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`
|
@@ -36,9 +36,12 @@ module MuxRuby
|
|
36
36
|
# 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`.
|
37
37
|
attr_accessor :max_resolution_tier
|
38
38
|
|
39
|
-
# 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)
|
39
|
+
# 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)
|
40
40
|
attr_accessor :encoding_tier
|
41
41
|
|
42
|
+
# 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)
|
43
|
+
attr_accessor :video_quality
|
44
|
+
|
42
45
|
# 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.
|
43
46
|
attr_accessor :max_stored_frame_rate
|
44
47
|
|
@@ -125,6 +128,7 @@ module MuxRuby
|
|
125
128
|
:'resolution_tier' => :'resolution_tier',
|
126
129
|
:'max_resolution_tier' => :'max_resolution_tier',
|
127
130
|
:'encoding_tier' => :'encoding_tier',
|
131
|
+
:'video_quality' => :'video_quality',
|
128
132
|
:'max_stored_frame_rate' => :'max_stored_frame_rate',
|
129
133
|
:'aspect_ratio' => :'aspect_ratio',
|
130
134
|
:'playback_ids' => :'playback_ids',
|
@@ -164,6 +168,7 @@ module MuxRuby
|
|
164
168
|
:'resolution_tier' => :'String',
|
165
169
|
:'max_resolution_tier' => :'String',
|
166
170
|
:'encoding_tier' => :'String',
|
171
|
+
:'video_quality' => :'String',
|
167
172
|
:'max_stored_frame_rate' => :'Float',
|
168
173
|
:'aspect_ratio' => :'String',
|
169
174
|
:'playback_ids' => :'Array<PlaybackID>',
|
@@ -240,6 +245,10 @@ module MuxRuby
|
|
240
245
|
self.encoding_tier = attributes[:'encoding_tier']
|
241
246
|
end
|
242
247
|
|
248
|
+
if attributes.key?(:'video_quality')
|
249
|
+
self.video_quality = attributes[:'video_quality']
|
250
|
+
end
|
251
|
+
|
243
252
|
if attributes.key?(:'max_stored_frame_rate')
|
244
253
|
self.max_stored_frame_rate = attributes[:'max_stored_frame_rate']
|
245
254
|
end
|
@@ -353,6 +362,8 @@ module MuxRuby
|
|
353
362
|
return false unless max_resolution_tier_validator.valid?(@max_resolution_tier)
|
354
363
|
encoding_tier_validator = EnumAttributeValidator.new('String', ["smart", "baseline"])
|
355
364
|
return false unless encoding_tier_validator.valid?(@encoding_tier)
|
365
|
+
video_quality_validator = EnumAttributeValidator.new('String', ["basic", "plus"])
|
366
|
+
return false unless video_quality_validator.valid?(@video_quality)
|
356
367
|
master_access_validator = EnumAttributeValidator.new('String', ["temporary", "none"])
|
357
368
|
return false unless master_access_validator.valid?(@master_access)
|
358
369
|
mp4_support_validator = EnumAttributeValidator.new('String', ["standard", "none", "capped-1080p", "audio-only", "audio-only,capped-1080p"])
|
@@ -412,6 +423,16 @@ module MuxRuby
|
|
412
423
|
@encoding_tier = encoding_tier
|
413
424
|
end
|
414
425
|
|
426
|
+
# Custom attribute writer method checking allowed values (enum).
|
427
|
+
# @param [Object] video_quality Object to be assigned
|
428
|
+
def video_quality=(video_quality)
|
429
|
+
validator = EnumAttributeValidator.new('String', ["basic", "plus"])
|
430
|
+
unless validator.valid?(video_quality)
|
431
|
+
fail ArgumentError, "invalid value for \"video_quality\", must be one of #{validator.allowable_values}."
|
432
|
+
end
|
433
|
+
@video_quality = video_quality
|
434
|
+
end
|
435
|
+
|
415
436
|
# Custom attribute writer method checking allowed values (enum).
|
416
437
|
# @param [Object] master_access Object to be assigned
|
417
438
|
def master_access=(master_access)
|
@@ -455,6 +476,7 @@ module MuxRuby
|
|
455
476
|
resolution_tier == o.resolution_tier &&
|
456
477
|
max_resolution_tier == o.max_resolution_tier &&
|
457
478
|
encoding_tier == o.encoding_tier &&
|
479
|
+
video_quality == o.video_quality &&
|
458
480
|
max_stored_frame_rate == o.max_stored_frame_rate &&
|
459
481
|
aspect_ratio == o.aspect_ratio &&
|
460
482
|
playback_ids == o.playback_ids &&
|
@@ -486,7 +508,7 @@ module MuxRuby
|
|
486
508
|
# Calculates hash code according to all attributes.
|
487
509
|
# @return [Integer] Hash code
|
488
510
|
def hash
|
489
|
-
[id, created_at, status, duration, max_stored_resolution, resolution_tier, max_resolution_tier, encoding_tier, max_stored_frame_rate, aspect_ratio, playback_ids, tracks, errors, per_title_encode, upload_id, is_live, passthrough, live_stream_id, master, master_access, mp4_support, source_asset_id, normalize_audio, static_renditions, recording_times, non_standard_input_reasons, test, ingest_type].hash
|
511
|
+
[id, created_at, status, duration, max_stored_resolution, resolution_tier, max_resolution_tier, encoding_tier, video_quality, max_stored_frame_rate, aspect_ratio, playback_ids, tracks, errors, per_title_encode, upload_id, is_live, passthrough, live_stream_id, master, master_access, mp4_support, source_asset_id, normalize_audio, static_renditions, recording_times, non_standard_input_reasons, test, ingest_type].hash
|
490
512
|
end
|
491
513
|
|
492
514
|
# Builds the object from hash
|
@@ -18,9 +18,12 @@ module MuxRuby
|
|
18
18
|
# 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.
|
19
19
|
attr_accessor :input
|
20
20
|
|
21
|
-
# 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).
|
21
|
+
# 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.
|
22
22
|
attr_accessor :playback_policy
|
23
23
|
|
24
|
+
# 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.
|
25
|
+
attr_accessor :advanced_playback_policies
|
26
|
+
|
24
27
|
attr_accessor :per_title_encode
|
25
28
|
|
26
29
|
# 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**.
|
@@ -41,9 +44,12 @@ module MuxRuby
|
|
41
44
|
# 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`.
|
42
45
|
attr_accessor :max_resolution_tier
|
43
46
|
|
44
|
-
# 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)
|
47
|
+
# 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)
|
45
48
|
attr_accessor :encoding_tier
|
46
49
|
|
50
|
+
# 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)
|
51
|
+
attr_accessor :video_quality
|
52
|
+
|
47
53
|
class EnumAttributeValidator
|
48
54
|
attr_reader :datatype
|
49
55
|
attr_reader :allowable_values
|
@@ -71,6 +77,7 @@ module MuxRuby
|
|
71
77
|
{
|
72
78
|
:'input' => :'input',
|
73
79
|
:'playback_policy' => :'playback_policy',
|
80
|
+
:'advanced_playback_policies' => :'advanced_playback_policies',
|
74
81
|
:'per_title_encode' => :'per_title_encode',
|
75
82
|
:'passthrough' => :'passthrough',
|
76
83
|
:'mp4_support' => :'mp4_support',
|
@@ -78,7 +85,8 @@ module MuxRuby
|
|
78
85
|
:'master_access' => :'master_access',
|
79
86
|
:'test' => :'test',
|
80
87
|
:'max_resolution_tier' => :'max_resolution_tier',
|
81
|
-
:'encoding_tier' => :'encoding_tier'
|
88
|
+
:'encoding_tier' => :'encoding_tier',
|
89
|
+
:'video_quality' => :'video_quality'
|
82
90
|
}
|
83
91
|
end
|
84
92
|
|
@@ -92,6 +100,7 @@ module MuxRuby
|
|
92
100
|
{
|
93
101
|
:'input' => :'Array<InputSettings>',
|
94
102
|
:'playback_policy' => :'Array<PlaybackPolicy>',
|
103
|
+
:'advanced_playback_policies' => :'Array<CreatePlaybackIDRequest>',
|
95
104
|
:'per_title_encode' => :'Boolean',
|
96
105
|
:'passthrough' => :'String',
|
97
106
|
:'mp4_support' => :'String',
|
@@ -99,7 +108,8 @@ module MuxRuby
|
|
99
108
|
:'master_access' => :'String',
|
100
109
|
:'test' => :'Boolean',
|
101
110
|
:'max_resolution_tier' => :'String',
|
102
|
-
:'encoding_tier' => :'String'
|
111
|
+
:'encoding_tier' => :'String',
|
112
|
+
:'video_quality' => :'String'
|
103
113
|
}
|
104
114
|
end
|
105
115
|
|
@@ -136,6 +146,12 @@ module MuxRuby
|
|
136
146
|
end
|
137
147
|
end
|
138
148
|
|
149
|
+
if attributes.key?(:'advanced_playback_policies')
|
150
|
+
if (value = attributes[:'advanced_playback_policies']).is_a?(Array)
|
151
|
+
self.advanced_playback_policies = value
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
139
155
|
if attributes.key?(:'per_title_encode')
|
140
156
|
self.per_title_encode = attributes[:'per_title_encode']
|
141
157
|
end
|
@@ -169,6 +185,10 @@ module MuxRuby
|
|
169
185
|
if attributes.key?(:'encoding_tier')
|
170
186
|
self.encoding_tier = attributes[:'encoding_tier']
|
171
187
|
end
|
188
|
+
|
189
|
+
if attributes.key?(:'video_quality')
|
190
|
+
self.video_quality = attributes[:'video_quality']
|
191
|
+
end
|
172
192
|
end
|
173
193
|
|
174
194
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -189,6 +209,8 @@ module MuxRuby
|
|
189
209
|
return false unless max_resolution_tier_validator.valid?(@max_resolution_tier)
|
190
210
|
encoding_tier_validator = EnumAttributeValidator.new('String', ["smart", "baseline"])
|
191
211
|
return false unless encoding_tier_validator.valid?(@encoding_tier)
|
212
|
+
video_quality_validator = EnumAttributeValidator.new('String', ["basic", "plus"])
|
213
|
+
return false unless video_quality_validator.valid?(@video_quality)
|
192
214
|
true
|
193
215
|
end
|
194
216
|
|
@@ -232,6 +254,16 @@ module MuxRuby
|
|
232
254
|
@encoding_tier = encoding_tier
|
233
255
|
end
|
234
256
|
|
257
|
+
# Custom attribute writer method checking allowed values (enum).
|
258
|
+
# @param [Object] video_quality Object to be assigned
|
259
|
+
def video_quality=(video_quality)
|
260
|
+
validator = EnumAttributeValidator.new('String', ["basic", "plus"])
|
261
|
+
unless validator.valid?(video_quality)
|
262
|
+
fail ArgumentError, "invalid value for \"video_quality\", must be one of #{validator.allowable_values}."
|
263
|
+
end
|
264
|
+
@video_quality = video_quality
|
265
|
+
end
|
266
|
+
|
235
267
|
# Checks equality by comparing each attribute.
|
236
268
|
# @param [Object] Object to be compared
|
237
269
|
def ==(o)
|
@@ -239,6 +271,7 @@ module MuxRuby
|
|
239
271
|
self.class == o.class &&
|
240
272
|
input == o.input &&
|
241
273
|
playback_policy == o.playback_policy &&
|
274
|
+
advanced_playback_policies == o.advanced_playback_policies &&
|
242
275
|
per_title_encode == o.per_title_encode &&
|
243
276
|
passthrough == o.passthrough &&
|
244
277
|
mp4_support == o.mp4_support &&
|
@@ -246,7 +279,8 @@ module MuxRuby
|
|
246
279
|
master_access == o.master_access &&
|
247
280
|
test == o.test &&
|
248
281
|
max_resolution_tier == o.max_resolution_tier &&
|
249
|
-
encoding_tier == o.encoding_tier
|
282
|
+
encoding_tier == o.encoding_tier &&
|
283
|
+
video_quality == o.video_quality
|
250
284
|
end
|
251
285
|
|
252
286
|
# @see the `==` method
|
@@ -258,7 +292,7 @@ module MuxRuby
|
|
258
292
|
# Calculates hash code according to all attributes.
|
259
293
|
# @return [Integer] Hash code
|
260
294
|
def hash
|
261
|
-
[input, playback_policy, per_title_encode, passthrough, mp4_support, normalize_audio, master_access, test, max_resolution_tier, encoding_tier].hash
|
295
|
+
[input, playback_policy, advanced_playback_policies, per_title_encode, passthrough, mp4_support, normalize_audio, master_access, test, max_resolution_tier, encoding_tier, video_quality].hash
|
262
296
|
end
|
263
297
|
|
264
298
|
# Builds the object from hash
|
@@ -17,6 +17,9 @@ module MuxRuby
|
|
17
17
|
class CreateLiveStreamRequest
|
18
18
|
attr_accessor :playback_policy
|
19
19
|
|
20
|
+
# 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.
|
21
|
+
attr_accessor :advanced_playback_policies
|
22
|
+
|
20
23
|
attr_accessor :new_asset_settings
|
21
24
|
|
22
25
|
# 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.
|
@@ -82,6 +85,7 @@ module MuxRuby
|
|
82
85
|
def self.attribute_map
|
83
86
|
{
|
84
87
|
:'playback_policy' => :'playback_policy',
|
88
|
+
:'advanced_playback_policies' => :'advanced_playback_policies',
|
85
89
|
:'new_asset_settings' => :'new_asset_settings',
|
86
90
|
:'reconnect_window' => :'reconnect_window',
|
87
91
|
:'use_slate_for_standard_latency' => :'use_slate_for_standard_latency',
|
@@ -108,6 +112,7 @@ module MuxRuby
|
|
108
112
|
def self.openapi_types
|
109
113
|
{
|
110
114
|
:'playback_policy' => :'Array<PlaybackPolicy>',
|
115
|
+
:'advanced_playback_policies' => :'Array<CreatePlaybackIDRequest>',
|
111
116
|
:'new_asset_settings' => :'CreateAssetRequest',
|
112
117
|
:'reconnect_window' => :'Float',
|
113
118
|
:'use_slate_for_standard_latency' => :'Boolean',
|
@@ -152,6 +157,12 @@ module MuxRuby
|
|
152
157
|
end
|
153
158
|
end
|
154
159
|
|
160
|
+
if attributes.key?(:'advanced_playback_policies')
|
161
|
+
if (value = attributes[:'advanced_playback_policies']).is_a?(Array)
|
162
|
+
self.advanced_playback_policies = value
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
155
166
|
if attributes.key?(:'new_asset_settings')
|
156
167
|
self.new_asset_settings = attributes[:'new_asset_settings']
|
157
168
|
end
|
@@ -300,6 +311,7 @@ module MuxRuby
|
|
300
311
|
return true if self.equal?(o)
|
301
312
|
self.class == o.class &&
|
302
313
|
playback_policy == o.playback_policy &&
|
314
|
+
advanced_playback_policies == o.advanced_playback_policies &&
|
303
315
|
new_asset_settings == o.new_asset_settings &&
|
304
316
|
reconnect_window == o.reconnect_window &&
|
305
317
|
use_slate_for_standard_latency == o.use_slate_for_standard_latency &&
|
@@ -325,7 +337,7 @@ module MuxRuby
|
|
325
337
|
# Calculates hash code according to all attributes.
|
326
338
|
# @return [Integer] Hash code
|
327
339
|
def hash
|
328
|
-
[playback_policy, new_asset_settings, reconnect_window, use_slate_for_standard_latency, reconnect_slate_url, passthrough, audio_only, embedded_subtitles, generated_subtitles, reduced_latency, low_latency, latency_mode, test, simulcast_targets, max_continuous_duration].hash
|
340
|
+
[playback_policy, advanced_playback_policies, new_asset_settings, reconnect_window, use_slate_for_standard_latency, reconnect_slate_url, passthrough, audio_only, embedded_subtitles, generated_subtitles, reduced_latency, low_latency, latency_mode, test, simulcast_targets, max_continuous_duration].hash
|
329
341
|
end
|
330
342
|
|
331
343
|
# Builds the object from hash
|
@@ -17,10 +17,14 @@ module MuxRuby
|
|
17
17
|
class CreatePlaybackIDRequest
|
18
18
|
attr_accessor :policy
|
19
19
|
|
20
|
+
# The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.
|
21
|
+
attr_accessor :drm_configuration_id
|
22
|
+
|
20
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
21
24
|
def self.attribute_map
|
22
25
|
{
|
23
|
-
:'policy' => :'policy'
|
26
|
+
:'policy' => :'policy',
|
27
|
+
:'drm_configuration_id' => :'drm_configuration_id'
|
24
28
|
}
|
25
29
|
end
|
26
30
|
|
@@ -32,7 +36,8 @@ module MuxRuby
|
|
32
36
|
# Attribute type mapping.
|
33
37
|
def self.openapi_types
|
34
38
|
{
|
35
|
-
:'policy' => :'PlaybackPolicy'
|
39
|
+
:'policy' => :'PlaybackPolicy',
|
40
|
+
:'drm_configuration_id' => :'String'
|
36
41
|
}
|
37
42
|
end
|
38
43
|
|
@@ -60,6 +65,10 @@ module MuxRuby
|
|
60
65
|
if attributes.key?(:'policy')
|
61
66
|
self.policy = attributes[:'policy']
|
62
67
|
end
|
68
|
+
|
69
|
+
if attributes.key?(:'drm_configuration_id')
|
70
|
+
self.drm_configuration_id = attributes[:'drm_configuration_id']
|
71
|
+
end
|
63
72
|
end
|
64
73
|
|
65
74
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -80,7 +89,8 @@ module MuxRuby
|
|
80
89
|
def ==(o)
|
81
90
|
return true if self.equal?(o)
|
82
91
|
self.class == o.class &&
|
83
|
-
policy == o.policy
|
92
|
+
policy == o.policy &&
|
93
|
+
drm_configuration_id == o.drm_configuration_id
|
84
94
|
end
|
85
95
|
|
86
96
|
# @see the `==` method
|
@@ -92,7 +102,7 @@ module MuxRuby
|
|
92
102
|
# Calculates hash code according to all attributes.
|
93
103
|
# @return [Integer] Hash code
|
94
104
|
def hash
|
95
|
-
[policy].hash
|
105
|
+
[policy, drm_configuration_id].hash
|
96
106
|
end
|
97
107
|
|
98
108
|
# Builds the object from hash
|
@@ -23,6 +23,7 @@ module MuxRuby
|
|
23
23
|
|
24
24
|
attr_accessor :new_asset_settings
|
25
25
|
|
26
|
+
# Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a `test` Asset.
|
26
27
|
attr_accessor :test
|
27
28
|
|
28
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|