mux_ruby 2.1.1 → 3.2.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 +3 -3
- data/README.md +4 -4
- data/docs/Asset.md +1 -1
- data/docs/AssetNonStandardInputReasons.md +2 -0
- data/docs/AssetsApi.md +73 -0
- data/docs/CreateAssetRequest.md +1 -1
- data/docs/CreateLiveStreamRequest.md +6 -2
- data/docs/CreatePlaybackRestrictionRequest.md +18 -0
- data/docs/CreateSimulcastTargetRequest.md +1 -1
- data/docs/CreateTrackRequest.md +1 -1
- data/docs/DeliveryUsageApi.md +4 -2
- data/docs/DimensionsApi.md +4 -4
- data/docs/ErrorsApi.md +4 -4
- data/docs/ExportsApi.md +1 -1
- data/docs/FiltersApi.md +6 -6
- data/docs/GetLiveStreamPlaybackIDResponse.md +18 -0
- data/docs/InputSettings.md +1 -1
- data/docs/LiveStream.md +7 -3
- data/docs/LiveStreamEmbeddedSubtitleSettings.md +24 -0
- data/docs/LiveStreamsApi.md +217 -0
- data/docs/MetricsApi.md +20 -20
- data/docs/PlaybackRestriction.md +24 -0
- data/docs/PlaybackRestrictionResponse.md +15 -0
- data/docs/PlaybackRestrictionsApi.md +367 -0
- data/docs/RealTimeApi.md +6 -6
- data/docs/ReferrerDomainRestriction.md +20 -0
- data/docs/SimulcastTarget.md +1 -1
- data/docs/Track.md +1 -1
- data/docs/UpdateAssetRequest.md +18 -0
- data/docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md +18 -0
- data/docs/UpdateLiveStreamRequest.md +22 -0
- data/docs/UpdateReferrerDomainRestrictionRequest.md +15 -0
- data/docs/VideoViewsApi.md +4 -4
- data/examples/data/exercise-errors.rb +0 -2
- data/examples/video/exercise-assets.rb +1 -0
- data/gen/generator-config.json +1 -1
- data/lib/mux_ruby/api/assets_api.rb +71 -0
- data/lib/mux_ruby/api/delivery_usage_api.rb +5 -2
- data/lib/mux_ruby/api/dimensions_api.rb +4 -4
- data/lib/mux_ruby/api/errors_api.rb +4 -4
- data/lib/mux_ruby/api/exports_api.rb +2 -2
- data/lib/mux_ruby/api/filters_api.rb +8 -8
- data/lib/mux_ruby/api/live_streams_api.rb +209 -0
- data/lib/mux_ruby/api/metrics_api.rb +20 -20
- data/lib/mux_ruby/api/playback_restrictions_api.rb +345 -0
- data/lib/mux_ruby/api/real_time_api.rb +6 -6
- data/lib/mux_ruby/api/video_views_api.rb +4 -4
- data/lib/mux_ruby/models/asset.rb +1 -1
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +23 -1
- data/lib/mux_ruby/models/create_asset_request.rb +1 -1
- data/lib/mux_ruby/models/create_live_stream_request.rb +59 -3
- data/lib/mux_ruby/models/create_playback_restriction_request.rb +218 -0
- data/lib/mux_ruby/models/create_simulcast_target_request.rb +1 -1
- data/lib/mux_ruby/models/create_track_request.rb +1 -1
- data/lib/mux_ruby/models/get_live_stream_playback_id_response.rb +218 -0
- data/lib/mux_ruby/models/input_settings.rb +1 -1
- data/lib/mux_ruby/models/input_settings_overlay_settings.rb +1 -1
- data/lib/mux_ruby/models/live_stream.rb +38 -4
- data/lib/mux_ruby/models/live_stream_embedded_subtitle_settings.rb +287 -0
- data/lib/mux_ruby/models/playback_restriction.rb +248 -0
- data/lib/mux_ruby/models/playback_restriction_response.rb +209 -0
- data/lib/mux_ruby/models/referrer_domain_restriction.rb +234 -0
- data/lib/mux_ruby/models/simulcast_target.rb +1 -1
- data/lib/mux_ruby/models/track.rb +1 -13
- data/lib/mux_ruby/models/update_asset_request.rb +219 -0
- data/lib/mux_ruby/models/update_live_stream_embedded_subtitles_request.rb +221 -0
- data/lib/mux_ruby/models/update_live_stream_request.rb +297 -0
- data/lib/mux_ruby/models/update_referrer_domain_restriction_request.rb +209 -0
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +11 -0
- data/spec/api/playback_restrictions_api_spec.rb +97 -0
- data/spec/models/create_playback_restriction_request_spec.rb +34 -0
- data/spec/models/get_live_stream_playback_id_response_spec.rb +34 -0
- data/spec/models/live_stream_embedded_subtitle_settings_spec.rb +56 -0
- data/spec/models/playback_restriction_response_spec.rb +28 -0
- data/spec/models/playback_restriction_spec.rb +52 -0
- data/spec/models/referrer_domain_restriction_spec.rb +40 -0
- data/spec/models/update_asset_request_spec.rb +34 -0
- data/spec/models/update_live_stream_embedded_subtitles_request_spec.rb +34 -0
- data/spec/models/update_live_stream_request_spec.rb +50 -0
- data/spec/models/update_referrer_domain_restriction_request_spec.rb +28 -0
- metadata +137 -93
@@ -0,0 +1,345 @@
|
|
1
|
+
=begin
|
2
|
+
#Mux API
|
3
|
+
|
4
|
+
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v1
|
7
|
+
Contact: devex@mux.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.0.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module MuxRuby
|
16
|
+
class PlaybackRestrictionsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Create a Playback Restriction
|
23
|
+
# Create a new Playback Restriction.
|
24
|
+
# @param create_playback_restriction_request [CreatePlaybackRestrictionRequest]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [PlaybackRestriction]
|
27
|
+
def create_playback_restriction(create_playback_restriction_request, opts = {})
|
28
|
+
data, _status_code, _headers = create_playback_restriction_with_http_info(create_playback_restriction_request, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Create a Playback Restriction
|
33
|
+
# Create a new Playback Restriction.
|
34
|
+
# @param create_playback_restriction_request [CreatePlaybackRestrictionRequest]
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(PlaybackRestriction, Integer, Hash)>] PlaybackRestriction data, response status code and response headers
|
37
|
+
def create_playback_restriction_with_http_info(create_playback_restriction_request, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.create_playback_restriction ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'create_playback_restriction_request' is set
|
42
|
+
if @api_client.config.client_side_validation && create_playback_restriction_request.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'create_playback_restriction_request' when calling PlaybackRestrictionsApi.create_playback_restriction"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/video/v1/playback-restrictions'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
# HTTP header 'Content-Type'
|
56
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
57
|
+
|
58
|
+
# form parameters
|
59
|
+
form_params = opts[:form_params] || {}
|
60
|
+
|
61
|
+
# http body (model)
|
62
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_playback_restriction_request)
|
63
|
+
|
64
|
+
# return_type
|
65
|
+
return_type = opts[:debug_return_type] || 'PlaybackRestriction'
|
66
|
+
|
67
|
+
# auth_names
|
68
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
69
|
+
|
70
|
+
new_options = opts.merge(
|
71
|
+
:operation => :"PlaybackRestrictionsApi.create_playback_restriction",
|
72
|
+
:header_params => header_params,
|
73
|
+
:query_params => query_params,
|
74
|
+
:form_params => form_params,
|
75
|
+
:body => post_body,
|
76
|
+
:auth_names => auth_names,
|
77
|
+
:return_type => return_type
|
78
|
+
)
|
79
|
+
|
80
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
81
|
+
if @api_client.config.debugging
|
82
|
+
@api_client.config.logger.debug "API called: PlaybackRestrictionsApi#create_playback_restriction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
83
|
+
end
|
84
|
+
return data, status_code, headers
|
85
|
+
end
|
86
|
+
|
87
|
+
# Delete a Playback Restriction
|
88
|
+
# Deletes a single Playback Restriction.
|
89
|
+
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
90
|
+
# @param [Hash] opts the optional parameters
|
91
|
+
# @return [nil]
|
92
|
+
def delete_playback_restriction(playback_restriction_id, opts = {})
|
93
|
+
delete_playback_restriction_with_http_info(playback_restriction_id, opts)
|
94
|
+
nil
|
95
|
+
end
|
96
|
+
|
97
|
+
# Delete a Playback Restriction
|
98
|
+
# Deletes a single Playback Restriction.
|
99
|
+
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
100
|
+
# @param [Hash] opts the optional parameters
|
101
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
102
|
+
def delete_playback_restriction_with_http_info(playback_restriction_id, opts = {})
|
103
|
+
if @api_client.config.debugging
|
104
|
+
@api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.delete_playback_restriction ...'
|
105
|
+
end
|
106
|
+
# verify the required parameter 'playback_restriction_id' is set
|
107
|
+
if @api_client.config.client_side_validation && playback_restriction_id.nil?
|
108
|
+
fail ArgumentError, "Missing the required parameter 'playback_restriction_id' when calling PlaybackRestrictionsApi.delete_playback_restriction"
|
109
|
+
end
|
110
|
+
# resource path
|
111
|
+
local_var_path = '/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}'.sub('{' + 'PLAYBACK_RESTRICTION_ID' + '}', CGI.escape(playback_restriction_id.to_s))
|
112
|
+
|
113
|
+
# query parameters
|
114
|
+
query_params = opts[:query_params] || {}
|
115
|
+
|
116
|
+
# header parameters
|
117
|
+
header_params = opts[:header_params] || {}
|
118
|
+
|
119
|
+
# form parameters
|
120
|
+
form_params = opts[:form_params] || {}
|
121
|
+
|
122
|
+
# http body (model)
|
123
|
+
post_body = opts[:debug_body]
|
124
|
+
|
125
|
+
# return_type
|
126
|
+
return_type = opts[:debug_return_type]
|
127
|
+
|
128
|
+
# auth_names
|
129
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
130
|
+
|
131
|
+
new_options = opts.merge(
|
132
|
+
:operation => :"PlaybackRestrictionsApi.delete_playback_restriction",
|
133
|
+
:header_params => header_params,
|
134
|
+
:query_params => query_params,
|
135
|
+
:form_params => form_params,
|
136
|
+
:body => post_body,
|
137
|
+
:auth_names => auth_names,
|
138
|
+
:return_type => return_type
|
139
|
+
)
|
140
|
+
|
141
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
142
|
+
if @api_client.config.debugging
|
143
|
+
@api_client.config.logger.debug "API called: PlaybackRestrictionsApi#delete_playback_restriction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
144
|
+
end
|
145
|
+
return data, status_code, headers
|
146
|
+
end
|
147
|
+
|
148
|
+
# Retrieve a Playback Restriction
|
149
|
+
# Retrieves a Playback Restriction associated with the unique identifier.
|
150
|
+
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
151
|
+
# @param [Hash] opts the optional parameters
|
152
|
+
# @return [PlaybackRestriction]
|
153
|
+
def get_playback_restriction(playback_restriction_id, opts = {})
|
154
|
+
data, _status_code, _headers = get_playback_restriction_with_http_info(playback_restriction_id, opts)
|
155
|
+
data
|
156
|
+
end
|
157
|
+
|
158
|
+
# Retrieve a Playback Restriction
|
159
|
+
# Retrieves a Playback Restriction associated with the unique identifier.
|
160
|
+
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
161
|
+
# @param [Hash] opts the optional parameters
|
162
|
+
# @return [Array<(PlaybackRestriction, Integer, Hash)>] PlaybackRestriction data, response status code and response headers
|
163
|
+
def get_playback_restriction_with_http_info(playback_restriction_id, opts = {})
|
164
|
+
if @api_client.config.debugging
|
165
|
+
@api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.get_playback_restriction ...'
|
166
|
+
end
|
167
|
+
# verify the required parameter 'playback_restriction_id' is set
|
168
|
+
if @api_client.config.client_side_validation && playback_restriction_id.nil?
|
169
|
+
fail ArgumentError, "Missing the required parameter 'playback_restriction_id' when calling PlaybackRestrictionsApi.get_playback_restriction"
|
170
|
+
end
|
171
|
+
# resource path
|
172
|
+
local_var_path = '/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}'.sub('{' + 'PLAYBACK_RESTRICTION_ID' + '}', CGI.escape(playback_restriction_id.to_s))
|
173
|
+
|
174
|
+
# query parameters
|
175
|
+
query_params = opts[:query_params] || {}
|
176
|
+
|
177
|
+
# header parameters
|
178
|
+
header_params = opts[:header_params] || {}
|
179
|
+
# HTTP header 'Accept' (if needed)
|
180
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
181
|
+
|
182
|
+
# form parameters
|
183
|
+
form_params = opts[:form_params] || {}
|
184
|
+
|
185
|
+
# http body (model)
|
186
|
+
post_body = opts[:debug_body]
|
187
|
+
|
188
|
+
# return_type
|
189
|
+
return_type = opts[:debug_return_type] || 'PlaybackRestriction'
|
190
|
+
|
191
|
+
# auth_names
|
192
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
193
|
+
|
194
|
+
new_options = opts.merge(
|
195
|
+
:operation => :"PlaybackRestrictionsApi.get_playback_restriction",
|
196
|
+
:header_params => header_params,
|
197
|
+
:query_params => query_params,
|
198
|
+
:form_params => form_params,
|
199
|
+
:body => post_body,
|
200
|
+
:auth_names => auth_names,
|
201
|
+
:return_type => return_type
|
202
|
+
)
|
203
|
+
|
204
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
205
|
+
if @api_client.config.debugging
|
206
|
+
@api_client.config.logger.debug "API called: PlaybackRestrictionsApi#get_playback_restriction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
207
|
+
end
|
208
|
+
return data, status_code, headers
|
209
|
+
end
|
210
|
+
|
211
|
+
# List Playback Restrictions
|
212
|
+
# Returns a list of all Playback Restrictions.
|
213
|
+
# @param [Hash] opts the optional parameters
|
214
|
+
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
215
|
+
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
216
|
+
# @return [Array<PlaybackRestriction>]
|
217
|
+
def list_playback_restrictions(opts = {})
|
218
|
+
data, _status_code, _headers = list_playback_restrictions_with_http_info(opts)
|
219
|
+
data
|
220
|
+
end
|
221
|
+
|
222
|
+
# List Playback Restrictions
|
223
|
+
# Returns a list of all Playback Restrictions.
|
224
|
+
# @param [Hash] opts the optional parameters
|
225
|
+
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|
226
|
+
# @option opts [Integer] :limit Number of items to include in the response
|
227
|
+
# @return [Array<(Array<PlaybackRestriction>, Integer, Hash)>] Array<PlaybackRestriction> data, response status code and response headers
|
228
|
+
def list_playback_restrictions_with_http_info(opts = {})
|
229
|
+
if @api_client.config.debugging
|
230
|
+
@api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.list_playback_restrictions ...'
|
231
|
+
end
|
232
|
+
# resource path
|
233
|
+
local_var_path = '/video/v1/playback-restrictions'
|
234
|
+
|
235
|
+
# query parameters
|
236
|
+
query_params = opts[:query_params] || {}
|
237
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
238
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
239
|
+
|
240
|
+
# header parameters
|
241
|
+
header_params = opts[:header_params] || {}
|
242
|
+
# HTTP header 'Accept' (if needed)
|
243
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
244
|
+
|
245
|
+
# form parameters
|
246
|
+
form_params = opts[:form_params] || {}
|
247
|
+
|
248
|
+
# http body (model)
|
249
|
+
post_body = opts[:debug_body]
|
250
|
+
|
251
|
+
# return_type
|
252
|
+
return_type = opts[:debug_return_type] || 'Array<PlaybackRestriction>'
|
253
|
+
|
254
|
+
# auth_names
|
255
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
256
|
+
|
257
|
+
new_options = opts.merge(
|
258
|
+
:operation => :"PlaybackRestrictionsApi.list_playback_restrictions",
|
259
|
+
:header_params => header_params,
|
260
|
+
:query_params => query_params,
|
261
|
+
:form_params => form_params,
|
262
|
+
:body => post_body,
|
263
|
+
:auth_names => auth_names,
|
264
|
+
:return_type => return_type
|
265
|
+
)
|
266
|
+
|
267
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
268
|
+
if @api_client.config.debugging
|
269
|
+
@api_client.config.logger.debug "API called: PlaybackRestrictionsApi#list_playback_restrictions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
270
|
+
end
|
271
|
+
return data, status_code, headers
|
272
|
+
end
|
273
|
+
|
274
|
+
# Update the Referrer Playback Restriction
|
275
|
+
# Allows you to modify the list of domians or change how Mux validates playback requests without the `Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.
|
276
|
+
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
277
|
+
# @param body [ReferrerDomainRestriction]
|
278
|
+
# @param [Hash] opts the optional parameters
|
279
|
+
# @return [PlaybackRestriction]
|
280
|
+
def update_referrer_domain_restriction(playback_restriction_id, body, opts = {})
|
281
|
+
data, _status_code, _headers = update_referrer_domain_restriction_with_http_info(playback_restriction_id, body, opts)
|
282
|
+
data
|
283
|
+
end
|
284
|
+
|
285
|
+
# Update the Referrer Playback Restriction
|
286
|
+
# Allows you to modify the list of domians or change how Mux validates playback requests without the `Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.
|
287
|
+
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
288
|
+
# @param body [ReferrerDomainRestriction]
|
289
|
+
# @param [Hash] opts the optional parameters
|
290
|
+
# @return [Array<(PlaybackRestriction, Integer, Hash)>] PlaybackRestriction data, response status code and response headers
|
291
|
+
def update_referrer_domain_restriction_with_http_info(playback_restriction_id, body, opts = {})
|
292
|
+
if @api_client.config.debugging
|
293
|
+
@api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.update_referrer_domain_restriction ...'
|
294
|
+
end
|
295
|
+
# verify the required parameter 'playback_restriction_id' is set
|
296
|
+
if @api_client.config.client_side_validation && playback_restriction_id.nil?
|
297
|
+
fail ArgumentError, "Missing the required parameter 'playback_restriction_id' when calling PlaybackRestrictionsApi.update_referrer_domain_restriction"
|
298
|
+
end
|
299
|
+
# verify the required parameter 'body' is set
|
300
|
+
if @api_client.config.client_side_validation && body.nil?
|
301
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling PlaybackRestrictionsApi.update_referrer_domain_restriction"
|
302
|
+
end
|
303
|
+
# resource path
|
304
|
+
local_var_path = '/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer'.sub('{' + 'PLAYBACK_RESTRICTION_ID' + '}', CGI.escape(playback_restriction_id.to_s))
|
305
|
+
|
306
|
+
# query parameters
|
307
|
+
query_params = opts[:query_params] || {}
|
308
|
+
|
309
|
+
# header parameters
|
310
|
+
header_params = opts[:header_params] || {}
|
311
|
+
# HTTP header 'Accept' (if needed)
|
312
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
313
|
+
# HTTP header 'Content-Type'
|
314
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
315
|
+
|
316
|
+
# form parameters
|
317
|
+
form_params = opts[:form_params] || {}
|
318
|
+
|
319
|
+
# http body (model)
|
320
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
321
|
+
|
322
|
+
# return_type
|
323
|
+
return_type = opts[:debug_return_type] || 'PlaybackRestriction'
|
324
|
+
|
325
|
+
# auth_names
|
326
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
327
|
+
|
328
|
+
new_options = opts.merge(
|
329
|
+
:operation => :"PlaybackRestrictionsApi.update_referrer_domain_restriction",
|
330
|
+
:header_params => header_params,
|
331
|
+
:query_params => query_params,
|
332
|
+
:form_params => form_params,
|
333
|
+
:body => post_body,
|
334
|
+
:auth_names => auth_names,
|
335
|
+
:return_type => return_type
|
336
|
+
)
|
337
|
+
|
338
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
339
|
+
if @api_client.config.debugging
|
340
|
+
@api_client.config.logger.debug "API called: PlaybackRestrictionsApi#update_referrer_domain_restriction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
341
|
+
end
|
342
|
+
return data, status_code, headers
|
343
|
+
end
|
344
|
+
end
|
345
|
+
end
|
@@ -25,7 +25,7 @@ module MuxRuby
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @option opts [String] :dimension Dimension the specified value belongs to
|
27
27
|
# @option opts [Float] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
28
|
-
# @option opts [Array<String>] :filters
|
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
29
|
# @option opts [String] :order_by Value to order the results by
|
30
30
|
# @option opts [String] :order_direction Sort order.
|
31
31
|
# @return [GetRealTimeBreakdownResponse]
|
@@ -40,7 +40,7 @@ module MuxRuby
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
41
41
|
# @option opts [String] :dimension Dimension the specified value belongs to
|
42
42
|
# @option opts [Float] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
43
|
-
# @option opts [Array<String>] :filters
|
43
|
+
# @option opts [Array<String>] :filters Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
44
44
|
# @option opts [String] :order_by Value to order the results by
|
45
45
|
# @option opts [String] :order_direction Sort order.
|
46
46
|
# @return [Array<(GetRealTimeBreakdownResponse, Integer, Hash)>] GetRealTimeBreakdownResponse data, response status code and response headers
|
@@ -118,7 +118,7 @@ module MuxRuby
|
|
118
118
|
# Gets histogram timeseries information for a specific metric.
|
119
119
|
# @param realtime_histogram_metric_id [String] ID of the Realtime Histogram Metric
|
120
120
|
# @param [Hash] opts the optional parameters
|
121
|
-
# @option opts [Array<String>] :filters
|
121
|
+
# @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`
|
122
122
|
# @return [GetRealTimeHistogramTimeseriesResponse]
|
123
123
|
def get_realtime_histogram_timeseries(realtime_histogram_metric_id, opts = {})
|
124
124
|
data, _status_code, _headers = get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts)
|
@@ -129,7 +129,7 @@ module MuxRuby
|
|
129
129
|
# Gets histogram timeseries information for a specific metric.
|
130
130
|
# @param realtime_histogram_metric_id [String] ID of the Realtime Histogram Metric
|
131
131
|
# @param [Hash] opts the optional parameters
|
132
|
-
# @option opts [Array<String>] :filters
|
132
|
+
# @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`
|
133
133
|
# @return [Array<(GetRealTimeHistogramTimeseriesResponse, Integer, Hash)>] GetRealTimeHistogramTimeseriesResponse data, response status code and response headers
|
134
134
|
def get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts = {})
|
135
135
|
if @api_client.config.debugging
|
@@ -189,7 +189,7 @@ module MuxRuby
|
|
189
189
|
# Gets Time series information for a specific metric along with the number of concurrent viewers.
|
190
190
|
# @param realtime_metric_id [String] ID of the Realtime Metric
|
191
191
|
# @param [Hash] opts the optional parameters
|
192
|
-
# @option opts [Array<String>] :filters
|
192
|
+
# @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`
|
193
193
|
# @return [GetRealTimeTimeseriesResponse]
|
194
194
|
def get_realtime_timeseries(realtime_metric_id, opts = {})
|
195
195
|
data, _status_code, _headers = get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
|
@@ -200,7 +200,7 @@ module MuxRuby
|
|
200
200
|
# Gets Time series information for a specific metric along with the number of concurrent viewers.
|
201
201
|
# @param realtime_metric_id [String] ID of the Realtime Metric
|
202
202
|
# @param [Hash] opts the optional parameters
|
203
|
-
# @option opts [Array<String>] :filters
|
203
|
+
# @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`
|
204
204
|
# @return [Array<(GetRealTimeTimeseriesResponse, Integer, Hash)>] GetRealTimeTimeseriesResponse data, response status code and response headers
|
205
205
|
def get_realtime_timeseries_with_http_info(realtime_metric_id, opts = {})
|
206
206
|
if @api_client.config.debugging
|
@@ -90,8 +90,8 @@ module MuxRuby
|
|
90
90
|
# @option opts [String] :viewer_id Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux.
|
91
91
|
# @option opts [Integer] :error_id 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.
|
92
92
|
# @option opts [String] :order_direction Sort order.
|
93
|
-
# @option opts [Array<String>] :filters
|
94
|
-
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
93
|
+
# @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`
|
94
|
+
# @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`
|
95
95
|
# @return [ListVideoViewsResponse]
|
96
96
|
def list_video_views(opts = {})
|
97
97
|
data, _status_code, _headers = list_video_views_with_http_info(opts)
|
@@ -106,8 +106,8 @@ module MuxRuby
|
|
106
106
|
# @option opts [String] :viewer_id Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux.
|
107
107
|
# @option opts [Integer] :error_id 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.
|
108
108
|
# @option opts [String] :order_direction Sort order.
|
109
|
-
# @option opts [Array<String>] :filters
|
110
|
-
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
|
109
|
+
# @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`
|
110
|
+
# @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`
|
111
111
|
# @return [Array<(ListVideoViewsResponse, Integer, Hash)>] ListVideoViewsResponse data, response status code and response headers
|
112
112
|
def list_video_views_with_http_info(opts = {})
|
113
113
|
if @api_client.config.debugging
|
@@ -52,7 +52,7 @@ module MuxRuby
|
|
52
52
|
# Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state.
|
53
53
|
attr_accessor :is_live
|
54
54
|
|
55
|
-
# Arbitrary metadata set for the asset. Max 255 characters.
|
55
|
+
# Arbitrary user-supplied metadata set for the asset. Max 255 characters.
|
56
56
|
attr_accessor :passthrough
|
57
57
|
|
58
58
|
# Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream.
|
@@ -31,6 +31,9 @@ module MuxRuby
|
|
31
31
|
# The video resolution of the input file. Video resolution higher than 2048 pixels on any one dimension (height or width) is considered non-standard, The resolution value is presented as `width` x `height` in pixels.
|
32
32
|
attr_accessor :video_resolution
|
33
33
|
|
34
|
+
# The video bitrate of the input file is `high`. This parameter is present when the average bitrate of any key frame interval (also known as Group of Pictures or GOP) is higher than what's considered standard which typically is 16 Mbps.
|
35
|
+
attr_accessor :video_bitrate
|
36
|
+
|
34
37
|
# The video pixel aspect ratio of the input file.
|
35
38
|
attr_accessor :pixel_aspect_ratio
|
36
39
|
|
@@ -73,6 +76,7 @@ module MuxRuby
|
|
73
76
|
:'video_gop_size' => :'video_gop_size',
|
74
77
|
:'video_frame_rate' => :'video_frame_rate',
|
75
78
|
:'video_resolution' => :'video_resolution',
|
79
|
+
:'video_bitrate' => :'video_bitrate',
|
76
80
|
:'pixel_aspect_ratio' => :'pixel_aspect_ratio',
|
77
81
|
:'video_edit_list' => :'video_edit_list',
|
78
82
|
:'audio_edit_list' => :'audio_edit_list',
|
@@ -93,6 +97,7 @@ module MuxRuby
|
|
93
97
|
:'video_gop_size' => :'String',
|
94
98
|
:'video_frame_rate' => :'String',
|
95
99
|
:'video_resolution' => :'String',
|
100
|
+
:'video_bitrate' => :'String',
|
96
101
|
:'pixel_aspect_ratio' => :'String',
|
97
102
|
:'video_edit_list' => :'String',
|
98
103
|
:'audio_edit_list' => :'String',
|
@@ -141,6 +146,10 @@ module MuxRuby
|
|
141
146
|
self.video_resolution = attributes[:'video_resolution']
|
142
147
|
end
|
143
148
|
|
149
|
+
if attributes.key?(:'video_bitrate')
|
150
|
+
self.video_bitrate = attributes[:'video_bitrate']
|
151
|
+
end
|
152
|
+
|
144
153
|
if attributes.key?(:'pixel_aspect_ratio')
|
145
154
|
self.pixel_aspect_ratio = attributes[:'pixel_aspect_ratio']
|
146
155
|
end
|
@@ -170,6 +179,8 @@ module MuxRuby
|
|
170
179
|
def valid?
|
171
180
|
video_gop_size_validator = EnumAttributeValidator.new('String', ["high"])
|
172
181
|
return false unless video_gop_size_validator.valid?(@video_gop_size)
|
182
|
+
video_bitrate_validator = EnumAttributeValidator.new('String', ["high"])
|
183
|
+
return false unless video_bitrate_validator.valid?(@video_bitrate)
|
173
184
|
video_edit_list_validator = EnumAttributeValidator.new('String', ["non-standard"])
|
174
185
|
return false unless video_edit_list_validator.valid?(@video_edit_list)
|
175
186
|
audio_edit_list_validator = EnumAttributeValidator.new('String', ["non-standard"])
|
@@ -189,6 +200,16 @@ module MuxRuby
|
|
189
200
|
@video_gop_size = video_gop_size
|
190
201
|
end
|
191
202
|
|
203
|
+
# Custom attribute writer method checking allowed values (enum).
|
204
|
+
# @param [Object] video_bitrate Object to be assigned
|
205
|
+
def video_bitrate=(video_bitrate)
|
206
|
+
validator = EnumAttributeValidator.new('String', ["high"])
|
207
|
+
unless validator.valid?(video_bitrate)
|
208
|
+
fail ArgumentError, "invalid value for \"video_bitrate\", must be one of #{validator.allowable_values}."
|
209
|
+
end
|
210
|
+
@video_bitrate = video_bitrate
|
211
|
+
end
|
212
|
+
|
192
213
|
# Custom attribute writer method checking allowed values (enum).
|
193
214
|
# @param [Object] video_edit_list Object to be assigned
|
194
215
|
def video_edit_list=(video_edit_list)
|
@@ -229,6 +250,7 @@ module MuxRuby
|
|
229
250
|
video_gop_size == o.video_gop_size &&
|
230
251
|
video_frame_rate == o.video_frame_rate &&
|
231
252
|
video_resolution == o.video_resolution &&
|
253
|
+
video_bitrate == o.video_bitrate &&
|
232
254
|
pixel_aspect_ratio == o.pixel_aspect_ratio &&
|
233
255
|
video_edit_list == o.video_edit_list &&
|
234
256
|
audio_edit_list == o.audio_edit_list &&
|
@@ -244,7 +266,7 @@ module MuxRuby
|
|
244
266
|
# Calculates hash code according to all attributes.
|
245
267
|
# @return [Integer] Hash code
|
246
268
|
def hash
|
247
|
-
[video_codec, audio_codec, video_gop_size, video_frame_rate, video_resolution, pixel_aspect_ratio, video_edit_list, audio_edit_list, unexpected_media_file_parameters].hash
|
269
|
+
[video_codec, audio_codec, video_gop_size, video_frame_rate, video_resolution, video_bitrate, pixel_aspect_ratio, video_edit_list, audio_edit_list, unexpected_media_file_parameters].hash
|
248
270
|
end
|
249
271
|
|
250
272
|
# Builds the object from hash
|
@@ -23,7 +23,7 @@ module MuxRuby
|
|
23
23
|
|
24
24
|
attr_accessor :per_title_encode
|
25
25
|
|
26
|
-
# Arbitrary 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**.
|
26
|
+
# 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**.
|
27
27
|
attr_accessor :passthrough
|
28
28
|
|
29
29
|
# Specify what level (if any) of support for mp4 playback. 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](/guides/video/download-your-videos) for more information.
|