Class: BombBomb::VideosApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bombbomb/api/videos_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VideosApi

Returns a new instance of VideosApi.



30
31
32
 
# File 'lib/bombbomb/api/videos_api.rb', line 30

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/bombbomb/api/videos_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#get_video_encoding_status(video_id, opts = {}) ⇒ VideoEncodingStatusResponse

Video Encoding Status Get information about the current state of encoding for a given video id.

Parameters:

  • video_id —

    The video's id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/bombbomb/api/videos_api.rb', line 39

def get_video_encoding_status(video_id, opts = {})
  data, _status_code, _headers = get_video_encoding_status_with_http_info(video_id, opts)
  return data
end

#get_video_encoding_status_with_http_info(video_id, opts = {}) ⇒ Array<(VideoEncodingStatusResponse, Fixnum, Hash)>

Video Encoding Status Get information about the current state of encoding for a given video id.

Parameters:

  • video_id —

    The video&#39;s id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
 
# File 'lib/bombbomb/api/videos_api.rb', line 49

def get_video_encoding_status_with_http_info(video_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VideosApi.get_video_encoding_status ..."
  end
  # verify the required parameter 'video_id' is set
  fail ArgumentError, "Missing the required parameter 'video_id' when calling VideosApi.get_video_encoding_status" if video_id.nil?
  # resource path
  local_var_path = "/videos/{videoId}/status".sub('{format}','json').sub('{' + 'videoId' + '}', video_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VideoEncodingStatusResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideosApi#get_video_encoding_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_video_recorder(opts = {}) ⇒ VideoRecorderMethodResponse

Get Live Video Recorder HTML Returns an object with a number of properties to help you put a video recorder on your site. This is to be used in conjunction with the VideoRecordedLive call one the user has confirmed in your UI that the video is how they want it.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The width of the recorder to present.

  • :video_id (String) —

    The id of the video to record

Returns:



97
98
99
100
 
# File 'lib/bombbomb/api/videos_api.rb', line 97

def get_video_recorder(opts = {})
  data, _status_code, _headers = get_video_recorder_with_http_info(opts)
  return data
end

#get_video_recorder_with_http_info(opts = {}) ⇒ Array<(VideoRecorderMethodResponse, Fixnum, Hash)>

Get Live Video Recorder HTML Returns an object with a number of properties to help you put a video recorder on your site. This is to be used in conjunction with the VideoRecordedLive call one the user has confirmed in your UI that the video is how they want it.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :width (Integer) —

    The width of the recorder to present.

  • :video_id (String) —

    The id of the video to record

Returns:



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
 
# File 'lib/bombbomb/api/videos_api.rb', line 108

def get_video_recorder_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VideosApi.get_video_recorder ..."
  end
  # resource path
  local_var_path = "/videos/live/getRecorder".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'videoId'] = opts[:'video_id'] if !opts[:'video_id'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VideoRecorderMethodResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideosApi#get_video_recorder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mark_live_recording_complete(video_id, filename, title, opts = {}) ⇒ VideoPublicRepresentation

Completes a live recording Used in conjunction with the live recorder method to mark a video recording as complete.

Parameters:

  • video_id —

    The id of the video to mark as done.

  • filename —

    The filename that was chosen as the final video.

  • title —

    The title to give the video

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



157
158
159
160
 
# File 'lib/bombbomb/api/videos_api.rb', line 157

def mark_live_recording_complete(video_id, filename, title, opts = {})
  data, _status_code, _headers = mark_live_recording_complete_with_http_info(video_id, filename, title, opts)
  return data
end

#mark_live_recording_complete_with_http_info(video_id, filename, title, opts = {}) ⇒ Array<(VideoPublicRepresentation, Fixnum, Hash)>

Completes a live recording Used in conjunction with the live recorder method to mark a video recording as complete.

Parameters:

  • video_id —

    The id of the video to mark as done.

  • filename —

    The filename that was chosen as the final video.

  • title —

    The title to give the video

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VideoPublicRepresentation, Fixnum, Hash)>) —

    VideoPublicRepresentation data, response status code and response headers



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
 
# File 'lib/bombbomb/api/videos_api.rb', line 169

def mark_live_recording_complete_with_http_info(video_id, filename, title, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VideosApi.mark_live_recording_complete ..."
  end
  # verify the required parameter 'video_id' is set
  fail ArgumentError, "Missing the required parameter 'video_id' when calling VideosApi.mark_live_recording_complete" if video_id.nil?
  # verify the required parameter 'filename' is set
  fail ArgumentError, "Missing the required parameter 'filename' when calling VideosApi.mark_live_recording_complete" if filename.nil?
  # verify the required parameter 'title' is set
  fail ArgumentError, "Missing the required parameter 'title' when calling VideosApi.mark_live_recording_complete" if title.nil?
  # resource path
  local_var_path = "/videos/live/markComplete".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  form_params["videoId"] = video_id
  form_params["filename"] = filename
  form_params["title"] = title

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VideoPublicRepresentation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideosApi#mark_live_recording_complete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sign_upload(policy, opts = {}) ⇒ String

Generate Signed Url Generates a signed url to be used for video uploads.

Parameters:

  • policy —

    The policy to sign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :v4 (BOOLEAN) —

    Whether to do v4 signing

Returns:



224
225
226
227
 
# File 'lib/bombbomb/api/videos_api.rb', line 224

def sign_upload(policy, opts = {})
  data, _status_code, _headers = sign_upload_with_http_info(policy, opts)
  return data
end

#sign_upload_with_http_info(policy, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Generate Signed Url Generates a signed url to be used for video uploads.

Parameters:

  • policy —

    The policy to sign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :v4 (BOOLEAN) —

    Whether to do v4 signing

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
273
274
275
276
 
# File 'lib/bombbomb/api/videos_api.rb', line 235

def sign_upload_with_http_info(policy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VideosApi.sign_upload ..."
  end
  # verify the required parameter 'policy' is set
  fail ArgumentError, "Missing the required parameter 'policy' when calling VideosApi.sign_upload" if policy.nil?
  # resource path
  local_var_path = "/video/signedUpload".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  form_params["v4"] = opts[:'v4'] if !opts[:'v4'].nil?

  # http body (model)
  post_body = @api_client.object_to_http_body(policy)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideosApi#sign_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end