Class: TelestreamCloud::Flip::Video

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Video

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'encodings_count')
    self.encodings_count = attributes[:'encodings_count']
  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?(:'extname')
    self.extname = attributes[:'extname']
  end

  if attributes.has_key?(:'file_size')
    self.file_size = attributes[:'file_size']
  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?(:'mime_type')
    self.mime_type = attributes[:'mime_type']
  end

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

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

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

  if attributes.has_key?(:'source_url')
    self.source_url = attributes[:'source_url']
  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

end

Instance Attribute Details

#audio_bitrate ⇒ Object

audio bitrate (in bits/s)



22
23
24
 
# File 'lib/telestream_cloud_flip/models/video.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/video.rb', line 25

def audio_channels
  @audio_channels
end

#audio_codec ⇒ Object

A codec that has been used to encode audio streams.



28
29
30
 
# File 'lib/telestream_cloud_flip/models/video.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/video.rb', line 31

def audio_sample_rate
  @audio_sample_rate
end

#created_at ⇒ Object

A date and time when the Video has been created.



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

def created_at
  @created_at
end

#duration ⇒ Object

A duration of the video in seconds.



37
38
39
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 37

def duration
  @duration
end

#encodings_count ⇒ Object

A number of related Encoding objects.



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

def encodings_count
  @encodings_count
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/video.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/video.rb', line 46

def error_message
  @error_message
end

#extname ⇒ Object

Extension of the source file.



49
50
51
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 49

def extname
  @extname
end

#file_size ⇒ Object

A size of the source file.



52
53
54
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 52

def file_size
  @file_size
end

#fps ⇒ Object

Number of frames per second.



55
56
57
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 55

def fps
  @fps
end

#height ⇒ Object

Height of the output video.



58
59
60
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 58

def height
  @height
end

#id ⇒ Object

A unique identifier of the Video.



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

def id
  @id
end

#mime_type ⇒ Object

A mime type of the source file.



64
65
66
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 64

def mime_type
  @mime_type
end

#original_filename ⇒ Object

A name of the source file.



67
68
69
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 67

def original_filename
  @original_filename
end

#path ⇒ Object

Returns the value of attribute path.



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

def path
  @path
end

#payload ⇒ Object

Payload is an arbitrary text of length 256 or shorter that you can store along the Video. It is typically used to retain an association with one of your own DB record ID.



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

def payload
  @payload
end

#source_url ⇒ Object

An URL pointing to the source file.



75
76
77
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 75

def source_url
  @source_url
end

#status ⇒ Object

Determines at what stage of importing process the Video is at the moment.



78
79
80
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 78

def status
  @status
end

#updated_at ⇒ Object

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



81
82
83
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 81

def updated_at
  @updated_at
end

#video_bitrate ⇒ Object

video bitrate (in bits/s)



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

def video_bitrate
  @video_bitrate
end

#video_codec ⇒ Object

A codec that has been used to encode the input file’s video streams.



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

def video_codec
  @video_codec
end

#width ⇒ Object

Width of the output video.



61
62
63
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 61

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    :'encodings_count' => :'encodings_count',
    :'error_class' => :'error_class',
    :'error_message' => :'error_message',
    :'extname' => :'extname',
    :'file_size' => :'file_size',
    :'fps' => :'fps',
    :'height' => :'height',
    :'width' => :'width',
    :'mime_type' => :'mime_type',
    :'original_filename' => :'original_filename',
    :'path' => :'path',
    :'payload' => :'payload',
    :'source_url' => :'source_url',
    :'status' => :'status',
    :'updated_at' => :'updated_at',
    :'video_bitrate' => :'video_bitrate',
    :'video_codec' => :'video_codec'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/telestream_cloud_flip/models/video.rb', line 121

def self.swagger_types
  {
    :'id' => :'String',
    :'audio_bitrate' => :'Integer',
    :'audio_channels' => :'Integer',
    :'audio_codec' => :'String',
    :'audio_sample_rate' => :'Integer',
    :'created_at' => :'String',
    :'duration' => :'Integer',
    :'encodings_count' => :'Integer',
    :'error_class' => :'String',
    :'error_message' => :'String',
    :'extname' => :'String',
    :'file_size' => :'Integer',
    :'fps' => :'Float',
    :'height' => :'Integer',
    :'width' => :'Integer',
    :'mime_type' => :'String',
    :'original_filename' => :'String',
    :'path' => :'String',
    :'payload' => :'String',
    :'source_url' => :'String',
    :'status' => :'String',
    :'updated_at' => :'String',
    :'video_bitrate' => :'String',
    :'video_codec' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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 &&
      encodings_count == o.encodings_count &&
      error_class == o.error_class &&
      error_message == o.error_message &&
      extname == o.extname &&
      file_size == o.file_size &&
      fps == o.fps &&
      height == o.height &&
      width == o.width &&
      mime_type == o.mime_type &&
      original_filename == o.original_filename &&
      path == o.path &&
      payload == o.payload &&
      source_url == o.source_url &&
      status == o.status &&
      updated_at == o.updated_at &&
      video_bitrate == o.video_bitrate &&
      video_codec == o.video_codec
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



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

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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 402

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 315

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


302
303
304
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



308
309
310
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 308

def hash
  [id, audio_bitrate, audio_channels, audio_codec, audio_sample_rate, created_at, duration, encodings_count, error_class, error_message, extname, file_size, fps, height, width, mime_type, original_filename, path, payload, source_url, status, updated_at, video_bitrate, video_codec].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



258
259
260
261
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 258

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



382
383
384
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 382

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



388
389
390
391
392
393
394
395
396
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 388

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



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

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



265
266
267
 
# File 'lib/telestream_cloud_flip/models/video.rb', line 265

def valid?
  return true
end