Class: TelestreamCloud::Flip::Encoding

Inherits:
Object
  • Object
show all
Defined in:
lib/telestream_cloud_flip/models/encoding.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Encoding

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
259
260
261
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
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 181

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'audio_bitrate')
    self.audio_bitrate = attributes[:'audio_bitrate']
  end

  if attributes.has_key?(:'audio_channels')
    self.audio_channels = attributes[:'audio_channels']
  end

  if attributes.has_key?(:'audio_codec')
    self.audio_codec = attributes[:'audio_codec']
  end

  if attributes.has_key?(:'audio_sample_rate')
    self.audio_sample_rate = attributes[:'audio_sample_rate']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'duration')
    self.duration = attributes[:'duration']
  end

  if attributes.has_key?(:'encoding_progress')
    self.encoding_progress = attributes[:'encoding_progress']
  end

  if attributes.has_key?(:'encoding_time')
    self.encoding_time = attributes[:'encoding_time']
  end

  if attributes.has_key?(:'error_class')
    self.error_class = attributes[:'error_class']
  end

  if attributes.has_key?(:'error_message')
    self.error_message = attributes[:'error_message']
  end

  if attributes.has_key?(:'external_id')
    self.external_id = attributes[:'external_id']
  end

  if attributes.has_key?(:'extname')
    self.extname = attributes[:'extname']
  end

  if attributes.has_key?(:'file_size')
    self.file_size = attributes[:'file_size']
  end

  if attributes.has_key?(:'files')
    if (value = attributes[:'files']).is_a?(Array)
      self.files = value
    end
  end

  if attributes.has_key?(:'fps')
    self.fps = attributes[:'fps']
  end

  if attributes.has_key?(:'height')
    self.height = attributes[:'height']
  end

  if attributes.has_key?(:'width')
    self.width = attributes[:'width']
  end

  if attributes.has_key?(:'logfile_url')
    self.logfile_url = attributes[:'logfile_url']
  end

  if attributes.has_key?(:'mime_type')
    self.mime_type = attributes[:'mime_type']
  end

  if attributes.has_key?(:'parent_encoding_id')
    self.parent_encoding_id = attributes[:'parent_encoding_id']
  end

  if attributes.has_key?(:'path')
    self.path = attributes[:'path']
  end

  if attributes.has_key?(:'profile_id')
    self.profile_id = attributes[:'profile_id']
  end

  if attributes.has_key?(:'profile_name')
    self.profile_name = attributes[:'profile_name']
  end

  if attributes.has_key?(:'screenshots')
    if (value = attributes[:'screenshots']).is_a?(Array)
      self.screenshots = value
    end
  end

  if attributes.has_key?(:'started_encoding_at')
    self.started_encoding_at = attributes[:'started_encoding_at']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.has_key?(:'video_bitrate')
    self.video_bitrate = attributes[:'video_bitrate']
  end

  if attributes.has_key?(:'video_codec')
    self.video_codec = attributes[:'video_codec']
  end

  if attributes.has_key?(:'video_id')
    self.video_id = attributes[:'video_id']
  end

end

Instance Attribute Details

#audio_bitrate ⇒ Object

Audio bitrate (in bits/s).



22
23
24
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 22

def audio_bitrate
  @audio_bitrate
end

#audio_channels ⇒ Object

A number of audio channels.



25
26
27
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 25

def audio_channels
  @audio_channels
end

#audio_codec ⇒ Object

A codec that is used to encode audio streams.



28
29
30
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 28

def audio_codec
  @audio_codec
end

#audio_sample_rate ⇒ Object

A number of samples of audio carried per second.



31
32
33
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 31

def audio_sample_rate
  @audio_sample_rate
end

#created_at ⇒ Object

A date and time when the Encoding has been created.



34
35
36
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 34

def created_at
  @created_at
end

#duration ⇒ Object

Returns the value of attribute duration.



36
37
38
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 36

def duration
  @duration
end

#encoding_progress ⇒ Object

Returns the value of attribute encoding_progress.



38
39
40
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 38

def encoding_progress
  @encoding_progress
end

#encoding_time ⇒ Object

Returns the value of attribute encoding_time.



40
41
42
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 40

def encoding_time
  @encoding_time
end

#error_class ⇒ Object

A class of an error that has occurred during the encoding process. It is present only if the encoding status is equal to ‘fail`.



43
44
45
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 43

def error_class
  @error_class
end

#error_message ⇒ Object

A message that explains why the encoding process has resulted in an error. It is present only if the encoding status is equal to ‘fail`.



46
47
48
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 46

def error_message
  @error_message
end

#external_id ⇒ Object

Returns the value of attribute external_id.



48
49
50
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 48

def external_id
  @external_id
end

#extname ⇒ Object

Extension of the output file.



51
52
53
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 51

def extname
  @extname
end

#file_size ⇒ Object

A size of the output file.



54
55
56
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 54

def file_size
  @file_size
end

#files ⇒ Object

An array of output file names.



57
58
59
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 57

def files
  @files
end

#fps ⇒ Object

Number of frames per second.



60
61
62
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 60

def fps
  @fps
end

#height ⇒ Object

Height of the output video.



63
64
65
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 63

def height
  @height
end

#id ⇒ Object

A unique identifier of an Encoding.



19
20
21
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 19

def id
  @id
end

#logfile_url ⇒ Object

An URL pointing to a logfile.



69
70
71
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 69

def logfile_url
  @logfile_url
end

#mime_type ⇒ Object

A mime type of the encoded file.



72
73
74
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 72

def mime_type
  @mime_type
end

#parent_encoding_id ⇒ Object

Returns the value of attribute parent_encoding_id.



74
75
76
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 74

def parent_encoding_id
  @parent_encoding_id
