mux_ruby 3.14.0 → 3.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +4 -4
- data/docs/AbridgedVideoView.md +3 -1
- data/docs/AssetsApi.md +1 -1
- data/docs/CreateAssetRequest.md +1 -1
- data/docs/CreatePlaybackRestrictionRequest.md +3 -1
- data/docs/DeliveryReport.md +2 -0
- data/docs/GenerateTrackSubtitlesResponse.md +1 -1
- data/docs/PlaybackRestriction.md +3 -1
- data/docs/PlaybackRestrictionsApi.md +73 -0
- data/docs/UpdateAssetMP4SupportRequest.md +1 -1
- data/docs/UpdateLiveStreamNewAssetSettings.md +18 -0
- data/docs/UpdateLiveStreamRequest.md +3 -1
- data/docs/UpdateUserAgentRestrictionRequest.md +20 -0
- data/docs/UserAgentRestrictionRequest.md +20 -0
- data/docs/UserAgentRestrictionSettings.md +20 -0
- data/docs/VideoView.md +13 -1
- data/gen/generator-config.json +1 -1
- data/lib/mux_ruby/api/assets_api.rb +2 -2
- data/lib/mux_ruby/api/metrics_api.rb +6 -6
- data/lib/mux_ruby/api/playback_restrictions_api.rb +71 -0
- data/lib/mux_ruby/models/abridged_video_view.rb +14 -5
- data/lib/mux_ruby/models/asset.rb +2 -2
- data/lib/mux_ruby/models/asset_static_renditions_files.rb +2 -2
- data/lib/mux_ruby/models/create_asset_request.rb +3 -3
- data/lib/mux_ruby/models/create_playback_restriction_request.rb +13 -4
- data/lib/mux_ruby/models/delivery_report.rb +23 -1
- data/lib/mux_ruby/models/generate_track_subtitles_response.rb +4 -2
- data/lib/mux_ruby/models/playback_restriction.rb +13 -4
- data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +3 -3
- data/lib/mux_ruby/models/update_live_stream_new_asset_settings.rb +254 -0
- data/lib/mux_ruby/models/update_live_stream_request.rb +13 -4
- data/lib/mux_ruby/models/update_user_agent_restriction_request.rb +233 -0
- data/lib/mux_ruby/models/user_agent_restriction_request.rb +234 -0
- data/lib/mux_ruby/models/user_agent_restriction_settings.rb +234 -0
- data/lib/mux_ruby/models/video_view.rb +66 -4
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +4 -0
- data/spec/models/update_live_stream_new_asset_settings_spec.rb +38 -0
- data/spec/models/update_user_agent_restriction_request_spec.rb +40 -0
- data/spec/models/user_agent_restriction_request_spec.rb +40 -0
- data/spec/models/user_agent_restriction_settings_spec.rb +40 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/mkmf.log +16 -16
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/gem_make.out +14 -14
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/jaro_winkler/jaro_winkler_ext.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/mkmf.log +4 -4
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/psych.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/mkmf.log +2 -2
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/stringio.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/lib/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
- data/vendor/bundle/ruby/3.2.0/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 -156
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 801d9952af44a42a85c2e26f35b5c6d999191d0861bbb55ad7a4bf9b1ddf94fb
|
4
|
+
data.tar.gz: df9aafea70233c5f4bb20b297ddadf33a0b66c225ed14e8b9dc3b3c0499e2147
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 87da656812866a9a8b5a09cb613dd1ab955e760504a133ca68870f53b60498258f4bc8fbc88749be90e9005079169320f3850c3f46372b533bae5146456466d1
|
7
|
+
data.tar.gz: f801c56c20156feec118f58aeff35f5d83418a9ef5ceeebc0757ca5cf693eed9187116a7f11f54464860cde849dddbf2a4d929c1d0c299d0d2c216712c6be6c5
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -23,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
|
|
23
23
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
24
24
|
|
25
25
|
- API version: v1
|
26
|
-
- Package version: 3.
|
26
|
+
- Package version: 3.16.0
|
27
27
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
28
28
|
For more information, please visit [https://docs.mux.com](https://docs.mux.com)
|
29
29
|
|
@@ -40,16 +40,16 @@ gem build mux_ruby.gemspec
|
|
40
40
|
Then either install the gem locally:
|
41
41
|
|
42
42
|
```shell
|
43
|
-
gem install ./mux_ruby-3.
|
43
|
+
gem install ./mux_ruby-3.16.0.gem
|
44
44
|
```
|
45
45
|
|
46
|
-
(for development, run `gem install --dev ./mux_ruby-3.
|
46
|
+
(for development, run `gem install --dev ./mux_ruby-3.16.0.gem` to install the development dependencies)
|
47
47
|
|
48
48
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
49
49
|
|
50
50
|
Finally add this to the Gemfile:
|
51
51
|
|
52
|
-
gem 'mux_ruby', '~> 3.
|
52
|
+
gem 'mux_ruby', '~> 3.16.0'
|
53
53
|
|
54
54
|
### Install from Git
|
55
55
|
|
data/docs/AbridgedVideoView.md
CHANGED
@@ -17,6 +17,7 @@
|
|
17
17
|
| **view_end** | **String** | | [optional] |
|
18
18
|
| **viewer_experience_score** | **Float** | | [optional] |
|
19
19
|
| **watch_time** | **Integer** | | [optional] |
|
20
|
+
| **playback_failure** | **Boolean** | | [optional] |
|
20
21
|
|
21
22
|
## Example
|
22
23
|
|
@@ -36,7 +37,8 @@ instance = MuxRuby::AbridgedVideoView.new(
|
|
36
37
|
view_start: null,
|
37
38
|
view_end: null,
|
38
39
|
viewer_experience_score: null,
|
39
|
-
watch_time: null
|
40
|
+
watch_time: null,
|
41
|
+
playback_failure: null
|
40
42
|
)
|
41
43
|
```
|
42
44
|
|
data/docs/AssetsApi.md
CHANGED
@@ -959,7 +959,7 @@ end
|
|
959
959
|
|
960
960
|
Update MP4 support
|
961
961
|
|
962
|
-
Allows you to add or remove mp4 support for assets that were created without it.
|
962
|
+
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.
|
963
963
|
|
964
964
|
### Examples
|
965
965
|
|
data/docs/CreateAssetRequest.md
CHANGED
@@ -8,7 +8,7 @@
|
|
8
8
|
| **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: `\"public\"` (anyone with the playback URL can stream the asset). And `\"signed\"` (an additional access token is required to play the asset). If no playback_policy is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] |
|
9
9
|
| **per_title_encode** | **Boolean** | | [optional] |
|
10
10
|
| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] |
|
11
|
-
| **mp4_support** | **String** | Specify what level
|
11
|
+
| **mp4_support** | **String** | Specify what level of support for mp4 playback. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). MP4 files are not produced for `none` (default). In most cases you should use our default HLS-based streaming playback (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional] |
|
12
12
|
| **normalize_audio** | **Boolean** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional][default to false] |
|
13
13
|
| **master_access** | **String** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional] |
|
14
14
|
| **test** | **Boolean** | Marks the asset as a test asset when the value is set to true. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs. | [optional] |
|
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional] |
|
8
|
+
| **user_agent** | [**UserAgentRestrictionRequest**](UserAgentRestrictionRequest.md) | | [optional] |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'mux_ruby'
|
13
14
|
|
14
15
|
instance = MuxRuby::CreatePlaybackRestrictionRequest.new(
|
15
|
-
referrer: null
|
16
|
+
referrer: null,
|
17
|
+
user_agent: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|
data/docs/DeliveryReport.md
CHANGED
@@ -12,6 +12,7 @@
|
|
12
12
|
| **asset_state** | **String** | The state of the asset. | [optional] |
|
13
13
|
| **asset_duration** | **Float** | The duration of the asset in seconds. | [optional] |
|
14
14
|
| **asset_resolution_tier** | **String** | The resolution tier that the asset was ingested at, affecting billing for ingest & storage | [optional] |
|
15
|
+
| **asset_encoding_tier** | **String** | The encoding tier that the asset was ingested at. [See the encoding tiers guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] |
|
15
16
|
| **delivered_seconds** | **Float** | Total number of delivered seconds during this time window. | [optional] |
|
16
17
|
| **delivered_seconds_by_resolution** | [**DeliveryReportDeliveredSecondsByResolution**](DeliveryReportDeliveredSecondsByResolution.md) | | [optional] |
|
17
18
|
|
@@ -29,6 +30,7 @@ instance = MuxRuby::DeliveryReport.new(
|
|
29
30
|
asset_state: null,
|
30
31
|
asset_duration: null,
|
31
32
|
asset_resolution_tier: null,
|
33
|
+
asset_encoding_tier: null,
|
32
34
|
delivered_seconds: null,
|
33
35
|
delivered_seconds_by_resolution: null
|
34
36
|
)
|
data/docs/PlaybackRestriction.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
| **created_at** | **String** | Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
|
9
9
|
| **updated_at** | **String** | Time the Playback Restriction was last updated, defined as a Unix timestamp (seconds since epoch). | [optional] |
|
10
10
|
| **referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional] |
|
11
|
+
| **user_agent** | [**UserAgentRestrictionSettings**](UserAgentRestrictionSettings.md) | | [optional] |
|
11
12
|
|
12
13
|
## Example
|
13
14
|
|
@@ -18,7 +19,8 @@ instance = MuxRuby::PlaybackRestriction.new(
|
|
18
19
|
id: null,
|
19
20
|
created_at: null,
|
20
21
|
updated_at: null,
|
21
|
-
referrer: null
|
22
|
+
referrer: null,
|
23
|
+
user_agent: null
|
22
24
|
)
|
23
25
|
```
|
24
26
|
|
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.mux.com*
|
|
9
9
|
| [**get_playback_restriction**](PlaybackRestrictionsApi.md#get_playback_restriction) | **GET** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID} | Retrieve a Playback Restriction |
|
10
10
|
| [**list_playback_restrictions**](PlaybackRestrictionsApi.md#list_playback_restrictions) | **GET** /video/v1/playback-restrictions | List Playback Restrictions |
|
11
11
|
| [**update_referrer_domain_restriction**](PlaybackRestrictionsApi.md#update_referrer_domain_restriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer | Update the Referrer Playback Restriction |
|
12
|
+
| [**update_user_agent_restriction**](PlaybackRestrictionsApi.md#update_user_agent_restriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/user_agent | Update the User Agent Restriction |
|
12
13
|
|
13
14
|
|
14
15
|
## create_playback_restriction
|
@@ -365,3 +366,75 @@ end
|
|
365
366
|
- **Content-Type**: application/json
|
366
367
|
- **Accept**: application/json
|
367
368
|
|
369
|
+
|
370
|
+
## update_user_agent_restriction
|
371
|
+
|
372
|
+
> <PlaybackRestrictionResponse> update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request)
|
373
|
+
|
374
|
+
Update the User Agent Restriction
|
375
|
+
|
376
|
+
Allows you to modify how Mux validates playback requests with different user agents. Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.
|
377
|
+
|
378
|
+
### Examples
|
379
|
+
|
380
|
+
```ruby
|
381
|
+
require 'time'
|
382
|
+
require 'mux_ruby'
|
383
|
+
# setup authorization
|
384
|
+
MuxRuby.configure do |config|
|
385
|
+
# Configure HTTP basic authorization: accessToken
|
386
|
+
config.username = 'YOUR USERNAME'
|
387
|
+
config.password = 'YOUR PASSWORD'
|
388
|
+
end
|
389
|
+
|
390
|
+
api_instance = MuxRuby::PlaybackRestrictionsApi.new
|
391
|
+
playback_restriction_id = 'playback_restriction_id_example' # String | ID of the Playback Restriction.
|
392
|
+
update_user_agent_restriction_request = MuxRuby::UpdateUserAgentRestrictionRequest.new # UpdateUserAgentRestrictionRequest |
|
393
|
+
|
394
|
+
begin
|
395
|
+
# Update the User Agent Restriction
|
396
|
+
result = api_instance.update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request)
|
397
|
+
p result
|
398
|
+
rescue MuxRuby::ApiError => e
|
399
|
+
puts "Error when calling PlaybackRestrictionsApi->update_user_agent_restriction: #{e}"
|
400
|
+
end
|
401
|
+
```
|
402
|
+
|
403
|
+
#### Using the update_user_agent_restriction_with_http_info variant
|
404
|
+
|
405
|
+
This returns an Array which contains the response data, status code and headers.
|
406
|
+
|
407
|
+
> <Array(<PlaybackRestrictionResponse>, Integer, Hash)> update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request)
|
408
|
+
|
409
|
+
```ruby
|
410
|
+
begin
|
411
|
+
# Update the User Agent Restriction
|
412
|
+
data, status_code, headers = api_instance.update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request)
|
413
|
+
p status_code # => 2xx
|
414
|
+
p headers # => { ... }
|
415
|
+
p data # => <PlaybackRestrictionResponse>
|
416
|
+
rescue MuxRuby::ApiError => e
|
417
|
+
puts "Error when calling PlaybackRestrictionsApi->update_user_agent_restriction_with_http_info: #{e}"
|
418
|
+
end
|
419
|
+
```
|
420
|
+
|
421
|
+
### Parameters
|
422
|
+
|
423
|
+
| Name | Type | Description | Notes |
|
424
|
+
| ---- | ---- | ----------- | ----- |
|
425
|
+
| **playback_restriction_id** | **String** | ID of the Playback Restriction. | |
|
426
|
+
| **update_user_agent_restriction_request** | [**UpdateUserAgentRestrictionRequest**](UpdateUserAgentRestrictionRequest.md) | | |
|
427
|
+
|
428
|
+
### Return type
|
429
|
+
|
430
|
+
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
|
431
|
+
|
432
|
+
### Authorization
|
433
|
+
|
434
|
+
[accessToken](../README.md#accessToken)
|
435
|
+
|
436
|
+
### HTTP request headers
|
437
|
+
|
438
|
+
- **Content-Type**: application/json
|
439
|
+
- **Accept**: application/json
|
440
|
+
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **mp4_support** | **String** |
|
7
|
+
| **mp4_support** | **String** | Specify what level of support for mp4 playback. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). `none` will delete the MP4s from the asset in question. | [optional] |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MuxRuby::UpdateLiveStreamNewAssetSettings
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
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] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'mux_ruby'
|
13
|
+
|
14
|
+
instance = MuxRuby::UpdateLiveStreamNewAssetSettings.new(
|
15
|
+
mp4_support: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -10,6 +10,7 @@
|
|
10
10
|
| **use_slate_for_standard_latency** | **Boolean** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional][default to false] |
|
11
11
|
| **reconnect_slate_url** | **String** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used. | [optional] |
|
12
12
|
| **max_continuous_duration** | **Integer** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional][default to 43200] |
|
13
|
+
| **new_asset_settings** | [**UpdateLiveStreamNewAssetSettings**](UpdateLiveStreamNewAssetSettings.md) | | [optional] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,7 +23,8 @@ instance = MuxRuby::UpdateLiveStreamRequest.new(
|
|
22
23
|
reconnect_window: null,
|
23
24
|
use_slate_for_standard_latency: null,
|
24
25
|
reconnect_slate_url: null,
|
25
|
-
max_continuous_duration: null
|
26
|
+
max_continuous_duration: null,
|
27
|
+
new_asset_settings: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MuxRuby::UpdateUserAgentRestrictionRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **allow_no_user_agent** | **Boolean** | Whether or not to allow views without a `User-Agent` HTTP request header. | [optional][default to true] |
|
8
|
+
| **allow_high_risk_user_agent** | **Boolean** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional][default to true] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'mux_ruby'
|
14
|
+
|
15
|
+
instance = MuxRuby::UpdateUserAgentRestrictionRequest.new(
|
16
|
+
allow_no_user_agent: null,
|
17
|
+
allow_high_risk_user_agent: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MuxRuby::UserAgentRestrictionRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **allow_no_user_agent** | **Boolean** | Whether or not to allow views without a `User-Agent` HTTP request header. | [optional][default to true] |
|
8
|
+
| **allow_high_risk_user_agent** | **Boolean** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional][default to true] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'mux_ruby'
|
14
|
+
|
15
|
+
instance = MuxRuby::UserAgentRestrictionRequest.new(
|
16
|
+
allow_no_user_agent: null,
|
17
|
+
allow_high_risk_user_agent: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MuxRuby::UserAgentRestrictionSettings
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **allow_no_user_agent** | **Boolean** | Whether or not to allow views without a `User-Agent` HTTP request header. | [optional][default to true] |
|
8
|
+
| **allow_high_risk_user_agent** | **Boolean** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional][default to true] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'mux_ruby'
|
14
|
+
|
15
|
+
instance = MuxRuby::UserAgentRestrictionSettings.new(
|
16
|
+
allow_no_user_agent: null,
|
17
|
+
allow_high_risk_user_agent: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/VideoView.md
CHANGED
@@ -161,6 +161,12 @@
|
|
161
161
|
| **playback_failure_error_type_id** | **Integer** | | [optional] |
|
162
162
|
| **playback_business_exception_error_type_id** | **Integer** | | [optional] |
|
163
163
|
| **video_startup_business_exception_error_type_id** | **Integer** | | [optional] |
|
164
|
+
| **playback_failure** | **Boolean** | | [optional] |
|
165
|
+
| **ad_playback_failure_error_type_id** | **Integer** | | [optional] |
|
166
|
+
| **view_content_startup_time** | **Integer** | | [optional] |
|
167
|
+
| **ad_preroll_startup_time** | **Integer** | | [optional] |
|
168
|
+
| **ad_watch_time** | **Integer** | | [optional] |
|
169
|
+
| **view_content_watch_time** | **Integer** | | [optional] |
|
164
170
|
|
165
171
|
## Example
|
166
172
|
|
@@ -324,7 +330,13 @@ instance = MuxRuby::VideoView.new(
|
|
324
330
|
long_rebuffering: null,
|
325
331
|
playback_failure_error_type_id: null,
|
326
332
|
playback_business_exception_error_type_id: null,
|
327
|
-
video_startup_business_exception_error_type_id: null
|
333
|
+
video_startup_business_exception_error_type_id: null,
|
334
|
+
playback_failure: null,
|
335
|
+
ad_playback_failure_error_type_id: null,
|
336
|
+
view_content_startup_time: null,
|
337
|
+
ad_preroll_startup_time: null,
|
338
|
+
ad_watch_time: null,
|
339
|
+
view_content_watch_time: null
|
328
340
|
)
|
329
341
|
```
|
330
342
|
|
data/gen/generator-config.json
CHANGED
@@ -905,7 +905,7 @@ module MuxRuby
|
|
905
905
|
end
|
906
906
|
|
907
907
|
# Update MP4 support
|
908
|
-
# Allows you to add or remove mp4 support for assets that were created without it.
|
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.
|
909
909
|
# @param asset_id [String] The asset ID.
|
910
910
|
# @param update_asset_mp4_support_request [UpdateAssetMP4SupportRequest]
|
911
911
|
# @param [Hash] opts the optional parameters
|
@@ -916,7 +916,7 @@ module MuxRuby
|
|
916
916
|
end
|
917
917
|
|
918
918
|
# Update MP4 support
|
919
|
-
# Allows you to add or remove mp4 support for assets that were created without it.
|
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.
|
920
920
|
# @param asset_id [String] The asset ID.
|
921
921
|
# @param update_asset_mp4_support_request [UpdateAssetMP4SupportRequest]
|
922
922
|
# @param [Hash] opts the optional parameters
|
@@ -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"]
|
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", "ad_watch_time", "view_content_watch_time"]
|
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
|
@@ -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"]
|
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", "ad_watch_time", "view_content_watch_time"]
|
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"]
|
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"]
|
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
|
@@ -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"]
|
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", "ad_watch_time", "view_content_watch_time"]
|
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"]
|
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"]
|
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
|
@@ -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"]
|
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", "ad_watch_time", "view_content_watch_time"]
|
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
|
@@ -341,5 +341,76 @@ module MuxRuby
|
|
341
341
|
end
|
342
342
|
return data, status_code, headers
|
343
343
|
end
|
344
|
+
|
345
|
+
# Update the User Agent Restriction
|
346
|
+
# Allows you to modify how Mux validates playback requests with different user agents. Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.
|
347
|
+
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
348
|
+
# @param update_user_agent_restriction_request [UpdateUserAgentRestrictionRequest]
|
349
|
+
# @param [Hash] opts the optional parameters
|
350
|
+
# @return [PlaybackRestrictionResponse]
|
351
|
+
def update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request, opts = {})
|
352
|
+
data, _status_code, _headers = update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request, opts)
|
353
|
+
data
|
354
|
+
end
|
355
|
+
|
356
|
+
# Update the User Agent Restriction
|
357
|
+
# Allows you to modify how Mux validates playback requests with different user agents. Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.
|
358
|
+
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
359
|
+
# @param update_user_agent_restriction_request [UpdateUserAgentRestrictionRequest]
|
360
|
+
# @param [Hash] opts the optional parameters
|
361
|
+
# @return [Array<(PlaybackRestrictionResponse, Integer, Hash)>] PlaybackRestrictionResponse data, response status code and response headers
|
362
|
+
def update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request, opts = {})
|
363
|
+
if @api_client.config.debugging
|
364
|
+
@api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.update_user_agent_restriction ...'
|
365
|
+
end
|
366
|
+
# verify the required parameter 'playback_restriction_id' is set
|
367
|
+
if @api_client.config.client_side_validation && playback_restriction_id.nil?
|
368
|
+
fail ArgumentError, "Missing the required parameter 'playback_restriction_id' when calling PlaybackRestrictionsApi.update_user_agent_restriction"
|
369
|
+
end
|
370
|
+
# verify the required parameter 'update_user_agent_restriction_request' is set
|
371
|
+
if @api_client.config.client_side_validation && update_user_agent_restriction_request.nil?
|
372
|
+
fail ArgumentError, "Missing the required parameter 'update_user_agent_restriction_request' when calling PlaybackRestrictionsApi.update_user_agent_restriction"
|
373
|
+
end
|
374
|
+
# resource path
|
375
|
+
local_var_path = '/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/user_agent'.sub('{' + 'PLAYBACK_RESTRICTION_ID' + '}', CGI.escape(playback_restriction_id.to_s))
|
376
|
+
|
377
|
+
# query parameters
|
378
|
+
query_params = opts[:query_params] || {}
|
379
|
+
|
380
|
+
# header parameters
|
381
|
+
header_params = opts[:header_params] || {}
|
382
|
+
# HTTP header 'Accept' (if needed)
|
383
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
384
|
+
# HTTP header 'Content-Type'
|
385
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
386
|
+
|
387
|
+
# form parameters
|
388
|
+
form_params = opts[:form_params] || {}
|
389
|
+
|
390
|
+
# http body (model)
|
391
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_user_agent_restriction_request)
|
392
|
+
|
393
|
+
# return_type
|
394
|
+
return_type = opts[:debug_return_type] || 'PlaybackRestrictionResponse'
|
395
|
+
|
396
|
+
# auth_names
|
397
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
398
|
+
|
399
|
+
new_options = opts.merge(
|
400
|
+
:operation => :"PlaybackRestrictionsApi.update_user_agent_restriction",
|
401
|
+
:header_params => header_params,
|
402
|
+
:query_params => query_params,
|
403
|
+
:form_params => form_params,
|
404
|
+
:body => post_body,
|
405
|
+
:auth_names => auth_names,
|
406
|
+
:return_type => return_type
|
407
|
+
)
|
408
|
+
|
409
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
410
|
+
if @api_client.config.debugging
|
411
|
+
@api_client.config.logger.debug "API called: PlaybackRestrictionsApi#update_user_agent_restriction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
412
|
+
end
|
413
|
+
return data, status_code, headers
|
414
|
+
end
|
344
415
|
end
|
345
416
|
end
|