Class: MuxRuby::WebInputsApi
- Inherits:
-
Object
- Object
- MuxRuby::WebInputsApi
- Defined in:
- lib/mux_ruby/api/web_inputs_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_web_input(create_web_input_request, opts = {}) ⇒ WebInputResponse
Create a new Web Input Create a new Web Input.
-
#create_web_input_with_http_info(create_web_input_request, opts = {}) ⇒ Array<(WebInputResponse, Integer, Hash)>
Create a new Web Input Create a new Web Input.
-
#delete_web_input(web_input_id, opts = {}) ⇒ nil
Delete a Web Input Deletes a Web Input and all its data.
-
#delete_web_input_with_http_info(web_input_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a Web Input Deletes a Web Input and all its data.
-
#get_web_input(web_input_id, opts = {}) ⇒ WebInputResponse
Retrieve a Web Input Retrieve a single Web Input’s info.
-
#get_web_input_with_http_info(web_input_id, opts = {}) ⇒ Array<(WebInputResponse, Integer, Hash)>
Retrieve a Web Input Retrieve a single Web Input's info.
-
#initialize(api_client = ApiClient.default) ⇒ WebInputsApi
constructor
A new instance of WebInputsApi.
-
#launch_web_input(web_input_id, opts = {}) ⇒ LaunchWebInputResponse
Launch a Web Input Launches the browsers instance, loads the URL specified, and then starts streaming to the specified Live Stream.
-
#launch_web_input_with_http_info(web_input_id, opts = {}) ⇒ Array<(LaunchWebInputResponse, Integer, Hash)>
Launch a Web Input Launches the browsers instance, loads the URL specified, and then starts streaming to the specified Live Stream.
-
#list_web_inputs(opts = {}) ⇒ ListWebInputsResponse
List Web Inputs List Web Inputs.
-
#list_web_inputs_with_http_info(opts = {}) ⇒ Array<(ListWebInputsResponse, Integer, Hash)>
List Web Inputs List Web Inputs.
-
#reload_web_input(web_input_id, opts = {}) ⇒ ReloadWebInputResponse
Reload a Web Input Reloads the page that a Web Input is displaying.
-
#reload_web_input_with_http_info(web_input_id, opts = {}) ⇒ Array<(ReloadWebInputResponse, Integer, Hash)>
Reload a Web Input Reloads the page that a Web Input is displaying.
-
#shutdown_web_input(web_input_id, opts = {}) ⇒ ShutdownWebInputResponse
Shut down a Web Input Ends streaming to the specified Live Stream, and then shuts down the Web Input browser instance.
-
#shutdown_web_input_with_http_info(web_input_id, opts = {}) ⇒ Array<(ShutdownWebInputResponse, Integer, Hash)>
Shut down a Web Input Ends streaming to the specified Live Stream, and then shuts down the Web Input browser instance.
-
#update_web_input_url(web_input_id, update_web_input_url_request, opts = {}) ⇒ WebInputResponse
Update Web Input URL Changes the URL that a Web Input loads when it launches.
-
#update_web_input_url_with_http_info(web_input_id, update_web_input_url_request, opts = {}) ⇒ Array<(WebInputResponse, Integer, Hash)>
Update Web Input URL Changes the URL that a Web Input loads when it launches.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ WebInputsApi
Returns a new instance of WebInputsApi.
19 20 21 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_web_input(create_web_input_request, opts = {}) ⇒ WebInputResponse
Create a new Web Input Create a new Web Input
27 28 29 30 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 27 def create_web_input(create_web_input_request, opts = {}) data, _status_code, _headers = create_web_input_with_http_info(create_web_input_request, opts) data end |
#create_web_input_with_http_info(create_web_input_request, opts = {}) ⇒ Array<(WebInputResponse, Integer, Hash)>
Create a new Web Input Create a new Web Input
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 37 def create_web_input_with_http_info(create_web_input_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebInputsApi.create_web_input ...' end # verify the required parameter 'create_web_input_request' is set if @api_client.config.client_side_validation && create_web_input_request.nil? fail ArgumentError, "Missing the required parameter 'create_web_input_request' when calling WebInputsApi.create_web_input" end # resource path local_var_path = '/video/v1/web-inputs' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_web_input_request) # return_type return_type = opts[:debug_return_type] || 'WebInputResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] = opts.merge( :operation => :"WebInputsApi.create_web_input", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebInputsApi#create_web_input\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_web_input(web_input_id, opts = {}) ⇒ nil
Delete a Web Input Deletes a Web Input and all its data
92 93 94 95 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 92 def delete_web_input(web_input_id, opts = {}) delete_web_input_with_http_info(web_input_id, opts) nil end |
#delete_web_input_with_http_info(web_input_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a Web Input Deletes a Web Input and all its data
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 102 def delete_web_input_with_http_info(web_input_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebInputsApi.delete_web_input ...' end # verify the required parameter 'web_input_id' is set if @api_client.config.client_side_validation && web_input_id.nil? fail ArgumentError, "Missing the required parameter 'web_input_id' when calling WebInputsApi.delete_web_input" end # resource path local_var_path = '/video/v1/web-inputs/{WEB_INPUT_ID}'.sub('{' + 'WEB_INPUT_ID' + '}', CGI.escape(web_input_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] = opts.merge( :operation => :"WebInputsApi.delete_web_input", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebInputsApi#delete_web_input\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_web_input(web_input_id, opts = {}) ⇒ WebInputResponse
Retrieve a Web Input Retrieve a single Web Input’s info
153 154 155 156 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 153 def get_web_input(web_input_id, opts = {}) data, _status_code, _headers = get_web_input_with_http_info(web_input_id, opts) data end |
#get_web_input_with_http_info(web_input_id, opts = {}) ⇒ Array<(WebInputResponse, Integer, Hash)>
Retrieve a Web Input Retrieve a single Web Input's info
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 163 def get_web_input_with_http_info(web_input_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebInputsApi.get_web_input ...' end # verify the required parameter 'web_input_id' is set if @api_client.config.client_side_validation && web_input_id.nil? fail ArgumentError, "Missing the required parameter 'web_input_id' when calling WebInputsApi.get_web_input" end # resource path local_var_path = '/video/v1/web-inputs/{WEB_INPUT_ID}'.sub('{' + 'WEB_INPUT_ID' + '}', CGI.escape(web_input_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'WebInputResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] = opts.merge( :operation => :"WebInputsApi.get_web_input", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebInputsApi#get_web_input\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#launch_web_input(web_input_id, opts = {}) ⇒ LaunchWebInputResponse
Launch a Web Input Launches the browsers instance, loads the URL specified, and then starts streaming to the specified Live Stream.
216 217 218 219 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 216 def launch_web_input(web_input_id, opts = {}) data, _status_code, _headers = launch_web_input_with_http_info(web_input_id, opts) data end |
#launch_web_input_with_http_info(web_input_id, opts = {}) ⇒ Array<(LaunchWebInputResponse, Integer, Hash)>
Launch a Web Input Launches the browsers instance, loads the URL specified, and then starts streaming to the specified Live Stream.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 226 def launch_web_input_with_http_info(web_input_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebInputsApi.launch_web_input ...' end # verify the required parameter 'web_input_id' is set if @api_client.config.client_side_validation && web_input_id.nil? fail ArgumentError, "Missing the required parameter 'web_input_id' when calling WebInputsApi.launch_web_input" end # resource path local_var_path = '/video/v1/web-inputs/{WEB_INPUT_ID}/launch'.sub('{' + 'WEB_INPUT_ID' + '}', CGI.escape(web_input_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'LaunchWebInputResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] = opts.merge( :operation => :"WebInputsApi.launch_web_input", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebInputsApi#launch_web_input\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_web_inputs(opts = {}) ⇒ ListWebInputsResponse
List Web Inputs List Web Inputs
280 281 282 283 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 280 def list_web_inputs(opts = {}) data, _status_code, _headers = list_web_inputs_with_http_info(opts) data end |
#list_web_inputs_with_http_info(opts = {}) ⇒ Array<(ListWebInputsResponse, Integer, Hash)>
List Web Inputs List Web Inputs
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 291 def list_web_inputs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebInputsApi.list_web_inputs ...' end # resource path local_var_path = '/video/v1/web-inputs' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ListWebInputsResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] = opts.merge( :operation => :"WebInputsApi.list_web_inputs", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebInputsApi#list_web_inputs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#reload_web_input(web_input_id, opts = {}) ⇒ ReloadWebInputResponse
Reload a Web Input Reloads the page that a Web Input is displaying. Note: Using this when the Web Input is streaming will display the page reloading.
342 343 344 345 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 342 def reload_web_input(web_input_id, opts = {}) data, _status_code, _headers = reload_web_input_with_http_info(web_input_id, opts) data end |
#reload_web_input_with_http_info(web_input_id, opts = {}) ⇒ Array<(ReloadWebInputResponse, Integer, Hash)>
Reload a Web Input Reloads the page that a Web Input is displaying. Note: Using this when the Web Input is streaming will display the page reloading.
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 352 def reload_web_input_with_http_info(web_input_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebInputsApi.reload_web_input ...' end # verify the required parameter 'web_input_id' is set if @api_client.config.client_side_validation && web_input_id.nil? fail ArgumentError, "Missing the required parameter 'web_input_id' when calling WebInputsApi.reload_web_input" end # resource path local_var_path = '/video/v1/web-inputs/{WEB_INPUT_ID}/reload'.sub('{' + 'WEB_INPUT_ID' + '}', CGI.escape(web_input_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ReloadWebInputResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] = opts.merge( :operation => :"WebInputsApi.reload_web_input", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebInputsApi#reload_web_input\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#shutdown_web_input(web_input_id, opts = {}) ⇒ ShutdownWebInputResponse
Shut down a Web Input Ends streaming to the specified Live Stream, and then shuts down the Web Input browser instance.
405 406 407 408 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 405 def shutdown_web_input(web_input_id, opts = {}) data, _status_code, _headers = shutdown_web_input_with_http_info(web_input_id, opts) data end |
#shutdown_web_input_with_http_info(web_input_id, opts = {}) ⇒ Array<(ShutdownWebInputResponse, Integer, Hash)>
Shut down a Web Input Ends streaming to the specified Live Stream, and then shuts down the Web Input browser instance.
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 415 def shutdown_web_input_with_http_info(web_input_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebInputsApi.shutdown_web_input ...' end # verify the required parameter 'web_input_id' is set if @api_client.config.client_side_validation && web_input_id.nil? fail ArgumentError, "Missing the required parameter 'web_input_id' when calling WebInputsApi.shutdown_web_input" end # resource path local_var_path = '/video/v1/web-inputs/{WEB_INPUT_ID}/shutdown'.sub('{' + 'WEB_INPUT_ID' + '}', CGI.escape(web_input_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ShutdownWebInputResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] = opts.merge( :operation => :"WebInputsApi.shutdown_web_input", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebInputsApi#shutdown_web_input\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_web_input_url(web_input_id, update_web_input_url_request, opts = {}) ⇒ WebInputResponse
Update Web Input URL Changes the URL that a Web Input loads when it launches. Note: This can only be called when the Web Input is idle.
469 470 471 472 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 469 def update_web_input_url(web_input_id, update_web_input_url_request, opts = {}) data, _status_code, _headers = update_web_input_url_with_http_info(web_input_id, update_web_input_url_request, opts) data end |
#update_web_input_url_with_http_info(web_input_id, update_web_input_url_request, opts = {}) ⇒ Array<(WebInputResponse, Integer, Hash)>
Update Web Input URL Changes the URL that a Web Input loads when it launches. Note: This can only be called when the Web Input is idle.
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 |
# File 'lib/mux_ruby/api/web_inputs_api.rb', line 480 def update_web_input_url_with_http_info(web_input_id, update_web_input_url_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebInputsApi.update_web_input_url ...' end # verify the required parameter 'web_input_id' is set if @api_client.config.client_side_validation && web_input_id.nil? fail ArgumentError, "Missing the required parameter 'web_input_id' when calling WebInputsApi.update_web_input_url" end # verify the required parameter 'update_web_input_url_request' is set if @api_client.config.client_side_validation && update_web_input_url_request.nil? fail ArgumentError, "Missing the required parameter 'update_web_input_url_request' when calling WebInputsApi.update_web_input_url" end # resource path local_var_path = '/video/v1/web-inputs/{WEB_INPUT_ID}/url'.sub('{' + 'WEB_INPUT_ID' + '}', CGI.escape(web_input_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(update_web_input_url_request) # return_type return_type = opts[:debug_return_type] || 'WebInputResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] = opts.merge( :operation => :"WebInputsApi.update_web_input_url", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebInputsApi#update_web_input_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |