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
data/docs/MetricsApi.md
CHANGED
|
@@ -37,7 +37,7 @@ opts = {
|
|
|
37
37
|
timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
|
|
38
38
|
filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
39
39
|
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
|
40
|
-
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. 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`, `
|
|
40
|
+
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `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`
|
|
41
41
|
order_direction: 'asc', # String | Sort order.
|
|
42
42
|
group_by: 'minute' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.
|
|
43
43
|
}
|
|
@@ -77,7 +77,7 @@ end
|
|
|
77
77
|
| **timeframe** | [**Array<String>**](String.md) | 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` | [optional] |
|
|
78
78
|
| **filters** | [**Array<String>**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` 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` | [optional] |
|
|
79
79
|
| **metric_filters** | [**Array<String>**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
|
80
|
-
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `
|
|
80
|
+
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"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` | [optional] |
|
|
81
81
|
| **order_direction** | **String** | Sort order. | [optional] |
|
|
82
82
|
| **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of less than 90 minutes, the default granularity is `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. | [optional] |
|
|
83
83
|
|
|
@@ -121,7 +121,7 @@ opts = {
|
|
|
121
121
|
timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
|
|
122
122
|
filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
123
123
|
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
|
124
|
-
measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used. 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`, `
|
|
124
|
+
measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `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`
|
|
125
125
|
}
|
|
126
126
|
|
|
127
127
|
begin
|
|
@@ -159,7 +159,7 @@ end
|
|
|
159
159
|
| **timeframe** | [**Array<String>**](String.md) | 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` | [optional] |
|
|
160
160
|
| **filters** | [**Array<String>**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` 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` | [optional] |
|
|
161
161
|
| **metric_filters** | [**Array<String>**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
|
162
|
-
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `
|
|
162
|
+
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"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` | [optional] |
|
|
163
163
|
|
|
164
164
|
### Return type
|
|
165
165
|
|
|
@@ -279,7 +279,7 @@ api_instance = MuxRuby::MetricsApi.new
|
|
|
279
279
|
metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
|
280
280
|
opts = {
|
|
281
281
|
group_by: 'asn', # String | Breakdown value to group the results by
|
|
282
|
-
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. 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`, `
|
|
282
|
+
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `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`
|
|
283
283
|
filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
284
284
|
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
|
285
285
|
limit: 56, # Integer | Number of items to include in the response
|
|
@@ -322,7 +322,7 @@ end
|
|
|
322
322
|
| ---- | ---- | ----------- | ----- |
|
|
323
323
|
| **metric_id** | **String** | ID of the Metric | |
|
|
324
324
|
| **group_by** | **String** | Breakdown value to group the results by | [optional] |
|
|
325
|
-
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. 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`, `
|
|
325
|
+
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"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` | [optional] |
|
|
326
326
|
| **filters** | [**Array<String>**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` 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` | [optional] |
|
|
327
327
|
| **metric_filters** | [**Array<String>**](String.md) | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
|
328
328
|
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
|
@@ -368,7 +368,7 @@ end
|
|
|
368
368
|
api_instance = MuxRuby::MetricsApi.new
|
|
369
369
|
metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
|
370
370
|
opts = {
|
|
371
|
-
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. 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`, `
|
|
371
|
+
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `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`
|
|
372
372
|
order_direction: 'asc', # String | Sort order.
|
|
373
373
|
timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
|
|
374
374
|
filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
@@ -407,7 +407,7 @@ end
|
|
|
407
407
|
| Name | Type | Description | Notes |
|
|
408
408
|
| ---- | ---- | ----------- | ----- |
|
|
409
409
|
| **metric_id** | **String** | ID of the Metric | |
|
|
410
|
-
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. 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
|
+
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `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` | [optional] |
|
|
411
411
|
| **order_direction** | **String** | Sort order. | [optional] |
|
|
412
412
|
| **timeframe** | [**Array<String>**](String.md) | 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` | [optional] |
|
|
413
413
|
| **filters** | [**Array<String>**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` 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` | [optional] |
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# MuxRuby::StaticRendition
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Name of the static rendition file | [optional] |
|
|
8
|
+
| **ext** | **String** | Extension of the static rendition file | [optional] |
|
|
9
|
+
| **height** | **Integer** | The height of the static rendition's file in pixels | [optional] |
|
|
10
|
+
| **width** | **Integer** | The width of the static rendition's file in pixels | [optional] |
|
|
11
|
+
| **bitrate** | **Integer** | The bitrate in bits per second | [optional] |
|
|
12
|
+
| **filesize** | **String** | The file size in bytes | [optional] |
|
|
13
|
+
| **type** | **String** | Indicates the static rendition type of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`. | [optional] |
|
|
14
|
+
| **status** | **String** | Indicates the status of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`. * `ready` indicates the MP4 has been generated and is ready for download * `preparing` indicates the asset has not been ingested or the static rendition is still being generated after an asset is ready * `skipped` indicates the static rendition will not be generated because the requested resolution conflicts with the asset attributes after the asset has been ingested * `errored` indicates the static rendition cannot be generated. For example, an asset could not be ingested | [optional] |
|
|
15
|
+
| **resolution_tier** | **String** | Indicates the resolution tier of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`. | [optional] |
|
|
16
|
+
| **resolution** | **String** | Indicates the resolution of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`. | [optional] |
|
|
17
|
+
| **id** | **String** | The ID of this static rendition, used in managing this static rendition. This field is only valid for `static_renditions`, not for `mp4_support`. | [optional] |
|
|
18
|
+
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the static rendition. Max 255 characters. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'mux_ruby'
|
|
24
|
+
|
|
25
|
+
instance = MuxRuby::StaticRendition.new(
|
|
26
|
+
name: null,
|
|
27
|
+
ext: null,
|
|
28
|
+
height: null,
|
|
29
|
+
width: null,
|
|
30
|
+
bitrate: null,
|
|
31
|
+
filesize: null,
|
|
32
|
+
type: null,
|
|
33
|
+
status: null,
|
|
34
|
+
resolution_tier: null,
|
|
35
|
+
resolution: null,
|
|
36
|
+
id: null,
|
|
37
|
+
passthrough: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -4,8 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **mp4_support** | **String** | Specify what level of support for mp4 playback should be added to new assets generated from this live stream. * The `none` option disables MP4 support for new assets. MP4 files will not be produced for an asset generated from this live stream. * 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). | [optional] |
|
|
7
|
+
| **mp4_support** | **String** | Deprecated. See the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#during-live-stream-creation) for the updated API. Specify what level of support for mp4 playback should be added to new assets generated from this live stream. * The `none` option disables MP4 support for new assets. MP4 files will not be produced for an asset generated from this live stream. * 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). | [optional] |
|
|
8
8
|
| **master_access** | **String** | Add or remove access to the master version of the video. | [optional] |
|
|
9
|
+
| **video_quality** | **String** | The video quality controls the cost, quality, and available platform features for the asset. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) | [optional] |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -14,7 +15,8 @@ require 'mux_ruby'
|
|
|
14
15
|
|
|
15
16
|
instance = MuxRuby::UpdateLiveStreamNewAssetSettings.new(
|
|
16
17
|
mp4_support: null,
|
|
17
|
-
master_access: null
|
|
18
|
+
master_access: null,
|
|
19
|
+
video_quality: null
|
|
18
20
|
)
|
|
19
21
|
```
|
|
20
22
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# MuxRuby::UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **static_renditions** | [**Array<CreateStaticRenditionRequest>**](CreateStaticRenditionRequest.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'mux_ruby'
|
|
13
|
+
|
|
14
|
+
instance = MuxRuby::UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest.new(
|
|
15
|
+
static_renditions: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/VideoView.md
CHANGED
|
@@ -165,9 +165,23 @@
|
|
|
165
165
|
| **ad_playback_failure_error_type_id** | **Integer** | | [optional] |
|
|
166
166
|
| **view_content_startup_time** | **Integer** | | [optional] |
|
|
167
167
|
| **ad_preroll_startup_time** | **Integer** | | [optional] |
|
|
168
|
-
| **ad_watch_time** | **Integer** | | [optional] |
|
|
169
|
-
| **view_content_watch_time** | **Integer** | | [optional] |
|
|
170
168
|
| **view_dropped** | **Boolean** | | [optional] |
|
|
169
|
+
| **client_application_name** | **String** | | [optional] |
|
|
170
|
+
| **client_application_version** | **String** | | [optional] |
|
|
171
|
+
| **video_affiliate** | **String** | | [optional] |
|
|
172
|
+
| **viewer_plan** | **String** | | [optional] |
|
|
173
|
+
| **viewer_plan_status** | **String** | | [optional] |
|
|
174
|
+
| **viewer_plan_category** | **String** | | [optional] |
|
|
175
|
+
| **view_drm_level** | **String** | | [optional] |
|
|
176
|
+
| **video_brand** | **String** | | [optional] |
|
|
177
|
+
| **used_pip** | **Boolean** | | [optional] |
|
|
178
|
+
| **time_shift_enabled** | **Boolean** | | [optional] |
|
|
179
|
+
| **used_captions** | **Boolean** | | [optional] |
|
|
180
|
+
| **video_codec** | **String** | | [optional] |
|
|
181
|
+
| **audio_codec** | **String** | | [optional] |
|
|
182
|
+
| **video_dynamic_range_type** | **String** | | [optional] |
|
|
183
|
+
| **view_cdn_edge_pop** | **String** | | [optional] |
|
|
184
|
+
| **view_cdn_origin** | **String** | | [optional] |
|
|
171
185
|
|
|
172
186
|
## Example
|
|
173
187
|
|
|
@@ -336,9 +350,23 @@ instance = MuxRuby::VideoView.new(
|
|
|
336
350
|
ad_playback_failure_error_type_id: null,
|
|
337
351
|
view_content_startup_time: null,
|
|
338
352
|
ad_preroll_startup_time: null,
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
353
|
+
view_dropped: null,
|
|
354
|
+
client_application_name: null,
|
|
355
|
+
client_application_version: null,
|
|
356
|
+
video_affiliate: null,
|
|
357
|
+
viewer_plan: null,
|
|
358
|
+
viewer_plan_status: null,
|
|
359
|
+
viewer_plan_category: null,
|
|
360
|
+
view_drm_level: null,
|
|
361
|
+
video_brand: null,
|
|
362
|
+
used_pip: null,
|
|
363
|
+
time_shift_enabled: null,
|
|
364
|
+
used_captions: null,
|
|
365
|
+
video_codec: null,
|
|
366
|
+
audio_codec: null,
|
|
367
|
+
video_dynamic_range_type: null,
|
|
368
|
+
view_cdn_edge_pop: null,
|
|
369
|
+
view_cdn_origin: null
|
|
342
370
|
)
|
|
343
371
|
```
|
|
344
372
|
|
data/gen/generator-config.json
CHANGED
|
@@ -80,6 +80,10 @@ Mux Ruby is a code generated lightweight wrapper around the Mux REST API and ref
|
|
|
80
80
|
|
|
81
81
|
2) We don't use a lot of object orientation. For example API calls that happen on a single asset don't exist in the asset class, but are API calls in the AssetsApi which require an asset ID.
|
|
82
82
|
|
|
83
|
+
### Usage With Webhooks
|
|
84
|
+
|
|
85
|
+
At this moment, this SDK is not suitable for parsing or modeling webhook payloads, due to some incompatibilities in our API spec and our SDK generation tooling. We are working on resolving these issues, but for now you should only use this SDK for Mux's REST APIs.
|
|
86
|
+
|
|
83
87
|
### Authentication
|
|
84
88
|
To use the Mux API, you'll need an access token and a secret. [Details on obtaining these can be found here in the Mux documentation.](https://docs.mux.com/docs#section-1-get-an-api-access-token)
|
|
85
89
|
|
|
@@ -155,6 +155,77 @@ module MuxRuby
|
|
|
155
155
|
return data, status_code, headers
|
|
156
156
|
end
|
|
157
157
|
|
|
158
|
+
# Create a static rendition for an asset
|
|
159
|
+
# Creates a static rendition (i.e. MP4) for an asset
|
|
160
|
+
# @param asset_id [String] The asset ID.
|
|
161
|
+
# @param create_static_rendition_request [CreateStaticRenditionRequest]
|
|
162
|
+
# @param [Hash] opts the optional parameters
|
|
163
|
+
# @return [CreateStaticRenditionResponse]
|
|
164
|
+
def create_asset_static_rendition(asset_id, create_static_rendition_request, opts = {})
|
|
165
|
+
data, _status_code, _headers = create_asset_static_rendition_with_http_info(asset_id, create_static_rendition_request, opts)
|
|
166
|
+
data
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
# Create a static rendition for an asset
|
|
170
|
+
# Creates a static rendition (i.e. MP4) for an asset
|
|
171
|
+
# @param asset_id [String] The asset ID.
|
|
172
|
+
# @param create_static_rendition_request [CreateStaticRenditionRequest]
|
|
173
|
+
# @param [Hash] opts the optional parameters
|
|
174
|
+
# @return [Array<(CreateStaticRenditionResponse, Integer, Hash)>] CreateStaticRenditionResponse data, response status code and response headers
|
|
175
|
+
def create_asset_static_rendition_with_http_info(asset_id, create_static_rendition_request, opts = {})
|
|
176
|
+
if @api_client.config.debugging
|
|
177
|
+
@api_client.config.logger.debug 'Calling API: AssetsApi.create_asset_static_rendition ...'
|
|
178
|
+
end
|
|
179
|
+
# verify the required parameter 'asset_id' is set
|
|
180
|
+
if @api_client.config.client_side_validation && asset_id.nil?
|
|
181
|
+
fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.create_asset_static_rendition"
|
|
182
|
+
end
|
|
183
|
+
# verify the required parameter 'create_static_rendition_request' is set
|
|
184
|
+
if @api_client.config.client_side_validation && create_static_rendition_request.nil?
|
|
185
|
+
fail ArgumentError, "Missing the required parameter 'create_static_rendition_request' when calling AssetsApi.create_asset_static_rendition"
|
|
186
|
+
end
|
|
187
|
+
# resource path
|
|
188
|
+
local_var_path = '/video/v1/assets/{ASSET_ID}/static-renditions'.sub('{' + 'ASSET_ID' + '}', CGI.escape(asset_id.to_s))
|
|
189
|
+
|
|
190
|
+
# query parameters
|
|
191
|
+
query_params = opts[:query_params] || {}
|
|
192
|
+
|
|
193
|
+
# header parameters
|
|
194
|
+
header_params = opts[:header_params] || {}
|
|
195
|
+
# HTTP header 'Accept' (if needed)
|
|
196
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
197
|
+
# HTTP header 'Content-Type'
|
|
198
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
199
|
+
|
|
200
|
+
# form parameters
|
|
201
|
+
form_params = opts[:form_params] || {}
|
|
202
|
+
|
|
203
|
+
# http body (model)
|
|
204
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_static_rendition_request)
|
|
205
|
+
|
|
206
|
+
# return_type
|
|
207
|
+
return_type = opts[:debug_return_type] || 'CreateStaticRenditionResponse'
|
|
208
|
+
|
|
209
|
+
# auth_names
|
|
210
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
|
211
|
+
|
|
212
|
+
new_options = opts.merge(
|
|
213
|
+
:operation => :"AssetsApi.create_asset_static_rendition",
|
|
214
|
+
:header_params => header_params,
|
|
215
|
+
:query_params => query_params,
|
|
216
|
+
:form_params => form_params,
|
|
217
|
+
:body => post_body,
|
|
218
|
+
:auth_names => auth_names,
|
|
219
|
+
:return_type => return_type
|
|
220
|
+
)
|
|
221
|
+
|
|
222
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
223
|
+
if @api_client.config.debugging
|
|
224
|
+
@api_client.config.logger.debug "API called: AssetsApi#create_asset_static_rendition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
225
|
+
end
|
|
226
|
+
return data, status_code, headers
|
|
227
|
+
end
|
|
228
|
+
|
|
158
229
|
# Create an asset track
|
|
159
230
|
# Adds an asset track (for example, subtitles, or an alternate audio track) to an asset.
|
|
160
231
|
# @param asset_id [String] The asset ID.
|
|
@@ -354,6 +425,73 @@ module MuxRuby
|
|
|
354
425
|
return data, status_code, headers
|
|
355
426
|
end
|
|
356
427
|
|
|
428
|
+
# Delete a single static rendition for an asset
|
|
429
|
+
# Deletes a single static rendition for an asset
|
|
430
|
+
# @param asset_id [String] The asset ID.
|
|
431
|
+
# @param static_rendition_id [String] The static rendition ID.
|
|
432
|
+
# @param [Hash] opts the optional parameters
|
|
433
|
+
# @return [nil]
|
|
434
|
+
def delete_asset_static_rendition(asset_id, static_rendition_id, opts = {})
|
|
435
|
+
delete_asset_static_rendition_with_http_info(asset_id, static_rendition_id, opts)
|
|
436
|
+
nil
|
|
437
|
+
end
|
|
438
|
+
|
|
439
|
+
# Delete a single static rendition for an asset
|
|
440
|
+
# Deletes a single static rendition for an asset
|
|
441
|
+
# @param asset_id [String] The asset ID.
|
|
442
|
+
# @param static_rendition_id [String] The static rendition ID.
|
|
443
|
+
# @param [Hash] opts the optional parameters
|
|
444
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
445
|
+
def delete_asset_static_rendition_with_http_info(asset_id, static_rendition_id, opts = {})
|
|
446
|
+
if @api_client.config.debugging
|
|
447
|
+
@api_client.config.logger.debug 'Calling API: AssetsApi.delete_asset_static_rendition ...'
|
|
448
|
+
end
|
|
449
|
+
# verify the required parameter 'asset_id' is set
|
|
450
|
+
if @api_client.config.client_side_validation && asset_id.nil?
|
|
451
|
+
fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.delete_asset_static_rendition"
|
|
452
|
+
end
|
|
453
|
+
# verify the required parameter 'static_rendition_id' is set
|
|
454
|
+
if @api_client.config.client_side_validation && static_rendition_id.nil?
|
|
455
|
+
fail ArgumentError, "Missing the required parameter 'static_rendition_id' when calling AssetsApi.delete_asset_static_rendition"
|
|
456
|
+
end
|
|
457
|
+
# resource path
|
|
458
|
+
local_var_path = '/video/v1/assets/{ASSET_ID}/static-renditions/{STATIC_RENDITION_ID}'.sub('{' + 'ASSET_ID' + '}', CGI.escape(asset_id.to_s)).sub('{' + 'STATIC_RENDITION_ID' + '}', CGI.escape(static_rendition_id.to_s))
|
|
459
|
+
|
|
460
|
+
# query parameters
|
|
461
|
+
query_params = opts[:query_params] || {}
|
|
462
|
+
|
|
463
|
+
# header parameters
|
|
464
|
+
header_params = opts[:header_params] || {}
|
|
465
|
+
|
|
466
|
+
# form parameters
|
|
467
|
+
form_params = opts[:form_params] || {}
|
|
468
|
+
|
|
469
|
+
# http body (model)
|
|
470
|
+
post_body = opts[:debug_body]
|
|
471
|
+
|
|
472
|
+
# return_type
|
|
473
|
+
return_type = opts[:debug_return_type]
|
|
474
|
+
|
|
475
|
+
# auth_names
|
|
476
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
|
477
|
+
|
|
478
|
+
new_options = opts.merge(
|
|
479
|
+
:operation => :"AssetsApi.delete_asset_static_rendition",
|
|
480
|
+
:header_params => header_params,
|
|
481
|
+
:query_params => query_params,
|
|
482
|
+
:form_params => form_params,
|
|
483
|
+
:body => post_body,
|
|
484
|
+
:auth_names => auth_names,
|
|
485
|
+
:return_type => return_type
|
|
486
|
+
)
|
|
487
|
+
|
|
488
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
489
|
+
if @api_client.config.debugging
|
|
490
|
+
@api_client.config.logger.debug "API called: AssetsApi#delete_asset_static_rendition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
491
|
+
end
|
|
492
|
+
return data, status_code, headers
|
|
493
|
+
end
|
|
494
|
+
|
|
357
495
|
# Delete an asset track
|
|
358
496
|
# Removes a text track from an asset. Audio and video tracks on assets cannot be removed.
|
|
359
497
|
# @param asset_id [String] The asset ID.
|
|
@@ -905,7 +1043,7 @@ module MuxRuby
|
|
|
905
1043
|
end
|
|
906
1044
|
|
|
907
1045
|
# Update MP4 support
|
|
908
|
-
# Allows you to add or remove mp4 support for assets that were created without it. The values supported are `capped-1080p`, `audio-only`, `audio-only,capped-1080p`, `standard`(deprecated), and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.
|
|
1046
|
+
# This method has been deprecated. Please see the [Static Rendition API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#after-asset-creation). Allows you to add or remove mp4 support for assets that were created without it. The values supported are `capped-1080p`, `audio-only`, `audio-only,capped-1080p`, `standard`(deprecated), and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.
|
|
909
1047
|
# @param asset_id [String] The asset ID.
|
|
910
1048
|
# @param update_asset_mp4_support_request [UpdateAssetMP4SupportRequest]
|
|
911
1049
|
# @param [Hash] opts the optional parameters
|
|
@@ -916,7 +1054,7 @@ module MuxRuby
|
|
|
916
1054
|
end
|
|
917
1055
|
|
|
918
1056
|
# Update MP4 support
|
|
919
|
-
# Allows you to add or remove mp4 support for assets that were created without it. The values supported are `capped-1080p`, `audio-only`, `audio-only,capped-1080p`, `standard`(deprecated), and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.
|
|
1057
|
+
# This method has been deprecated. Please see the [Static Rendition API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#after-asset-creation). Allows you to add or remove mp4 support for assets that were created without it. The values supported are `capped-1080p`, `audio-only`, `audio-only,capped-1080p`, `standard`(deprecated), and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.
|
|
920
1058
|
# @param asset_id [String] The asset ID.
|
|
921
1059
|
# @param update_asset_mp4_support_request [UpdateAssetMP4SupportRequest]
|
|
922
1060
|
# @param [Hash] opts the optional parameters
|
|
@@ -287,6 +287,67 @@ module MuxRuby
|
|
|
287
287
|
return data, status_code, headers
|
|
288
288
|
end
|
|
289
289
|
|
|
290
|
+
# Delete a live stream's static renditions setting for new assets
|
|
291
|
+
# Deletes a live stream's static renditions settings for new assets. Further assets made via this live stream will not create static renditions unless re-added.
|
|
292
|
+
# @param live_stream_id [String] The live stream ID
|
|
293
|
+
# @param [Hash] opts the optional parameters
|
|
294
|
+
# @return [nil]
|
|
295
|
+
def delete_live_stream_new_asset_settings_static_renditions(live_stream_id, opts = {})
|
|
296
|
+
delete_live_stream_new_asset_settings_static_renditions_with_http_info(live_stream_id, opts)
|
|
297
|
+
nil
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
# Delete a live stream's static renditions setting for new assets
|
|
301
|
+
# Deletes a live stream's static renditions settings for new assets. Further assets made via this live stream will not create static renditions unless re-added.
|
|
302
|
+
# @param live_stream_id [String] The live stream ID
|
|
303
|
+
# @param [Hash] opts the optional parameters
|
|
304
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
305
|
+
def delete_live_stream_new_asset_settings_static_renditions_with_http_info(live_stream_id, opts = {})
|
|
306
|
+
if @api_client.config.debugging
|
|
307
|
+
@api_client.config.logger.debug 'Calling API: LiveStreamsApi.delete_live_stream_new_asset_settings_static_renditions ...'
|
|
308
|
+
end
|
|
309
|
+
# verify the required parameter 'live_stream_id' is set
|
|
310
|
+
if @api_client.config.client_side_validation && live_stream_id.nil?
|
|
311
|
+
fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.delete_live_stream_new_asset_settings_static_renditions"
|
|
312
|
+
end
|
|
313
|
+
# resource path
|
|
314
|
+
local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/new-asset-settings/static-renditions'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
|
|
315
|
+
|
|
316
|
+
# query parameters
|
|
317
|
+
query_params = opts[:query_params] || {}
|
|
318
|
+
|
|
319
|
+
# header parameters
|
|
320
|
+
header_params = opts[:header_params] || {}
|
|
321
|
+
|
|
322
|
+
# form parameters
|
|
323
|
+
form_params = opts[:form_params] || {}
|
|
324
|
+
|
|
325
|
+
# http body (model)
|
|
326
|
+
post_body = opts[:debug_body]
|
|
327
|
+
|
|
328
|
+
# return_type
|
|
329
|
+
return_type = opts[:debug_return_type]
|
|
330
|
+
|
|
331
|
+
# auth_names
|
|
332
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
|
333
|
+
|
|
334
|
+
new_options = opts.merge(
|
|
335
|
+
:operation => :"LiveStreamsApi.delete_live_stream_new_asset_settings_static_renditions",
|
|
336
|
+
:header_params => header_params,
|
|
337
|
+
:query_params => query_params,
|
|
338
|
+
:form_params => form_params,
|
|
339
|
+
:body => post_body,
|
|
340
|
+
:auth_names => auth_names,
|
|
341
|
+
:return_type => return_type
|
|
342
|
+
)
|
|
343
|
+
|
|
344
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
345
|
+
if @api_client.config.debugging
|
|
346
|
+
@api_client.config.logger.debug "API called: LiveStreamsApi#delete_live_stream_new_asset_settings_static_renditions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
347
|
+
end
|
|
348
|
+
return data, status_code, headers
|
|
349
|
+
end
|
|
350
|
+
|
|
290
351
|
# Delete a live stream playback ID
|
|
291
352
|
# Deletes the playback ID for the live stream. This will not disable ingest (as the live stream still exists). New attempts to play back the live stream will fail immediately. However, current viewers will be able to continue watching the stream for some period of time.
|
|
292
353
|
# @param live_stream_id [String] The live stream ID
|
|
@@ -1155,5 +1216,76 @@ module MuxRuby
|
|
|
1155
1216
|
end
|
|
1156
1217
|
return data, status_code, headers
|
|
1157
1218
|
end
|
|
1219
|
+
|
|
1220
|
+
# Update live stream static renditions for new assets
|
|
1221
|
+
# Updates a live stream's static renditions settings for new assets. Further assets made via this live stream will create static renditions per the settings provided. You must provide all static renditions desired.
|
|
1222
|
+
# @param live_stream_id [String] The live stream ID
|
|
1223
|
+
# @param update_live_stream_new_asset_settings_static_renditions_request [UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest]
|
|
1224
|
+
# @param [Hash] opts the optional parameters
|
|
1225
|
+
# @return [LiveStreamResponse]
|
|
1226
|
+
def update_live_stream_new_asset_settings_static_renditions(live_stream_id, update_live_stream_new_asset_settings_static_renditions_request, opts = {})
|
|
1227
|
+
data, _status_code, _headers = update_live_stream_new_asset_settings_static_renditions_with_http_info(live_stream_id, update_live_stream_new_asset_settings_static_renditions_request, opts)
|
|
1228
|
+
data
|
|
1229
|
+
end
|
|
1230
|
+
|
|
1231
|
+
# Update live stream static renditions for new assets
|
|
1232
|
+
# Updates a live stream's static renditions settings for new assets. Further assets made via this live stream will create static renditions per the settings provided. You must provide all static renditions desired.
|
|
1233
|
+
# @param live_stream_id [String] The live stream ID
|
|
1234
|
+
# @param update_live_stream_new_asset_settings_static_renditions_request [UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest]
|
|
1235
|
+
# @param [Hash] opts the optional parameters
|
|
1236
|
+
# @return [Array<(LiveStreamResponse, Integer, Hash)>] LiveStreamResponse data, response status code and response headers
|
|
1237
|
+
def update_live_stream_new_asset_settings_static_renditions_with_http_info(live_stream_id, update_live_stream_new_asset_settings_static_renditions_request, opts = {})
|
|
1238
|
+
if @api_client.config.debugging
|
|
1239
|
+
@api_client.config.logger.debug 'Calling API: LiveStreamsApi.update_live_stream_new_asset_settings_static_renditions ...'
|
|
1240
|
+
end
|
|
1241
|
+
# verify the required parameter 'live_stream_id' is set
|
|
1242
|
+
if @api_client.config.client_side_validation && live_stream_id.nil?
|
|
1243
|
+
fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.update_live_stream_new_asset_settings_static_renditions"
|
|
1244
|
+
end
|
|
1245
|
+
# verify the required parameter 'update_live_stream_new_asset_settings_static_renditions_request' is set
|
|
1246
|
+
if @api_client.config.client_side_validation && update_live_stream_new_asset_settings_static_renditions_request.nil?
|
|
1247
|
+
fail ArgumentError, "Missing the required parameter 'update_live_stream_new_asset_settings_static_renditions_request' when calling LiveStreamsApi.update_live_stream_new_asset_settings_static_renditions"
|
|
1248
|
+
end
|
|
1249
|
+
# resource path
|
|
1250
|
+
local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/new-asset-settings/static-renditions'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
|
|
1251
|
+
|
|
1252
|
+
# query parameters
|
|
1253
|
+
query_params = opts[:query_params] || {}
|
|
1254
|
+
|
|
1255
|
+
# header parameters
|
|
1256
|
+
header_params = opts[:header_params] || {}
|
|
1257
|
+
# HTTP header 'Accept' (if needed)
|
|
1258
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1259
|
+
# HTTP header 'Content-Type'
|
|
1260
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1261
|
+
|
|
1262
|
+
# form parameters
|
|
1263
|
+
form_params = opts[:form_params] || {}
|
|
1264
|
+
|
|
1265
|
+
# http body (model)
|
|
1266
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_live_stream_new_asset_settings_static_renditions_request)
|
|
1267
|
+
|
|
1268
|
+
# return_type
|
|
1269
|
+
return_type = opts[:debug_return_type] || 'LiveStreamResponse'
|
|
1270
|
+
|
|
1271
|
+
# auth_names
|
|
1272
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
|
1273
|
+
|
|
1274
|
+
new_options = opts.merge(
|
|
1275
|
+
:operation => :"LiveStreamsApi.update_live_stream_new_asset_settings_static_renditions",
|
|
1276
|
+
:header_params => header_params,
|
|
1277
|
+
:query_params => query_params,
|
|
1278
|
+
:form_params => form_params,
|
|
1279
|
+
:body => post_body,
|
|
1280
|
+
:auth_names => auth_names,
|
|
1281
|
+
:return_type => return_type
|
|
1282
|
+
)
|
|
1283
|
+
|
|
1284
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1285
|
+
if @api_client.config.debugging
|
|
1286
|
+
@api_client.config.logger.debug "API called: LiveStreamsApi#update_live_stream_new_asset_settings_static_renditions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1287
|
+
end
|
|
1288
|
+
return data, status_code, headers
|
|
1289
|
+
end
|
|
1158
1290
|
end
|
|
1159
1291
|
end
|