Class: FastpixApiSDK::InputVideo

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/fastpix_api_sdk/input_video.rb

Instance Method Summary collapse

Constructor Details

#initialize(sdk_config) ⇒ InputVideo

Returns a new instance of InputVideo.



21
22
23
24
 
# File 'lib/fastpix_api_sdk/input_video.rb', line 21

def initialize(sdk_config)
  @sdk_configuration = sdk_config
  
end

Instance Method Details

#create_media(request: nil, timeout_ms: nil) ⇒ Object 



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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
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
 
# File 'lib/fastpix_api_sdk/input_video.rb', line 43

def create_media(request: nil, timeout_ms: nil)
  # create_media - Create media from URL
  # This endpoint allows developers or users to create a new video or audio media in FastPix using a publicly accessible URL. FastPix will fetch the media from the provided URL, process it, and store it on the platform for use. 
  # 
  # 
  # 
  # #### Public URL requirement:
  # 
  # 
  #   The provided URL must be publicly accessible and should point to a video stored in one of the following supported formats: .m4v, .ogv, .mpeg, .mov, .3gp, .f4v, .rm, .ts, .wtv, .avi, .mp4, .wmv, .webm, .mts, .vob, .mxf, asf, m2ts 
  # 
  # 
  # 
  # #### Supported storage types:
  # 
  # The URL can originate from various cloud storage services or content delivery networks (CDNs) such as: 
  # 
  # 
  # * **Amazon S3:** URLs from Amazon's Simple Storage Service. 
  # 
  # * **Google Cloud Storage:** URLs from Google Cloud's storage solution. 
  # 
  # * **Azure Blob Storage:** URLs from Microsoft's Azure storage. 
  # 
  # * **Public CDNs:** URLs from public content delivery networks that host video files. 
  # 
  # Upon successful creation, the API returns an id that should be retained for future operations related to this media. 
  # 
  # #### How it works
  # 
  # 
  # 1. Send a POST request to the /on-demand endpoint with the media URL (typically a video or audio file) and optional media settings. 
  # 
  # 2. FastPix uploads the video from the provided URL to its storage. 
  # 
  # 3. Receive a response containing the unique id for the newly created media item. 
  # 
  # 4. Use the id in subsequent API calls, such as checking the status of the media with the **Get Media by ID** endpoint to determine when the media is ready for playback. 
  # 
  # FastPix uses webhooks to tell your application about things that happen in the background, outside of the API regular request flow. For instance, once the media file is created (but not yet processed or encoded), we'll shoot a POST message to the address you give us with the webhook event video.media.created. 
  # 
  # 
  # Once processing is done you can look for the events video.media.ready and video.media.failed to see the status of your new media file.
  # 
  # #### Use case scenario
  # 
  # 
  # * **Use case:** A developer wants to integrate a user-generated content platform where users can upload links to their videos hosted on third-party platforms like AWS or Google Cloud Storage. This endpoint is used to create media directly from those URLs. 
  # 
  # 
  # * **Detailed example:** 
  # Say you're building an online learning platform where instructors upload video URLs hosted on their private cloud servers. By providing the video URL to this endpoint, the platform processes and adds it to your media library, ready for playback. 
  # 
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = "#{base_url}/on-demand"
  headers = {}
  req_content_type, data, form = Utils.serialize_request_body(request, false, true, :request, :json)
  headers['content-type'] = req_content_type

  if form
    body = Utils.encode_form(form)
  elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
    body = URI.encode_www_form(data)
  else
    body = data
  end
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil

  timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
  timeout ||= @sdk_configuration.timeout

  connection = @sdk_configuration.client

  hook_ctx = SDKHooks::HookContext.new(
    config: @sdk_configuration,
    base_url: base_url,
    oauth2_scopes: [],
    operation_id: 'create-media',
    security_source: @sdk_configuration.security_source
  )

  error = T.let(nil, T.nilable(StandardError))
  http_response = T.let(nil, T.nilable(Faraday::Response))
  
  
  begin
    http_response = connection.post(url) do |req|
      req.body = body
      req.headers.merge!(headers)
      req.options.timeout = timeout unless timeout.nil?
      Utils.configure_request_security(req, security)

      @sdk_configuration.hooks.before_request(
        hook_ctx: SDKHooks::BeforeRequestHookContext.new(
          hook_ctx: hook_ctx
        ),
        request: req
      )
    end
  rescue StandardError => e
    error = e
  ensure
    if http_response.nil? || Utils.error_status?(http_response.status)
      http_response = @sdk_configuration.hooks.after_error(
        error: error,
        hook_ctx: SDKHooks::AfterErrorHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
    else
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
    end
    
    if http_response.nil?
      raise error if !error.nil?
      raise 'no response'
    end
  end
  
  content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
  if Utils.match_status_code(http_response.status, ['201'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Operations::CreateMediaResponseBody)
      response = Models::Operations::CreateMediaResponse.new(
        status_code: http_response.status,
        content_type: content_type,
        raw_response: http_response,
        object: obj
      )

      return response
    else
      raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['400'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::BadRequestError)
      throw obj
    else
      raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['401'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::InvalidPermissionError)
      throw obj
    else
      raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['403'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::ForbiddenError)
      throw obj
    else
      raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['422'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::ValidationErrorResponse)
      throw obj
    else
      raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['4XX'])
    raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
  elsif Utils.match_status_code(http_response.status, ['5XX'])
    raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
  else
    raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'

  end
end

#direct_upload_video_media(request: nil, timeout_ms: nil) ⇒ Object 



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
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
 
# File 'lib/fastpix_api_sdk/input_video.rb', line 262

def direct_upload_video_media(request: nil, timeout_ms: nil)
  # direct_upload_video_media - Upload media from device
  # This endpoint enables you to upload a video file directly from your local device to FastPix for processing, storage. When you invoke this API with your preferred media settings, the response returns an uploadId and a pre-signed URL, providing a streamlined experience for uploading.
  # 
  # 
  # 
  # #### How it works
  # 
  # 1. Send a POST request to the /on-demand/uploads endpoint with optional media settings.  
  # 
  # 2. The response includes an **uploadId** and a pre-signed URL for direct video file upload.
  # 
  # 3. Upload your video file to the provided **URL** by making **PUT** request. The API accepts the media file from the device and uploads it to the FastPix platform. 
  # 
  # 4. Once uploaded, the media undergoes processing and is assigned a unique ID for tracking. Retain this **uploadId** for any future operations related to this upload. 
  # 
  # 
  # 
  # 
  # After uploading, you can use the **Get Media by ID** endpoint to check the status of the uploaded media asset and see if it has transitioned to a "ready" status for playback. 
  # 
  # To notify your application about the status of this API request check for the webhooks for Upload related events.  
  # 
  # 
  # #### Use case scenario 
  # 
  # **Use case:** A social media platform allows users to upload video content directly from their phones or computers. This endpoint facilitates the upload process. For example, if you are developing a video-sharing app where users can upload short clips from their mobile devices, this endpoint enables them to select a video, upload it to the platform.
  # 
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = "#{base_url}/on-demand/uploads"
  headers = {}
  req_content_type, data, form = Utils.serialize_request_body(request, false, true, :request, :json)
  headers['content-type'] = req_content_type

  if form
    body = Utils.encode_form(form)
  elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
    body = URI.encode_www_form(data)
  else
    body = data
  end
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil

  timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
  timeout ||= @sdk_configuration.timeout

  connection = @sdk_configuration.client

  hook_ctx = SDKHooks::HookContext.new(
    config: @sdk_configuration,
    base_url: base_url,
    oauth2_scopes: [],
    operation_id: 'direct-upload-video-media',
    security_source: @sdk_configuration.security_source
  )

  error = T.let(nil, T.nilable(StandardError))
  http_response = T.let(nil, T.nilable(Faraday::Response))
  
  
  begin
    http_response = connection.post(url) do |req|
      req.body = body
      req.headers.merge!(headers)
      req.options.timeout = timeout unless timeout.nil?
      Utils.configure_request_security(req, security)

      @sdk_configuration.hooks.before_request(
        hook_ctx: SDKHooks::BeforeRequestHookContext.new(
          hook_ctx: hook_ctx
        ),
        request: req
      )
    end
  rescue StandardError => e
    error = e
  ensure
    if http_response.nil? || Utils.error_status?(http_response.status)
      http_response = @sdk_configuration.hooks.after_error(
        error: error,
        hook_ctx: SDKHooks::AfterErrorHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
    else
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
    end
    
    if http_response.nil?
      raise error if !error.nil?
      raise 'no response'
    end
  end
  
  content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
  if Utils.match_status_code(http_response.status, ['201'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Operations::DirectUploadVideoMediaResponseBody)
      response = Models::Operations::DirectUploadVideoMediaResponse.new(
        status_code: http_response.status,
        content_type: content_type,
        raw_response: http_response,
        object: obj
      )

      return response
    else
      raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['400'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::BadRequestError)
      throw obj
    else
      raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['401'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::InvalidPermissionError)
      throw obj
    else
      raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['403'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::ForbiddenError)
      throw obj
    else
      raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['422'])
    if Utils.match_content_type(content_type, 'application/json')
      http_response = @sdk_configuration.hooks.after_success(
        hook_ctx: SDKHooks::AfterSuccessHookContext.new(
          hook_ctx: hook_ctx
        ),
        response: http_response
      )
      response_data = http_response.env.response_body
      obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::ValidationErrorResponse)
      throw obj
    else
      raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
    end
  elsif Utils.match_status_code(http_response.status, ['4XX'])
    raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
  elsif Utils.match_status_code(http_response.status, ['5XX'])
    raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
  else
    raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'

  end
end

#get_url(base_url:, url_variables: nil) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/fastpix_api_sdk/input_video.rb', line 27

def get_url(base_url:, url_variables: nil)
  sd_base_url, sd_options = @sdk_configuration.get_server_details

  if base_url.nil?
    base_url = sd_base_url
  end

  if url_variables.nil?
    url_variables = sd_options
  end

  return Utils.template_url base_url, url_variables
end