mux_ruby 3.9.0 → 3.11.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CODEOWNERS +1 -1
- data/Gemfile.lock +2 -2
- data/README.md +4 -4
- data/docs/Asset.md +7 -1
- data/docs/AssetGeneratedSubtitleSettings.md +22 -0
- data/docs/AssetNonStandardInputReasons.md +3 -1
- data/docs/AssetsApi.md +1 -1
- data/docs/CreateAssetRequest.md +5 -1
- data/docs/CreateLiveStreamRequest.md +3 -3
- data/docs/CreateTrackRequest.md +2 -2
- data/docs/DeliveryReport.md +2 -0
- data/docs/DeliveryReportDeliveredSecondsByResolution.md +5 -1
- data/docs/DirectUploadsApi.md +1 -1
- data/docs/GetMonitoringBreakdownTimeseriesResponse.md +22 -0
- data/docs/InputSettings.md +7 -5
- data/docs/LiveStream.md +4 -4
- data/docs/MetricsApi.md +2 -2
- data/docs/MonitoringApi.md +93 -6
- data/docs/MonitoringBreakdownTimeseriesDatapoint.md +22 -0
- data/docs/MonitoringBreakdownTimeseriesValues.md +20 -0
- data/docs/RealTimeApi.md +8 -6
- data/docs/SigningKeysApi.md +291 -0
- data/docs/Track.md +4 -4
- data/docs/URLSigningKeysApi.md +4 -4
- data/docs/UpdateLiveStreamRequest.md +1 -1
- data/docs/VideoView.md +33 -1
- data/examples/video/exercise-signing-keys.rb +5 -4
- data/gen/generator-config.json +1 -1
- data/gen/package.json +1 -1
- data/gen/yarn.lock +593 -129
- data/lib/mux_ruby/api/assets_api.rb +2 -2
- data/lib/mux_ruby/api/direct_uploads_api.rb +2 -2
- data/lib/mux_ruby/api/metrics_api.rb +9 -9
- data/lib/mux_ruby/api/monitoring_api.rb +110 -9
- data/lib/mux_ruby/api/real_time_api.rb +9 -6
- data/lib/mux_ruby/api/signing_keys_api.rb +266 -0
- data/lib/mux_ruby/api/url_signing_keys_api.rb +8 -8
- data/lib/mux_ruby/models/asset.rb +68 -2
- data/lib/mux_ruby/models/asset_generated_subtitle_settings.rb +275 -0
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +14 -4
- data/lib/mux_ruby/models/create_asset_request.rb +48 -4
- data/lib/mux_ruby/models/create_live_stream_request.rb +3 -3
- data/lib/mux_ruby/models/create_track_request.rb +4 -3
- data/lib/mux_ruby/models/delivery_report.rb +23 -1
- data/lib/mux_ruby/models/delivery_report_delivered_seconds_by_resolution.rb +22 -2
- data/lib/mux_ruby/models/get_monitoring_breakdown_timeseries_response.rb +240 -0
- data/lib/mux_ruby/models/input_settings.rb +18 -6
- data/lib/mux_ruby/models/live_stream.rb +4 -4
- data/lib/mux_ruby/models/live_stream_embedded_subtitle_settings.rb +2 -2
- data/lib/mux_ruby/models/monitoring_breakdown_timeseries_datapoint.rb +236 -0
- data/lib/mux_ruby/models/monitoring_breakdown_timeseries_values.rb +229 -0
- data/lib/mux_ruby/models/track.rb +4 -4
- data/lib/mux_ruby/models/update_live_stream_request.rb +1 -1
- data/lib/mux_ruby/models/video_view.rb +162 -5
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +5 -0
- data/spec/api/signing_keys_api_spec.rb +83 -0
- data/spec/models/asset_generated_subtitle_settings_spec.rb +50 -0
- data/spec/models/get_monitoring_breakdown_timeseries_response_spec.rb +46 -0
- data/spec/models/monitoring_breakdown_timeseries_datapoint_spec.rb +46 -0
- data/spec/models/monitoring_breakdown_timeseries_values_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.15.5/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/mkmf.log +15 -15
- 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 +6 -6
- 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.15.5/ext/ffi_c/Makefile +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/ffi-1.15.5/lib/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +6 -6
- 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 +6 -6
- 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 +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/lib/stringio.so +0 -0
- data/vendor/bundle/ruby/3.2.0/specifications/ast-2.4.2.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/byebug-11.1.3.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/coderay-1.1.3.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/diff-lcs-1.5.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/ethon-0.16.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/ffi-1.15.5.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/jaro_winkler-1.5.4.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/method_source-1.0.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/parallel-1.22.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/parser-3.1.2.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/pry-0.13.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/pry-byebug-3.9.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/psych-4.0.4.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rainbow-3.1.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rake-13.0.6.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-core-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-expectations-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-mocks-3.11.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-support-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rubocop-0.66.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/ruby-progressbar-1.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/solid_assert-1.1.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/stringio-3.0.2.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/typhoeus-1.4.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/unicode-display_width-1.5.0.gemspec +2 -2
- metadata +160 -140
data/docs/RealTimeApi.md
CHANGED
@@ -36,7 +36,7 @@ realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime
|
|
36
36
|
opts = {
|
37
37
|
dimension: 'asn', # String | Dimension the specified value belongs to
|
38
38
|
timestamp: 56, # Integer | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
39
|
-
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
|
39
|
+
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 Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
40
40
|
order_by: 'negative_impact', # String | Value to order the results by
|
41
41
|
order_direction: 'asc' # String | Sort order.
|
42
42
|
}
|
@@ -75,7 +75,7 @@ end
|
|
75
75
|
| **realtime_metric_id** | **String** | ID of the Realtime Metric | |
|
76
76
|
| **dimension** | **String** | Dimension the specified value belongs to | [optional] |
|
77
77
|
| **timestamp** | **Integer** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
|
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
|
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 Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US` | [optional] |
|
79
79
|
| **order_by** | **String** | Value to order the results by | [optional] |
|
80
80
|
| **order_direction** | **String** | Sort order. | [optional] |
|
81
81
|
|
@@ -116,7 +116,7 @@ end
|
|
116
116
|
api_instance = MuxRuby::RealTimeApi.new
|
117
117
|
realtime_histogram_metric_id = 'video-startup-time' # String | ID of the Realtime Histogram Metric
|
118
118
|
opts = {
|
119
|
-
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
|
119
|
+
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 Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
120
120
|
}
|
121
121
|
|
122
122
|
begin
|
@@ -151,7 +151,7 @@ end
|
|
151
151
|
| Name | Type | Description | Notes |
|
152
152
|
| ---- | ---- | ----------- | ----- |
|
153
153
|
| **realtime_histogram_metric_id** | **String** | ID of the Realtime Histogram Metric | |
|
154
|
-
| **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
|
154
|
+
| **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 Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US` | [optional] |
|
155
155
|
|
156
156
|
### Return type
|
157
157
|
|
@@ -190,7 +190,8 @@ end
|
|
190
190
|
api_instance = MuxRuby::RealTimeApi.new
|
191
191
|
realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime Metric
|
192
192
|
opts = {
|
193
|
-
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
|
193
|
+
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 Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
194
|
+
timestamp: 56 # Integer | Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.
|
194
195
|
}
|
195
196
|
|
196
197
|
begin
|
@@ -225,7 +226,8 @@ end
|
|
225
226
|
| Name | Type | Description | Notes |
|
226
227
|
| ---- | ---- | ----------- | ----- |
|
227
228
|
| **realtime_metric_id** | **String** | ID of the Realtime Metric | |
|
228
|
-
| **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
|
229
|
+
| **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 Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US` | [optional] |
|
230
|
+
| **timestamp** | **Integer** | Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago. | [optional] |
|
229
231
|
|
230
232
|
### Return type
|
231
233
|
|
@@ -0,0 +1,291 @@
|
|
1
|
+
# MuxRuby::SigningKeysApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.mux.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_signing_key**](SigningKeysApi.md#create_signing_key) | **POST** /system/v1/signing-keys | Create a signing key |
|
8
|
+
| [**delete_signing_key**](SigningKeysApi.md#delete_signing_key) | **DELETE** /system/v1/signing-keys/{SIGNING_KEY_ID} | Delete a signing key |
|
9
|
+
| [**get_signing_key**](SigningKeysApi.md#get_signing_key) | **GET** /system/v1/signing-keys/{SIGNING_KEY_ID} | Retrieve a signing key |
|
10
|
+
| [**list_signing_keys**](SigningKeysApi.md#list_signing_keys) | **GET** /system/v1/signing-keys | List signing keys |
|
11
|
+
|
12
|
+
|
13
|
+
## create_signing_key
|
14
|
+
|
15
|
+
> <SigningKeyResponse> create_signing_key
|
16
|
+
|
17
|
+
Create a signing key
|
18
|
+
|
19
|
+
Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'mux_ruby'
|
26
|
+
# setup authorization
|
27
|
+
MuxRuby.configure do |config|
|
28
|
+
# Configure HTTP basic authorization: accessToken
|
29
|
+
config.username = 'YOUR USERNAME'
|
30
|
+
config.password = 'YOUR PASSWORD'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = MuxRuby::SigningKeysApi.new
|
34
|
+
|
35
|
+
begin
|
36
|
+
# Create a signing key
|
37
|
+
result = api_instance.create_signing_key
|
38
|
+
p result
|
39
|
+
rescue MuxRuby::ApiError => e
|
40
|
+
puts "Error when calling SigningKeysApi->create_signing_key: #{e}"
|
41
|
+
end
|
42
|
+
```
|
43
|
+
|
44
|
+
#### Using the create_signing_key_with_http_info variant
|
45
|
+
|
46
|
+
This returns an Array which contains the response data, status code and headers.
|
47
|
+
|
48
|
+
> <Array(<SigningKeyResponse>, Integer, Hash)> create_signing_key_with_http_info
|
49
|
+
|
50
|
+
```ruby
|
51
|
+
begin
|
52
|
+
# Create a signing key
|
53
|
+
data, status_code, headers = api_instance.create_signing_key_with_http_info
|
54
|
+
p status_code # => 2xx
|
55
|
+
p headers # => { ... }
|
56
|
+
p data # => <SigningKeyResponse>
|
57
|
+
rescue MuxRuby::ApiError => e
|
58
|
+
puts "Error when calling SigningKeysApi->create_signing_key_with_http_info: #{e}"
|
59
|
+
end
|
60
|
+
```
|
61
|
+
|
62
|
+
### Parameters
|
63
|
+
|
64
|
+
This endpoint does not need any parameter.
|
65
|
+
|
66
|
+
### Return type
|
67
|
+
|
68
|
+
[**SigningKeyResponse**](SigningKeyResponse.md)
|
69
|
+
|
70
|
+
### Authorization
|
71
|
+
|
72
|
+
[accessToken](../README.md#accessToken)
|
73
|
+
|
74
|
+
### HTTP request headers
|
75
|
+
|
76
|
+
- **Content-Type**: Not defined
|
77
|
+
- **Accept**: application/json
|
78
|
+
|
79
|
+
|
80
|
+
## delete_signing_key
|
81
|
+
|
82
|
+
> delete_signing_key(signing_key_id)
|
83
|
+
|
84
|
+
Delete a signing key
|
85
|
+
|
86
|
+
Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no JWTs can be signed using the key again.
|
87
|
+
|
88
|
+
### Examples
|
89
|
+
|
90
|
+
```ruby
|
91
|
+
require 'time'
|
92
|
+
require 'mux_ruby'
|
93
|
+
# setup authorization
|
94
|
+
MuxRuby.configure do |config|
|
95
|
+
# Configure HTTP basic authorization: accessToken
|
96
|
+
config.username = 'YOUR USERNAME'
|
97
|
+
config.password = 'YOUR PASSWORD'
|
98
|
+
end
|
99
|
+
|
100
|
+
api_instance = MuxRuby::SigningKeysApi.new
|
101
|
+
signing_key_id = 'signing_key_id_example' # String | The ID of the signing key.
|
102
|
+
|
103
|
+
begin
|
104
|
+
# Delete a signing key
|
105
|
+
api_instance.delete_signing_key(signing_key_id)
|
106
|
+
rescue MuxRuby::ApiError => e
|
107
|
+
puts "Error when calling SigningKeysApi->delete_signing_key: #{e}"
|
108
|
+
end
|
109
|
+
```
|
110
|
+
|
111
|
+
#### Using the delete_signing_key_with_http_info variant
|
112
|
+
|
113
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
114
|
+
|
115
|
+
> <Array(nil, Integer, Hash)> delete_signing_key_with_http_info(signing_key_id)
|
116
|
+
|
117
|
+
```ruby
|
118
|
+
begin
|
119
|
+
# Delete a signing key
|
120
|
+
data, status_code, headers = api_instance.delete_signing_key_with_http_info(signing_key_id)
|
121
|
+
p status_code # => 2xx
|
122
|
+
p headers # => { ... }
|
123
|
+
p data # => nil
|
124
|
+
rescue MuxRuby::ApiError => e
|
125
|
+
puts "Error when calling SigningKeysApi->delete_signing_key_with_http_info: #{e}"
|
126
|
+
end
|
127
|
+
```
|
128
|
+
|
129
|
+
### Parameters
|
130
|
+
|
131
|
+
| Name | Type | Description | Notes |
|
132
|
+
| ---- | ---- | ----------- | ----- |
|
133
|
+
| **signing_key_id** | **String** | The ID of the signing key. | |
|
134
|
+
|
135
|
+
### Return type
|
136
|
+
|
137
|
+
nil (empty response body)
|
138
|
+
|
139
|
+
### Authorization
|
140
|
+
|
141
|
+
[accessToken](../README.md#accessToken)
|
142
|
+
|
143
|
+
### HTTP request headers
|
144
|
+
|
145
|
+
- **Content-Type**: Not defined
|
146
|
+
- **Accept**: Not defined
|
147
|
+
|
148
|
+
|
149
|
+
## get_signing_key
|
150
|
+
|
151
|
+
> <SigningKeyResponse> get_signing_key(signing_key_id)
|
152
|
+
|
153
|
+
Retrieve a signing key
|
154
|
+
|
155
|
+
Retrieves the details of a signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.**
|
156
|
+
|
157
|
+
### Examples
|
158
|
+
|
159
|
+
```ruby
|
160
|
+
require 'time'
|
161
|
+
require 'mux_ruby'
|
162
|
+
# setup authorization
|
163
|
+
MuxRuby.configure do |config|
|
164
|
+
# Configure HTTP basic authorization: accessToken
|
165
|
+
config.username = 'YOUR USERNAME'
|
166
|
+
config.password = 'YOUR PASSWORD'
|
167
|
+
end
|
168
|
+
|
169
|
+
api_instance = MuxRuby::SigningKeysApi.new
|
170
|
+
signing_key_id = 'signing_key_id_example' # String | The ID of the signing key.
|
171
|
+
|
172
|
+
begin
|
173
|
+
# Retrieve a signing key
|
174
|
+
result = api_instance.get_signing_key(signing_key_id)
|
175
|
+
p result
|
176
|
+
rescue MuxRuby::ApiError => e
|
177
|
+
puts "Error when calling SigningKeysApi->get_signing_key: #{e}"
|
178
|
+
end
|
179
|
+
```
|
180
|
+
|
181
|
+
#### Using the get_signing_key_with_http_info variant
|
182
|
+
|
183
|
+
This returns an Array which contains the response data, status code and headers.
|
184
|
+
|
185
|
+
> <Array(<SigningKeyResponse>, Integer, Hash)> get_signing_key_with_http_info(signing_key_id)
|
186
|
+
|
187
|
+
```ruby
|
188
|
+
begin
|
189
|
+
# Retrieve a signing key
|
190
|
+
data, status_code, headers = api_instance.get_signing_key_with_http_info(signing_key_id)
|
191
|
+
p status_code # => 2xx
|
192
|
+
p headers # => { ... }
|
193
|
+
p data # => <SigningKeyResponse>
|
194
|
+
rescue MuxRuby::ApiError => e
|
195
|
+
puts "Error when calling SigningKeysApi->get_signing_key_with_http_info: #{e}"
|
196
|
+
end
|
197
|
+
```
|
198
|
+
|
199
|
+
### Parameters
|
200
|
+
|
201
|
+
| Name | Type | Description | Notes |
|
202
|
+
| ---- | ---- | ----------- | ----- |
|
203
|
+
| **signing_key_id** | **String** | The ID of the signing key. | |
|
204
|
+
|
205
|
+
### Return type
|
206
|
+
|
207
|
+
[**SigningKeyResponse**](SigningKeyResponse.md)
|
208
|
+
|
209
|
+
### Authorization
|
210
|
+
|
211
|
+
[accessToken](../README.md#accessToken)
|
212
|
+
|
213
|
+
### HTTP request headers
|
214
|
+
|
215
|
+
- **Content-Type**: Not defined
|
216
|
+
- **Accept**: application/json
|
217
|
+
|
218
|
+
|
219
|
+
## list_signing_keys
|
220
|
+
|
221
|
+
> <ListSigningKeysResponse> list_signing_keys(opts)
|
222
|
+
|
223
|
+
List signing keys
|
224
|
+
|
225
|
+
Returns a list of signing keys.
|
226
|
+
|
227
|
+
### Examples
|
228
|
+
|
229
|
+
```ruby
|
230
|
+
require 'time'
|
231
|
+
require 'mux_ruby'
|
232
|
+
# setup authorization
|
233
|
+
MuxRuby.configure do |config|
|
234
|
+
# Configure HTTP basic authorization: accessToken
|
235
|
+
config.username = 'YOUR USERNAME'
|
236
|
+
config.password = 'YOUR PASSWORD'
|
237
|
+
end
|
238
|
+
|
239
|
+
api_instance = MuxRuby::SigningKeysApi.new
|
240
|
+
opts = {
|
241
|
+
limit: 56, # Integer | Number of items to include in the response
|
242
|
+
page: 56 # Integer | Offset by this many pages, of the size of `limit`
|
243
|
+
}
|
244
|
+
|
245
|
+
begin
|
246
|
+
# List signing keys
|
247
|
+
result = api_instance.list_signing_keys(opts)
|
248
|
+
p result
|
249
|
+
rescue MuxRuby::ApiError => e
|
250
|
+
puts "Error when calling SigningKeysApi->list_signing_keys: #{e}"
|
251
|
+
end
|
252
|
+
```
|
253
|
+
|
254
|
+
#### Using the list_signing_keys_with_http_info variant
|
255
|
+
|
256
|
+
This returns an Array which contains the response data, status code and headers.
|
257
|
+
|
258
|
+
> <Array(<ListSigningKeysResponse>, Integer, Hash)> list_signing_keys_with_http_info(opts)
|
259
|
+
|
260
|
+
```ruby
|
261
|
+
begin
|
262
|
+
# List signing keys
|
263
|
+
data, status_code, headers = api_instance.list_signing_keys_with_http_info(opts)
|
264
|
+
p status_code # => 2xx
|
265
|
+
p headers # => { ... }
|
266
|
+
p data # => <ListSigningKeysResponse>
|
267
|
+
rescue MuxRuby::ApiError => e
|
268
|
+
puts "Error when calling SigningKeysApi->list_signing_keys_with_http_info: #{e}"
|
269
|
+
end
|
270
|
+
```
|
271
|
+
|
272
|
+
### Parameters
|
273
|
+
|
274
|
+
| Name | Type | Description | Notes |
|
275
|
+
| ---- | ---- | ----------- | ----- |
|
276
|
+
| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
|
277
|
+
| **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
|
278
|
+
|
279
|
+
### Return type
|
280
|
+
|
281
|
+
[**ListSigningKeysResponse**](ListSigningKeysResponse.md)
|
282
|
+
|
283
|
+
### Authorization
|
284
|
+
|
285
|
+
[accessToken](../README.md#accessToken)
|
286
|
+
|
287
|
+
### HTTP request headers
|
288
|
+
|
289
|
+
- **Content-Type**: Not defined
|
290
|
+
- **Accept**: application/json
|
291
|
+
|
data/docs/Track.md
CHANGED
@@ -13,10 +13,10 @@
|
|
13
13
|
| **max_channels** | **Integer** | The maximum number of audio channels the track supports. Only set for the `audio` type track. | [optional] |
|
14
14
|
| **max_channel_layout** | **String** | Only set for the `audio` type track. | [optional] |
|
15
15
|
| **text_type** | **String** | This parameter is only set for `text` type tracks. | [optional] |
|
16
|
-
| **text_source** | **String** | The source of the text contained in a Track of type `text`. Valid `text_source` values are listed below. * `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API. * `embedded`: Tracks extracted from an embedded stream of CEA-608 closed captions. * `generated_live`: Tracks generated by automatic speech recognition on a live stream configured with `generated_subtitles`. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. * `generated_live_final`: Tracks generated by automatic speech recognition on a live stream using `generated_subtitles`. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding `generated_live` tracks. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] |
|
17
|
-
| **language_code** | **String** | The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is only set for `text`
|
18
|
-
| **name** | **String** | The name of the track containing a human-readable description. The
|
19
|
-
| **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set
|
16
|
+
| **text_source** | **String** | The source of the text contained in a Track of type `text`. Valid `text_source` values are listed below. * `uploaded`: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API. * `embedded`: Tracks extracted from an embedded stream of CEA-608 closed captions. * `generated_vod`: Tracks generated by automatic speech recognition on an on-demand asset. * `generated_live`: Tracks generated by automatic speech recognition on a live stream configured with `generated_subtitles`. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. * `generated_live_final`: Tracks generated by automatic speech recognition on a live stream using `generated_subtitles`. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding `generated_live` tracks. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] |
|
17
|
+
| **language_code** | **String** | The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is only set for `text` and `audio` track types. | [optional] |
|
18
|
+
| **name** | **String** | The name of the track containing a human-readable description. The HLS manifest will associate a subtitle `text` or `audio` track with this value. For example, the value should be \"English\" for a subtitle text track for the `language_code` value of `en-US`. This parameter is only set for `text` and `audio` track types. | [optional] |
|
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
22
|
|
data/docs/URLSigningKeysApi.md
CHANGED
@@ -16,7 +16,7 @@ All URIs are relative to *https://api.mux.com*
|
|
16
16
|
|
17
17
|
Create a URL signing key
|
18
18
|
|
19
|
-
Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
|
19
|
+
This route is now deprecated, please use the `Signing Keys` API. Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens. Note: Any new access tokens authenticating this route will be required to have `System` level permissions.
|
20
20
|
|
21
21
|
### Examples
|
22
22
|
|
@@ -83,7 +83,7 @@ This endpoint does not need any parameter.
|
|
83
83
|
|
84
84
|
Delete a URL signing key
|
85
85
|
|
86
|
-
Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.
|
86
|
+
This route is now deprecated, please use the `Signing Keys` API. Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again. Note: Any new access tokens authenticating this route will be required to have `System` level permissions.
|
87
87
|
|
88
88
|
### Examples
|
89
89
|
|
@@ -152,7 +152,7 @@ nil (empty response body)
|
|
152
152
|
|
153
153
|
Retrieve a URL signing key
|
154
154
|
|
155
|
-
Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.**
|
155
|
+
This route is now deprecated, please use the `Signing Keys` API. Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** Note: Any new access tokens authenticating this route will be required to have `System` level permissions.
|
156
156
|
|
157
157
|
### Examples
|
158
158
|
|
@@ -222,7 +222,7 @@ end
|
|
222
222
|
|
223
223
|
List URL signing keys
|
224
224
|
|
225
|
-
Returns a list of URL signing keys.
|
225
|
+
This route is now deprecated, please use the `Signing Keys` API. Returns a list of URL signing keys. Note: Any new access tokens authenticating this route will be required to have `System` level permissions.
|
226
226
|
|
227
227
|
### Examples
|
228
228
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **passthrough** | **String** | Arbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value. | [optional] |
|
8
8
|
| **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. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] |
|
9
|
-
| **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional][default to 60] |
|
9
|
+
| **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional][default to 60] |
|
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] |
|
data/docs/VideoView.md
CHANGED
@@ -129,6 +129,22 @@
|
|
129
129
|
| **custom_3** | **String** | | [optional] |
|
130
130
|
| **custom_4** | **String** | | [optional] |
|
131
131
|
| **custom_5** | **String** | | [optional] |
|
132
|
+
| **custom_6** | **String** | | [optional] |
|
133
|
+
| **custom_7** | **String** | | [optional] |
|
134
|
+
| **custom_8** | **String** | | [optional] |
|
135
|
+
| **custom_9** | **String** | | [optional] |
|
136
|
+
| **custom_10** | **String** | | [optional] |
|
137
|
+
| **live_stream_latency** | **Integer** | | [optional] |
|
138
|
+
| **asset_id** | **String** | | [optional] |
|
139
|
+
| **environment_id** | **String** | | [optional] |
|
140
|
+
| **live_stream_id** | **String** | | [optional] |
|
141
|
+
| **mux_embed** | **String** | | [optional] |
|
142
|
+
| **playback_id** | **String** | | [optional] |
|
143
|
+
| **player_error_context** | **String** | | [optional] |
|
144
|
+
| **view_drm_type** | **String** | | [optional] |
|
145
|
+
| **view_dropped_frame_count** | **Integer** | | [optional] |
|
146
|
+
| **view_has_ad** | **Boolean** | | [optional] |
|
147
|
+
| **video_startup_failure** | **Boolean** | | [optional] |
|
132
148
|
|
133
149
|
## Example
|
134
150
|
|
@@ -260,7 +276,23 @@ instance = MuxRuby::VideoView.new(
|
|
260
276
|
custom_2: null,
|
261
277
|
custom_3: null,
|
262
278
|
custom_4: null,
|
263
|
-
custom_5: null
|
279
|
+
custom_5: null,
|
280
|
+
custom_6: null,
|
281
|
+
custom_7: null,
|
282
|
+
custom_8: null,
|
283
|
+
custom_9: null,
|
284
|
+
custom_10: null,
|
285
|
+
live_stream_latency: null,
|
286
|
+
asset_id: null,
|
287
|
+
environment_id: null,
|
288
|
+
live_stream_id: null,
|
289
|
+
mux_embed: null,
|
290
|
+
playback_id: null,
|
291
|
+
player_error_context: null,
|
292
|
+
view_drm_type: null,
|
293
|
+
view_dropped_frame_count: null,
|
294
|
+
view_has_ad: null,
|
295
|
+
video_startup_failure: null
|
264
296
|
)
|
265
297
|
```
|
266
298
|
|
@@ -24,9 +24,9 @@ puts "create-url-signing-key OK ✅"
|
|
24
24
|
# ========== list-url-signing-keys ==========
|
25
25
|
keys = keys_api.list_url_signing_keys()
|
26
26
|
assert keys != nil
|
27
|
-
assert keys.data.
|
28
|
-
assert keys.data.
|
29
|
-
assert keys.data.
|
27
|
+
assert keys.data.last != nil
|
28
|
+
assert keys.data.last.id = key.data.id
|
29
|
+
assert keys.data.last.private_key == nil
|
30
30
|
puts "list-url-signing-keys OK ✅"
|
31
31
|
|
32
32
|
# ========== get-url-signing-key ==========
|
@@ -37,10 +37,11 @@ puts "get-url-signing-key OK ✅"
|
|
37
37
|
# ========== delete-url-signing-key ==========
|
38
38
|
keys_api.delete_url_signing_key(key.data.id)
|
39
39
|
begin
|
40
|
+
sleep 60
|
40
41
|
deleted_key = keys_api.get_url_signing_key(key.data.id)
|
41
42
|
puts 'Should have errored here.'
|
42
43
|
exit 255
|
43
44
|
rescue MuxRuby::NotFoundError => e
|
44
45
|
assert e != nil
|
45
46
|
end
|
46
|
-
puts "delete-url-signing-key OK ✅"
|
47
|
+
puts "delete-url-signing-key OK ✅"
|
data/gen/generator-config.json
CHANGED