mux_ruby 3.19.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +8 -4
- data/docs/AssetStaticRenditions.md +2 -2
- data/docs/AssetsApi.md +146 -1
- data/docs/CreateAssetRequest.md +4 -2
- data/docs/CreateStaticRenditionRequest.md +20 -0
- data/docs/CreateStaticRenditionResponse.md +18 -0
- data/docs/InputSettings.md +1 -1
- data/docs/LiveStreamsApi.md +143 -0
- data/docs/MetricsApi.md +8 -8
- data/docs/StaticRendition.md +40 -0
- data/docs/UpdateLiveStreamNewAssetSettings.md +4 -2
- data/docs/UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest.md +18 -0
- data/docs/VideoView.md +33 -5
- data/gen/generator-config.json +1 -1
- data/gen/templates/README.mustache +4 -0
- data/lib/mux_ruby/api/assets_api.rb +140 -2
- data/lib/mux_ruby/api/live_streams_api.rb +132 -0
- data/lib/mux_ruby/api/metrics_api.rb +14 -14
- data/lib/mux_ruby/models/asset_static_renditions.rb +2 -2
- data/lib/mux_ruby/models/create_asset_request.rb +17 -5
- data/lib/mux_ruby/models/{create_broadcast_request.rb → create_static_rendition_request.rb} +49 -53
- data/lib/mux_ruby/models/{start_space_broadcast_response.rb → create_static_rendition_response.rb} +4 -4
- data/lib/mux_ruby/models/input_settings.rb +1 -1
- data/lib/mux_ruby/models/{asset_static_renditions_files.rb → static_rendition.rb} +118 -9
- data/lib/mux_ruby/models/update_live_stream_new_asset_settings.rb +28 -6
- data/lib/mux_ruby/models/{list_spaces_response.rb → update_live_stream_new_asset_settings_static_renditions_request.rb} +11 -16
- data/lib/mux_ruby/models/video_view.rb +158 -21
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +4 -16
- data/spec/models/create_static_rendition_request_spec.rb +44 -0
- data/spec/models/create_static_rendition_response_spec.rb +34 -0
- data/spec/models/static_rendition_spec.rb +124 -0
- data/spec/models/update_live_stream_new_asset_settings_static_renditions_request_spec.rb +34 -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 +8 -8
- 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 +19 -19
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +7 -7
- 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 +5 -5
- 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.6/ext/jaro_winkler/Makefile +3 -3
- 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/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
- metadata +172 -191
- data/docs/AssetStaticRenditionsFiles.md +0 -28
- data/docs/Broadcast.md +0 -30
- data/docs/BroadcastLayout.md +0 -15
- data/docs/BroadcastResolution.md +0 -15
- data/docs/BroadcastResponse.md +0 -18
- data/docs/BroadcastStatus.md +0 -15
- data/docs/CreateBroadcastRequest.md +0 -26
- data/docs/CreateSpaceRequest.md +0 -22
- data/docs/ListSpacesResponse.md +0 -18
- data/docs/Space.md +0 -30
- data/docs/SpaceResponse.md +0 -18
- data/docs/SpaceStatus.md +0 -15
- data/docs/SpaceType.md +0 -15
- data/docs/SpacesApi.md +0 -658
- data/docs/StartSpaceBroadcastResponse.md +0 -18
- data/docs/StopSpaceBroadcastResponse.md +0 -18
- data/lib/mux_ruby/api/spaces_api.rb +0 -619
- data/lib/mux_ruby/models/broadcast.rb +0 -305
- data/lib/mux_ruby/models/broadcast_layout.rb +0 -38
- data/lib/mux_ruby/models/broadcast_resolution.rb +0 -41
- data/lib/mux_ruby/models/broadcast_response.rb +0 -223
- data/lib/mux_ruby/models/broadcast_status.rb +0 -37
- data/lib/mux_ruby/models/create_space_request.rb +0 -242
- data/lib/mux_ruby/models/space.rb +0 -301
- data/lib/mux_ruby/models/space_response.rb +0 -223
- data/lib/mux_ruby/models/space_status.rb +0 -37
- data/lib/mux_ruby/models/space_type.rb +0 -36
- data/lib/mux_ruby/models/stop_space_broadcast_response.rb +0 -218
|
@@ -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`, `view_dropped_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. 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`, `
|
|
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`, `aggregate_startup_time`, `content_startup_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`, `view_dropped_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`, `view_dropped_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. 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`, `
|
|
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`, `aggregate_startup_time`, `content_startup_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`, `view_dropped_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
|
|
@@ -55,7 +55,7 @@ module MuxRuby
|
|
|
55
55
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_metric_timeseries_data"
|
|
56
56
|
end
|
|
57
57
|
# verify enum value
|
|
58
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "
|
|
58
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "view_dropped_percentage"]
|
|
59
59
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
60
60
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
61
61
|
end
|
|
@@ -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`, `view_dropped_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. 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`, `
|
|
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`, `aggregate_startup_time`, `content_startup_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`, `view_dropped_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`, `view_dropped_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. 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`, `
|
|
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`, `aggregate_startup_time`, `content_startup_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`, `view_dropped_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
|
|
@@ -149,7 +149,7 @@ module MuxRuby
|
|
|
149
149
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_overall_values"
|
|
150
150
|
end
|
|
151
151
|
# verify enum value
|
|
152
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "
|
|
152
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "view_dropped_percentage"]
|
|
153
153
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
154
154
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
155
155
|
end
|
|
@@ -228,7 +228,7 @@ module MuxRuby
|
|
|
228
228
|
if @api_client.config.debugging
|
|
229
229
|
@api_client.config.logger.debug 'Calling API: MetricsApi.list_all_metric_values ...'
|
|
230
230
|
end
|
|
231
|
-
allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_failure", "video_startup_business_exception", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure", "view_dropped"]
|
|
231
|
+
allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_failure", "video_startup_business_exception", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure", "view_dropped", "client_application_name", "client_application_version", "video_affiliate", "viewer_plan", "viewer_plan_status", "viewer_plan_category", "view_drm_level", "video_brand", "used_pip", "time_shift_enabled", "used_captions", "video_codec", "audio_codec", "video_dynamic_range_type", "view_cdn_edge_pop", "view_cdn_origin"]
|
|
232
232
|
if @api_client.config.client_side_validation && opts[:'dimension'] && !allowable_values.include?(opts[:'dimension'])
|
|
233
233
|
fail ArgumentError, "invalid value for \"dimension\", must be one of #{allowable_values}"
|
|
234
234
|
end
|
|
@@ -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. 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`, `
|
|
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`, `aggregate_startup_time`, `content_startup_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`, `view_dropped_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`, `view_dropped_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. 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`, `
|
|
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`, `aggregate_startup_time`, `content_startup_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`, `view_dropped_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`, `view_dropped_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
|
307
307
|
# @option opts [Integer] :limit Number of items to include in the response
|
|
@@ -319,11 +319,11 @@ module MuxRuby
|
|
|
319
319
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_breakdown_values"
|
|
320
320
|
end
|
|
321
321
|
# verify enum value
|
|
322
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "
|
|
322
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "view_dropped_percentage"]
|
|
323
323
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
324
324
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
325
325
|
end
|
|
326
|
-
allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_business_exception", "video_startup_failure", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure", "view_dropped"]
|
|
326
|
+
allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_business_exception", "video_startup_failure", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure", "view_dropped", "client_application_name", "client_application_version", "video_affiliate", "viewer_plan", "viewer_plan_status", "viewer_plan_category", "view_drm_level", "video_brand", "used_pip", "time_shift_enabled", "used_captions", "video_codec", "audio_codec", "video_dynamic_range_type", "view_cdn_edge_pop", "view_cdn_origin"]
|
|
327
327
|
if @api_client.config.client_side_validation && opts[:'group_by'] && !allowable_values.include?(opts[:'group_by'])
|
|
328
328
|
fail ArgumentError, "invalid value for \"group_by\", must be one of #{allowable_values}"
|
|
329
329
|
end
|
|
@@ -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. 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`, `
|
|
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`, `aggregate_startup_time`, `content_startup_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`, `view_dropped_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. 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`, `
|
|
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`, `aggregate_startup_time`, `content_startup_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`, `view_dropped_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`
|
|
@@ -422,7 +422,7 @@ module MuxRuby
|
|
|
422
422
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_insights"
|
|
423
423
|
end
|
|
424
424
|
# verify enum value
|
|
425
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "
|
|
425
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "view_dropped_percentage"]
|
|
426
426
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
427
427
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
428
428
|
end
|
|
@@ -16,7 +16,7 @@ require 'time'
|
|
|
16
16
|
module MuxRuby
|
|
17
17
|
# An object containing the current status of any static renditions (mp4s). The object does not exist if no static renditions have been requested. See [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information.
|
|
18
18
|
class AssetStaticRenditions
|
|
19
|
-
# Indicates the status of downloadable MP4 versions of this asset.
|
|
19
|
+
# Indicates the status of downloadable MP4 versions of this asset. This field is only valid when `mp4_support` is enabled
|
|
20
20
|
attr_accessor :status
|
|
21
21
|
|
|
22
22
|
# Array of file objects.
|
|
@@ -61,7 +61,7 @@ module MuxRuby
|
|
|
61
61
|
def self.openapi_types
|
|
62
62
|
{
|
|
63
63
|
:'status' => :'String',
|
|
64
|
-
:'files' => :'Array<
|
|
64
|
+
:'files' => :'Array<StaticRendition>'
|
|
65
65
|
}
|
|
66
66
|
end
|
|
67
67
|
|
|
@@ -29,7 +29,7 @@ module MuxRuby
|
|
|
29
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**.
|
|
30
30
|
attr_accessor :passthrough
|
|
31
31
|
|
|
32
|
-
# 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.
|
|
32
|
+
# Deprecated. See the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions) for the updated API. Specify what level of support for mp4 playback. You may not enable both `mp4_support` and `static_renditions`. * 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.
|
|
33
33
|
attr_accessor :mp4_support
|
|
34
34
|
|
|
35
35
|
# Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.
|
|
@@ -50,6 +50,9 @@ module MuxRuby
|
|
|
50
50
|
# The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
|
|
51
51
|
attr_accessor :video_quality
|
|
52
52
|
|
|
53
|
+
# An array of static renditions to create for this asset. You may not enable both `static_renditions` and `mp4_support (the latter being deprecated)`
|
|
54
|
+
attr_accessor :static_renditions
|
|
55
|
+
|
|
53
56
|
class EnumAttributeValidator
|
|
54
57
|
attr_reader :datatype
|
|
55
58
|
attr_reader :allowable_values
|
|
@@ -86,7 +89,8 @@ module MuxRuby
|
|
|
86
89
|
:'test' => :'test',
|
|
87
90
|
:'max_resolution_tier' => :'max_resolution_tier',
|
|
88
91
|
:'encoding_tier' => :'encoding_tier',
|
|
89
|
-
:'video_quality' => :'video_quality'
|
|
92
|
+
:'video_quality' => :'video_quality',
|
|
93
|
+
:'static_renditions' => :'static_renditions'
|
|
90
94
|
}
|
|
91
95
|
end
|
|
92
96
|
|
|
@@ -109,7 +113,8 @@ module MuxRuby
|
|
|
109
113
|
:'test' => :'Boolean',
|
|
110
114
|
:'max_resolution_tier' => :'String',
|
|
111
115
|
:'encoding_tier' => :'String',
|
|
112
|
-
:'video_quality' => :'String'
|
|
116
|
+
:'video_quality' => :'String',
|
|
117
|
+
:'static_renditions' => :'Array<CreateStaticRenditionRequest>'
|
|
113
118
|
}
|
|
114
119
|
end
|
|
115
120
|
|
|
@@ -189,6 +194,12 @@ module MuxRuby
|
|
|
189
194
|
if attributes.key?(:'video_quality')
|
|
190
195
|
self.video_quality = attributes[:'video_quality']
|
|
191
196
|
end
|
|
197
|
+
|
|
198
|
+
if attributes.key?(:'static_renditions')
|
|
199
|
+
if (value = attributes[:'static_renditions']).is_a?(Array)
|
|
200
|
+
self.static_renditions = value
|
|
201
|
+
end
|
|
202
|
+
end
|
|
192
203
|
end
|
|
193
204
|
|
|
194
205
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -280,7 +291,8 @@ module MuxRuby
|
|
|
280
291
|
test == o.test &&
|
|
281
292
|
max_resolution_tier == o.max_resolution_tier &&
|
|
282
293
|
encoding_tier == o.encoding_tier &&
|
|
283
|
-
video_quality == o.video_quality
|
|
294
|
+
video_quality == o.video_quality &&
|
|
295
|
+
static_renditions == o.static_renditions
|
|
284
296
|
end
|
|
285
297
|
|
|
286
298
|
# @see the `==` method
|
|
@@ -292,7 +304,7 @@ module MuxRuby
|
|
|
292
304
|
# Calculates hash code according to all attributes.
|
|
293
305
|
# @return [Integer] Hash code
|
|
294
306
|
def 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
|
|
307
|
+
[input, playback_policy, advanced_playback_policies, per_title_encode, passthrough, mp4_support, normalize_audio, master_access, test, max_resolution_tier, encoding_tier, video_quality, static_renditions].hash
|
|
296
308
|
end
|
|
297
309
|
|
|
298
310
|
# Builds the object from hash
|
|
@@ -14,28 +14,39 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module MuxRuby
|
|
17
|
-
class
|
|
18
|
-
|
|
19
|
-
attr_accessor :passthrough
|
|
20
|
-
|
|
21
|
-
# The ID of the live stream that you want to broadcast to.
|
|
22
|
-
attr_accessor :live_stream_id
|
|
17
|
+
class CreateStaticRenditionRequest
|
|
18
|
+
attr_accessor :resolution
|
|
23
19
|
|
|
24
|
-
|
|
20
|
+
# Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.
|
|
21
|
+
attr_accessor :passthrough
|
|
25
22
|
|
|
26
|
-
|
|
27
|
-
|
|
23
|
+
class EnumAttributeValidator
|
|
24
|
+
attr_reader :datatype
|
|
25
|
+
attr_reader :allowable_values
|
|
26
|
+
|
|
27
|
+
def initialize(datatype, allowable_values)
|
|
28
|
+
@allowable_values = allowable_values.map do |value|
|
|
29
|
+
case datatype.to_s
|
|
30
|
+
when /Integer/i
|
|
31
|
+
value.to_i
|
|
32
|
+
when /Float/i
|
|
33
|
+
value.to_f
|
|
34
|
+
else
|
|
35
|
+
value
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
28
39
|
|
|
29
|
-
|
|
40
|
+
def valid?(value)
|
|
41
|
+
!value || allowable_values.include?(value)
|
|
42
|
+
end
|
|
43
|
+
end
|
|
30
44
|
|
|
31
45
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
32
46
|
def self.attribute_map
|
|
33
47
|
{
|
|
34
|
-
:'
|
|
35
|
-
:'
|
|
36
|
-
:'layout' => :'layout',
|
|
37
|
-
:'background' => :'background',
|
|
38
|
-
:'resolution' => :'resolution'
|
|
48
|
+
:'resolution' => :'resolution',
|
|
49
|
+
:'passthrough' => :'passthrough'
|
|
39
50
|
}
|
|
40
51
|
end
|
|
41
52
|
|
|
@@ -47,11 +58,8 @@ module MuxRuby
|
|
|
47
58
|
# Attribute type mapping.
|
|
48
59
|
def self.openapi_types
|
|
49
60
|
{
|
|
50
|
-
:'
|
|
51
|
-
:'
|
|
52
|
-
:'layout' => :'BroadcastLayout',
|
|
53
|
-
:'background' => :'String',
|
|
54
|
-
:'resolution' => :'BroadcastResolution'
|
|
61
|
+
:'resolution' => :'String',
|
|
62
|
+
:'passthrough' => :'String'
|
|
55
63
|
}
|
|
56
64
|
end
|
|
57
65
|
|
|
@@ -65,39 +73,23 @@ module MuxRuby
|
|
|
65
73
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
66
74
|
def initialize(attributes = {})
|
|
67
75
|
if (!attributes.is_a?(Hash))
|
|
68
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::
|
|
76
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::CreateStaticRenditionRequest` initialize method"
|
|
69
77
|
end
|
|
70
78
|
|
|
71
79
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
72
80
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
73
81
|
if (!self.class.attribute_map.key?(k.to_sym))
|
|
74
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `MuxRuby::
|
|
82
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `MuxRuby::CreateStaticRenditionRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
75
83
|
end
|
|
76
84
|
h[k.to_sym] = v
|
|
77
85
|
}
|
|
78
86
|
|
|
79
|
-
if attributes.key?(:'passthrough')
|
|
80
|
-
self.passthrough = attributes[:'passthrough']
|
|
81
|
-
end
|
|
82
|
-
|
|
83
|
-
if attributes.key?(:'live_stream_id')
|
|
84
|
-
self.live_stream_id = attributes[:'live_stream_id']
|
|
85
|
-
end
|
|
86
|
-
|
|
87
|
-
if attributes.key?(:'layout')
|
|
88
|
-
self.layout = attributes[:'layout']
|
|
89
|
-
else
|
|
90
|
-
self.layout = 'gallery'
|
|
91
|
-
end
|
|
92
|
-
|
|
93
|
-
if attributes.key?(:'background')
|
|
94
|
-
self.background = attributes[:'background']
|
|
95
|
-
end
|
|
96
|
-
|
|
97
87
|
if attributes.key?(:'resolution')
|
|
98
88
|
self.resolution = attributes[:'resolution']
|
|
99
|
-
|
|
100
|
-
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
if attributes.key?(:'passthrough')
|
|
92
|
+
self.passthrough = attributes[:'passthrough']
|
|
101
93
|
end
|
|
102
94
|
end
|
|
103
95
|
|
|
@@ -105,30 +97,34 @@ module MuxRuby
|
|
|
105
97
|
# @return Array for valid properties with the reasons
|
|
106
98
|
def list_invalid_properties
|
|
107
99
|
invalid_properties = Array.new
|
|
108
|
-
if @live_stream_id.nil?
|
|
109
|
-
invalid_properties.push('invalid value for "live_stream_id", live_stream_id cannot be nil.')
|
|
110
|
-
end
|
|
111
|
-
|
|
112
100
|
invalid_properties
|
|
113
101
|
end
|
|
114
102
|
|
|
115
103
|
# Check to see if the all the properties in the model are valid
|
|
116
104
|
# @return true if the model is valid
|
|
117
105
|
def valid?
|
|
118
|
-
|
|
106
|
+
resolution_validator = EnumAttributeValidator.new('String', ["highest", "audio-only", "2160p", "1440p", "1080p", "720p", "540p", "480p", "360p", "270p"])
|
|
107
|
+
return false unless resolution_validator.valid?(@resolution)
|
|
119
108
|
true
|
|
120
109
|
end
|
|
121
110
|
|
|
111
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
112
|
+
# @param [Object] resolution Object to be assigned
|
|
113
|
+
def resolution=(resolution)
|
|
114
|
+
validator = EnumAttributeValidator.new('String', ["highest", "audio-only", "2160p", "1440p", "1080p", "720p", "540p", "480p", "360p", "270p"])
|
|
115
|
+
unless validator.valid?(resolution)
|
|
116
|
+
fail ArgumentError, "invalid value for \"resolution\", must be one of #{validator.allowable_values}."
|
|
117
|
+
end
|
|
118
|
+
@resolution = resolution
|
|
119
|
+
end
|
|
120
|
+
|
|
122
121
|
# Checks equality by comparing each attribute.
|
|
123
122
|
# @param [Object] Object to be compared
|
|
124
123
|
def ==(o)
|
|
125
124
|
return true if self.equal?(o)
|
|
126
125
|
self.class == o.class &&
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
layout == o.layout &&
|
|
130
|
-
background == o.background &&
|
|
131
|
-
resolution == o.resolution
|
|
126
|
+
resolution == o.resolution &&
|
|
127
|
+
passthrough == o.passthrough
|
|
132
128
|
end
|
|
133
129
|
|
|
134
130
|
# @see the `==` method
|
|
@@ -140,7 +136,7 @@ module MuxRuby
|
|
|
140
136
|
# Calculates hash code according to all attributes.
|
|
141
137
|
# @return [Integer] Hash code
|
|
142
138
|
def hash
|
|
143
|
-
[
|
|
139
|
+
[resolution, passthrough].hash
|
|
144
140
|
end
|
|
145
141
|
|
|
146
142
|
# Builds the object from hash
|
data/lib/mux_ruby/models/{start_space_broadcast_response.rb → create_static_rendition_response.rb}
RENAMED
|
@@ -14,7 +14,7 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module MuxRuby
|
|
17
|
-
class
|
|
17
|
+
class CreateStaticRenditionResponse
|
|
18
18
|
attr_accessor :data
|
|
19
19
|
|
|
20
20
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -32,7 +32,7 @@ module MuxRuby
|
|
|
32
32
|
# Attribute type mapping.
|
|
33
33
|
def self.openapi_types
|
|
34
34
|
{
|
|
35
|
-
:'data' => :'
|
|
35
|
+
:'data' => :'StaticRendition'
|
|
36
36
|
}
|
|
37
37
|
end
|
|
38
38
|
|
|
@@ -46,13 +46,13 @@ module MuxRuby
|
|
|
46
46
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
47
47
|
def initialize(attributes = {})
|
|
48
48
|
if (!attributes.is_a?(Hash))
|
|
49
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::
|
|
49
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::CreateStaticRenditionResponse` initialize method"
|
|
50
50
|
end
|
|
51
51
|
|
|
52
52
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
53
53
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
54
54
|
if (!self.class.attribute_map.key?(k.to_sym))
|
|
55
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `MuxRuby::
|
|
55
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `MuxRuby::CreateStaticRenditionResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
56
56
|
end
|
|
57
57
|
h[k.to_sym] = v
|
|
58
58
|
}
|
|
@@ -45,7 +45,7 @@ module MuxRuby
|
|
|
45
45
|
# Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for tracks with `type` of `text` and `text_type` set to `subtitles`.
|
|
46
46
|
attr_accessor :closed_captions
|
|
47
47
|
|
|
48
|
-
# This optional parameter should be used tracks with `type` of `text` and `text_type` set to `subtitles`.
|
|
48
|
+
# This optional parameter should be used for tracks with `type` of `text` and `text_type` set to `subtitles`.
|
|
49
49
|
attr_accessor :passthrough
|
|
50
50
|
|
|
51
51
|
class EnumAttributeValidator
|