mux_ruby 3.12.0 → 3.13.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 +5 -1
- data/docs/DimensionsApi.md +2 -0
- data/docs/ErrorsApi.md +2 -0
- data/docs/InputSettings.md +1 -1
- data/docs/LiveStream.md +3 -1
- data/docs/MetricsApi.md +13 -1
- data/docs/ReferrerDomainRestriction.md +1 -1
- data/docs/Track.md +3 -1
- data/docs/VideoView.md +23 -1
- data/docs/VideoViewsApi.md +2 -0
- data/gen/generator-config.json +1 -1
- data/lib/mux_ruby/api/dimensions_api.rb +3 -0
- data/lib/mux_ruby/api/errors_api.rb +3 -0
- data/lib/mux_ruby/api/metrics_api.rb +24 -6
- data/lib/mux_ruby/api/video_views_api.rb +3 -0
- data/lib/mux_ruby/models/abridged_video_view.rb +24 -4
- data/lib/mux_ruby/models/asset_generated_subtitle_settings.rb +2 -2
- data/lib/mux_ruby/models/input_settings.rb +1 -1
- data/lib/mux_ruby/models/live_stream.rb +14 -4
- data/lib/mux_ruby/models/referrer_domain_restriction.rb +1 -1
- data/lib/mux_ruby/models/track.rb +14 -4
- data/lib/mux_ruby/models/video_view.rb +112 -2
- data/lib/mux_ruby/version.rb +1 -1
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/gem_make.out +5 -5
- metadata +152 -152
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 85259ec7beed516722f9640ee108f177ee1464d453b3564a4758ceca0b384cff
|
4
|
+
data.tar.gz: 0ead5e093d125d6949c7d2c53eb8b15ce9ee1db6192a748f9b4a26ba2d3a233a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c8eec8322b5e98ed479f6e1a02f9ce00c5088536ea6cd6116d12e5198fcbb022fd5ffe50dd5f3aa841c666eacf988aed43e76e53b78dee6f867a16b27198900a
|
7
|
+
data.tar.gz: e7c08246e28ed4e988043357bc3406ea3bee5611b9ec7707fe1fc3aefcb143d7269b1f79b5646c41fb5e6e6631cfb0539d596518d51f2201cc5738f8393b53a3
|
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.13.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.13.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.13.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.13.0'
|
53
53
|
|
54
54
|
### Install from Git
|
55
55
|
|
data/docs/AbridgedVideoView.md
CHANGED
@@ -15,6 +15,8 @@
|
|
15
15
|
| **country_code** | **String** | | [optional] |
|
16
16
|
| **view_start** | **String** | | [optional] |
|
17
17
|
| **view_end** | **String** | | [optional] |
|
18
|
+
| **viewer_experience_score** | **Float** | | [optional] |
|
19
|
+
| **watch_time** | **Integer** | | [optional] |
|
18
20
|
|
19
21
|
## Example
|
20
22
|
|
@@ -32,7 +34,9 @@ instance = MuxRuby::AbridgedVideoView.new(
|
|
32
34
|
error_type_id: null,
|
33
35
|
country_code: null,
|
34
36
|
view_start: null,
|
35
|
-
view_end: null
|
37
|
+
view_end: null,
|
38
|
+
viewer_experience_score: null,
|
39
|
+
watch_time: null
|
36
40
|
)
|
37
41
|
```
|
38
42
|
|
data/docs/DimensionsApi.md
CHANGED
@@ -34,6 +34,7 @@ opts = {
|
|
34
34
|
limit: 56, # Integer | Number of items to include in the response
|
35
35
|
page: 56, # Integer | Offset by this many pages, of the size of `limit`
|
36
36
|
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`
|
37
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
37
38
|
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
39
|
}
|
39
40
|
|
@@ -72,6 +73,7 @@ end
|
|
72
73
|
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
73
74
|
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
74
75
|
| **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] |
|
76
|
+
| **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`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
75
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] |
|
76
78
|
|
77
79
|
### Return type
|
data/docs/ErrorsApi.md
CHANGED
@@ -30,6 +30,7 @@ end
|
|
30
30
|
api_instance = MuxRuby::ErrorsApi.new
|
31
31
|
opts = {
|
32
32
|
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`
|
33
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
33
34
|
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`
|
34
35
|
}
|
35
36
|
|
@@ -65,6 +66,7 @@ end
|
|
65
66
|
| Name | Type | Description | Notes |
|
66
67
|
| ---- | ---- | ----------- | ----- |
|
67
68
|
| **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] |
|
69
|
+
| **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`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
68
70
|
| **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] |
|
69
71
|
|
70
72
|
### Return type
|
data/docs/InputSettings.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **url** | **String** | The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input. | [optional] |
|
7
|
+
| **url** | **String** | The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. The maximum size is 4096x4096. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input. | [optional] |
|
8
8
|
| **overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) | | [optional] |
|
9
9
|
| **generated_subtitles** | [**Array<AssetGeneratedSubtitleSettings>**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition using this configuration. This may only be provided for the first input object (the main input file). For direct uploads, this first input should omit the url parameter, as the main input file is provided via the direct upload. This will create subtitles based on the audio track ingested from that main input file. Note that subtitle generation happens after initial ingest, so the generated tracks will be in the `preparing` state when the asset transitions to `ready`. | [optional] |
|
10
10
|
| **start_time** | **Float** | The time offset in seconds from the beginning of the video indicating the clip's starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. | [optional] |
|
data/docs/LiveStream.md
CHANGED
@@ -25,6 +25,7 @@
|
|
25
25
|
| **latency_mode** | **String** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. | [optional] |
|
26
26
|
| **test** | **Boolean** | True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] |
|
27
27
|
| **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] |
|
28
|
+
| **srt_passphrase** | **String** | Unique key used for encrypting a stream to a Mux SRT endpoint. | [optional] |
|
28
29
|
|
29
30
|
## Example
|
30
31
|
|
@@ -52,7 +53,8 @@ instance = MuxRuby::LiveStream.new(
|
|
52
53
|
simulcast_targets: null,
|
53
54
|
latency_mode: null,
|
54
55
|
test: null,
|
55
|
-
max_continuous_duration: null
|
56
|
+
max_continuous_duration: null,
|
57
|
+
srt_passphrase: null
|
56
58
|
)
|
57
59
|
```
|
58
60
|
|
data/docs/MetricsApi.md
CHANGED
@@ -36,6 +36,7 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
|
36
36
|
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
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
39
40
|
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
40
41
|
order_direction: 'asc', # String | Sort order.
|
41
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.
|
@@ -75,6 +76,7 @@ end
|
|
75
76
|
| **metric_id** | **String** | ID of the Metric | |
|
76
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] |
|
77
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
|
+
| **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`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
78
80
|
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
79
81
|
| **order_direction** | **String** | Sort order. | [optional] |
|
80
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] |
|
@@ -118,6 +120,7 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
|
118
120
|
opts = {
|
119
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`
|
120
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
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
121
124
|
measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
122
125
|
}
|
123
126
|
|
@@ -155,6 +158,7 @@ end
|
|
155
158
|
| **metric_id** | **String** | ID of the Metric | |
|
156
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] |
|
157
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
|
+
| **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`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
158
162
|
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
159
163
|
|
160
164
|
### Return type
|
@@ -195,6 +199,7 @@ api_instance = MuxRuby::MetricsApi.new
|
|
195
199
|
opts = {
|
196
200
|
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`
|
197
201
|
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`
|
202
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
198
203
|
dimension: 'asn', # String | Dimension the specified value belongs to
|
199
204
|
value: 'value_example' # String | Value to show all available metrics for
|
200
205
|
}
|
@@ -232,6 +237,7 @@ end
|
|
232
237
|
| ---- | ---- | ----------- | ----- |
|
233
238
|
| **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] |
|
234
239
|
| **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] |
|
240
|
+
| **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`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
235
241
|
| **dimension** | **String** | Dimension the specified value belongs to | [optional] |
|
236
242
|
| **value** | **String** | Value to show all available metrics for | [optional] |
|
237
243
|
|
@@ -275,6 +281,7 @@ opts = {
|
|
275
281
|
group_by: 'asn', # String | Breakdown value to group the results by
|
276
282
|
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
277
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
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
278
285
|
limit: 56, # Integer | Number of items to include in the response
|
279
286
|
page: 56, # Integer | Offset by this many pages, of the size of `limit`
|
280
287
|
order_by: 'negative_impact', # String | Value to order the results by
|
@@ -317,6 +324,7 @@ end
|
|
317
324
|
| **group_by** | **String** | Breakdown value to group the results by | [optional] |
|
318
325
|
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
319
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
|
+
| **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`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
320
328
|
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
321
329
|
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
322
330
|
| **order_by** | **String** | Value to order the results by | [optional] |
|
@@ -362,7 +370,9 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
|
|
362
370
|
opts = {
|
363
371
|
measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
|
364
372
|
order_direction: 'asc', # String | Sort order.
|
365
|
-
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`
|
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
|
+
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`
|
375
|
+
metric_filters: ['inner_example'] # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
366
376
|
}
|
367
377
|
|
368
378
|
begin
|
@@ -400,6 +410,8 @@ end
|
|
400
410
|
| **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
|
401
411
|
| **order_direction** | **String** | Sort order. | [optional] |
|
402
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
|
+
| **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] |
|
414
|
+
| **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`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
403
415
|
|
404
416
|
### Return type
|
405
417
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **allowed_domains** | **Array<String>** | List of domains allowed to play videos. Possible values are * `[]` Empty Array indicates deny video playback requests for all domains * `[\"*\"]` A Single Wildcard `*` entry means allow video playback requests from any domain *
|
7
|
+
| **allowed_domains** | **Array<String>** | List of domains allowed to play videos. Possible values are * `[]` Empty Array indicates deny video playback requests for all domains * `[\"*\"]` A Single Wildcard `*` entry means allow video playback requests from any domain * `[\"*.example.com\", \"foo.com\"]` A list of up to 10 domains or valid dns-style wildcards | [optional] |
|
8
8
|
| **allow_no_referrer** | **Boolean** | A boolean to determine whether to allow or deny HTTP requests without `Referer` HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a `Referer` HTTP header. Set this value to `true` to allow these playback requests. | [optional][default to false] |
|
9
9
|
|
10
10
|
## Example
|
data/docs/Track.md
CHANGED
@@ -19,6 +19,7 @@
|
|
19
19
|
| **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set tracks where `type` is `text` and `text_type` is `subtitles`. | [optional] |
|
20
20
|
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. This parameter is only set for `text` type tracks. Max 255 characters. | [optional] |
|
21
21
|
| **status** | **String** | The status of the track. This parameter is only set for `text` type tracks. | [optional] |
|
22
|
+
| **primary** | **Boolean** | For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted. | [optional] |
|
22
23
|
|
23
24
|
## Example
|
24
25
|
|
@@ -40,7 +41,8 @@ instance = MuxRuby::Track.new(
|
|
40
41
|
name: null,
|
41
42
|
closed_captions: null,
|
42
43
|
passthrough: null,
|
43
|
-
status: null
|
44
|
+
status: null,
|
45
|
+
primary: null
|
44
46
|
)
|
45
47
|
```
|
46
48
|
|
data/docs/VideoView.md
CHANGED
@@ -123,7 +123,7 @@
|
|
123
123
|
| **view_session_id** | **String** | | [optional] |
|
124
124
|
| **viewer_connection_type** | **String** | | [optional] |
|
125
125
|
| **viewer_device_model** | **String** | | [optional] |
|
126
|
-
| **weighted_average_bitrate** | **
|
126
|
+
| **weighted_average_bitrate** | **Float** | | [optional] |
|
127
127
|
| **custom_1** | **String** | | [optional] |
|
128
128
|
| **custom_2** | **String** | | [optional] |
|
129
129
|
| **custom_3** | **String** | | [optional] |
|
@@ -145,6 +145,17 @@
|
|
145
145
|
| **view_dropped_frame_count** | **Integer** | | [optional] |
|
146
146
|
| **view_has_ad** | **Boolean** | | [optional] |
|
147
147
|
| **video_startup_failure** | **Boolean** | | [optional] |
|
148
|
+
| **ad_attempt_count** | **Integer** | | [optional] |
|
149
|
+
| **ad_break_count** | **Integer** | | [optional] |
|
150
|
+
| **ad_break_error_count** | **Integer** | | [optional] |
|
151
|
+
| **ad_break_error_percentage** | **String** | | [optional] |
|
152
|
+
| **ad_error_count** | **Integer** | | [optional] |
|
153
|
+
| **ad_error_percentage** | **String** | | [optional] |
|
154
|
+
| **ad_impression_count** | **Integer** | | [optional] |
|
155
|
+
| **ad_startup_error_count** | **Integer** | | [optional] |
|
156
|
+
| **ad_startup_error_percentage** | **String** | | [optional] |
|
157
|
+
| **ad_exit_before_start_count** | **Integer** | | [optional] |
|
158
|
+
| **ad_exit_before_start_percentage** | **String** | | [optional] |
|
148
159
|
| **long_resume** | **Boolean** | | [optional] |
|
149
160
|
| **long_rebuffering** | **Boolean** | | [optional] |
|
150
161
|
|
@@ -295,6 +306,17 @@ instance = MuxRuby::VideoView.new(
|
|
295
306
|
view_dropped_frame_count: null,
|
296
307
|
view_has_ad: null,
|
297
308
|
video_startup_failure: null,
|
309
|
+
ad_attempt_count: null,
|
310
|
+
ad_break_count: null,
|
311
|
+
ad_break_error_count: null,
|
312
|
+
ad_break_error_percentage: null,
|
313
|
+
ad_error_count: null,
|
314
|
+
ad_error_percentage: null,
|
315
|
+
ad_impression_count: null,
|
316
|
+
ad_startup_error_count: null,
|
317
|
+
ad_startup_error_percentage: null,
|
318
|
+
ad_exit_before_start_count: null,
|
319
|
+
ad_exit_before_start_percentage: null,
|
298
320
|
long_resume: null,
|
299
321
|
long_rebuffering: null
|
300
322
|
)
|
data/docs/VideoViewsApi.md
CHANGED
@@ -106,6 +106,7 @@ opts = {
|
|
106
106
|
error_id: 56, # Integer | Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error.
|
107
107
|
order_direction: 'asc', # String | Sort order.
|
108
108
|
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`
|
109
|
+
metric_filters: ['inner_example'], # Array<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
109
110
|
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`
|
110
111
|
}
|
111
112
|
|
@@ -146,6 +147,7 @@ end
|
|
146
147
|
| **error_id** | **Integer** | Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error. | [optional] |
|
147
148
|
| **order_direction** | **String** | Sort order. | [optional] |
|
148
149
|
| **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] |
|
150
|
+
| **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`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000` | [optional] |
|
149
151
|
| **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] |
|
150
152
|
|
151
153
|
### Return type
|
data/gen/generator-config.json
CHANGED
@@ -26,6 +26,7 @@ module MuxRuby
|
|
26
26
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
27
27
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
28
28
|
# @option opts [Array<String>] :filters Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
29
|
+
# @option opts [Array<String>] :metric_filters Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
29
30
|
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
|
30
31
|
# @return [ListDimensionValuesResponse]
|
31
32
|
def list_dimension_values(dimension_id, opts = {})
|
@@ -40,6 +41,7 @@ module MuxRuby
|
|
40
41
|
# @option opts [Integer] :limit Number of items to include in the response
|
41
42
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|
42
43
|
# @option opts [Array<String>] :filters Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
44
|
+
# @option opts [Array<String>] :metric_filters Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
43
45
|
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
|
44
46
|
# @return [Array<(ListDimensionValuesResponse, Integer, Hash)>] ListDimensionValuesResponse data, response status code and response headers
|
45
47
|
def list_dimension_values_with_http_info(dimension_id, opts = {})
|
@@ -58,6 +60,7 @@ module MuxRuby
|
|
58
60
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
59
61
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
60
62
|
query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
|
63
|
+
query_params[:'metric_filters[]'] = @api_client.build_collection_param(opts[:'metric_filters'], :multi) if !opts[:'metric_filters'].nil?
|
61
64
|
query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
|
62
65
|
|
63
66
|
# header parameters
|
@@ -23,6 +23,7 @@ module MuxRuby
|
|
23
23
|
# Returns a list of errors.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @option opts [Array<String>] :filters Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
26
|
+
# @option opts [Array<String>] :metric_filters Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
26
27
|
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
|
27
28
|
# @return [ListErrorsResponse]
|
28
29
|
def list_errors(opts = {})
|
@@ -34,6 +35,7 @@ module MuxRuby
|
|
34
35
|
# Returns a list of errors.
|
35
36
|
# @param [Hash] opts the optional parameters
|
36
37
|
# @option opts [Array<String>] :filters Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
38
|
+
# @option opts [Array<String>] :metric_filters Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
37
39
|
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
|
38
40
|
# @return [Array<(ListErrorsResponse, Integer, Hash)>] ListErrorsResponse data, response status code and response headers
|
39
41
|
def list_errors_with_http_info(opts = {})
|
@@ -46,6 +48,7 @@ module MuxRuby
|
|
46
48
|
# query parameters
|
47
49
|
query_params = opts[:query_params] || {}
|
48
50
|
query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
|
51
|
+
query_params[:'metric_filters[]'] = @api_client.build_collection_param(opts[:'metric_filters'], :multi) if !opts[:'metric_filters'].nil?
|
49
52
|
query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
|
50
53
|
|
51
54
|
# header parameters
|