end

#path ⇒ Object

Returns the value of attribute path.



76
77
78
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 76

def path
  @path
end

#profile_id ⇒ Object

An id of a related Profile.



79
80
81
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 79

def profile_id
  @profile_id
end

#profile_name ⇒ Object

A name of the used Profile.



82
83
84
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 82

def profile_name
  @profile_name
end

#screenshots ⇒ Object

Returns the value of attribute screenshots.



84
85
86
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 84

def screenshots
  @screenshots
end

#started_encoding_at ⇒ Object

A date and time when the encoding process has been started



87
88
89
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 87

def started_encoding_at
  @started_encoding_at
end

#status ⇒ Object

Determines at what stage the encoding process is at the moment.



90
91
92
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 90

def status
  @status
end

#updated_at ⇒ Object

A date and time when a Encoding has been updated last time.



93
94
95
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 93

def updated_at
  @updated_at
end

#video_bitrate ⇒ Object

video bitrate (in bits/s)



96
97
98
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 96

def video_bitrate
  @video_bitrate
end

#video_codec ⇒ Object

A codec that is used to encode video streams.



99
100
101
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 99

def video_codec
  @video_codec
end

#video_id ⇒ Object

An id of a related Video object



102
103
104
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 102

def video_id
  @video_id
end

#width ⇒ Object

Width of the output video.



66
67
68
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 66

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



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
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 106

def self.attribute_map
  {
    :'id' => :'id',
    :'audio_bitrate' => :'audio_bitrate',
    :'audio_channels' => :'audio_channels',
    :'audio_codec' => :'audio_codec',
    :'audio_sample_rate' => :'audio_sample_rate',
    :'created_at' => :'created_at',
    :'duration' => :'duration',
    :'encoding_progress' => :'encoding_progress',
    :'encoding_time' => :'encoding_time',
    :'error_class' => :'error_class',
    :'error_message' => :'error_message',
    :'external_id' => :'external_id',
    :'extname' => :'extname',
    :'file_size' => :'file_size',
    :'files' => :'files',
    :'fps' => :'fps',
    :'height' => :'height',
    :'width' => :'width',
    :'logfile_url' => :'logfile_url',
    :'mime_type' => :'mime_type',
    :'parent_encoding_id' => :'parent_encoding_id',
    :'path' => :'path',
    :'profile_id' => :'profile_id',
    :'profile_name' => :'profile_name',
    :'screenshots' => :'screenshots',
    :'started_encoding_at' => :'started_encoding_at',
    :'status' => :'status',
    :'updated_at' => :'updated_at',
    :'video_bitrate' => :'video_bitrate',
    :'video_codec' => :'video_codec',
    :'video_id' => :'video_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 143

def self.swagger_types
  {
    :'id' => :'String',
    :'audio_bitrate' => :'Integer',
    :'audio_channels' => :'Integer',
    :'audio_codec' => :'String',
    :'audio_sample_rate' => :'Integer',
    :'created_at' => :'String',
    :'duration' => :'Integer',
    :'encoding_progress' => :'Integer',
    :'encoding_time' => :'Integer',
    :'error_class' => :'String',
    :'error_message' => :'String',
    :'external_id' => :'String',
    :'extname' => :'String',
    :'file_size' => :'Integer',
    :'files' => :'Array<String>',
    :'fps' => :'Float',
    :'height' => :'Integer',
    :'width' => :'Integer',
    :'logfile_url' => :'String',
    :'mime_type' => :'String',
    :'parent_encoding_id' => :'String',
    :'path' => :'String',
    :'profile_id' => :'String',
    :'profile_name' => :'String',
    :'screenshots' => :'Array<String>',
    :'started_encoding_at' => :'String',
    :'status' => :'String',
    :'updated_at' => :'String',
    :'video_bitrate' => :'Integer',
    :'video_codec' => :'String',
    :'video_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 332

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      audio_bitrate == o.audio_bitrate &&
      audio_channels == o.audio_channels &&
      audio_codec == o.audio_codec &&
      audio_sample_rate == o.audio_sample_rate &&
      created_at == o.created_at &&
      duration == o.duration &&
      encoding_progress == o.encoding_progress &&
      encoding_time == o.encoding_time &&
      error_class == o.error_class &&
      error_message == o.error_message &&
      external_id == o.external_id &&
      extname == o.extname &&
      file_size == o.file_size &&
      files == o.files &&
      fps == o.fps &&
      height == o.height &&
      width == o.width &&
      logfile_url == o.logfile_url &&
      mime_type == o.mime_type &&
      parent_encoding_id == o.parent_encoding_id &&
      path == o.path &&
      profile_id == o.profile_id &&
      profile_name == o.profile_name &&
      screenshots == o.screenshots &&
      started_encoding_at == o.started_encoding_at &&
      status == o.status &&
      updated_at == o.updated_at &&
      video_bitrate == o.video_bitrate &&
      video_codec == o.video_codec &&
      video_id == o.video_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 404

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = TelestreamCloud::Flip.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 470

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 383

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


370
371
372
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 370

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



376
377
378
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 376

def hash
  [id, audio_bitrate, audio_channels, audio_codec, audio_sample_rate, created_at, duration, encoding_progress, encoding_time, error_class, error_message, external_id, extname, file_size, files, fps, height, width, logfile_url, mime_type, parent_encoding_id, path, profile_id, profile_name, screenshots, started_encoding_at, status, updated_at, video_bitrate, video_codec, video_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



319
320
321
322
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 319

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



450
451
452
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 450

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



456
457
458
459
460
461
462
463
464
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 456

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



444
445
446
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 444

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



326
327
328
 
# File 'lib/telestream_cloud_flip/models/encoding.rb', line 326

def valid?
  return true
end