Class: MuxRuby::InputSettingsOverlaySettings

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/models/input_settings_overlay_settings.rb

Overview

An object that describes how the image file referenced in URL should be placed over the video (i.e. watermarking). Ensure that the URL is active and persists the entire lifespan of the video object.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InputSettingsOverlaySettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::InputSettingsOverlaySettings` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MuxRuby::InputSettingsOverlaySettings`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'vertical_align')
    self.vertical_align = attributes[:'vertical_align']
  end

  if attributes.key?(:'vertical_margin')
    self.vertical_margin = attributes[:'vertical_margin']
  end

  if attributes.key?(:'horizontal_align')
    self.horizontal_align = attributes[:'horizontal_align']
  end

  if attributes.key?(:'horizontal_margin')
    self.horizontal_margin = attributes[:'horizontal_margin']
  end

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

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

  if attributes.key?(:'opacity')
    self.opacity = attributes[:'opacity']
  end
end

Instance Attribute Details

#height ⇒ Object

How tall the overlay should appear. Can be expressed as a percent ("10%") or as a pixel value ("100px"). If both width and height are left blank the height will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If width is supplied with no height, the height will scale proportionally to the width.



35
36
37
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 35

def height
  @height
end

#horizontal_align ⇒ Object

Where the horizontal positioning of the overlay/watermark should begin from.



26
27
28
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 26

def horizontal_align
  @horizontal_align
end

#horizontal_margin ⇒ Object

The distance from the horizontal_align starting point and the image’s closest edge. Can be expressed as a percent ("10%") or as a pixel value ("100px"). Negative values will move the overlay offscreen. In the case of ‘center’, a positive value will shift the image towards the right and and a negative value will shift it towards the left.



29
30
31
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 29

def horizontal_margin
  @horizontal_margin
end

#opacity ⇒ Object

How opaque the overlay should appear, expressed as a percent. (Default 100%)



38
39
40
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 38

def opacity
  @opacity
end

#vertical_align ⇒ Object

Where the vertical positioning of the overlay/watermark should begin from. Defaults to ‘"top"`



20
21
22
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 20

def vertical_align
  @vertical_align
end

#vertical_margin ⇒ Object

The distance from the vertical_align starting point and the image’s closest edge. Can be expressed as a percent ("10%") or as a pixel value ("100px"). Negative values will move the overlay offscreen. In the case of ‘middle’, a positive value will shift the overlay towards the bottom and and a negative value will shift it towards the top.



23
24
25
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 23

def vertical_margin
  @vertical_margin
end

#width ⇒ Object

How wide the overlay should appear. Can be expressed as a percent ("10%") or as a pixel value ("100px"). If both width and height are left blank the width will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If height is supplied with no width, the width will scale proportionally to the height.



32
33
34
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 32

def width
  @width
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 63

def self.attribute_map
  {
    :'vertical_align' => :'vertical_align',
    :'vertical_margin' => :'vertical_margin',
    :'horizontal_align' => :'horizontal_align',
    :'horizontal_margin' => :'horizontal_margin',
    :'width' => :'width',
    :'height' => :'height',
    :'opacity' => :'opacity'
  }
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



209
210
211
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 209

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 94

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 81

def self.openapi_types
  {
    :'vertical_align' => :'String',
    :'vertical_margin' => :'String',
    :'horizontal_align' => :'String',
    :'horizontal_margin' => :'String',
    :'width' => :'String',
    :'height' => :'String',
    :'opacity' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      vertical_align == o.vertical_align &&
      vertical_margin == o.vertical_margin &&
      horizontal_align == o.horizontal_align &&
      horizontal_margin == o.horizontal_margin &&
      width == o.width &&
      height == o.height &&
      opacity == o.opacity
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



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/mux_ruby/models/input_settings_overlay_settings.rb', line 239

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = MuxRuby.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 310

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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 216

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


196
197
198
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



202
203
204
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 202

def hash
  [vertical_align, vertical_margin, horizontal_align, horizontal_margin, width, height, opacity].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



145
146
147
148
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  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



286
287
288
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 286

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 292

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



280
281
282
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 280

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



152
153
154
155
156
157
158
 
# File 'lib/mux_ruby/models/input_settings_overlay_settings.rb', line 152

def valid?
  vertical_align_validator = EnumAttributeValidator.new('String', ["top", "middle", "bottom"])
  return false unless vertical_align_validator.valid?(@vertical_align)
  horizontal_align_validator = EnumAttributeValidator.new('String', ["left", "center", "right"])
  return false unless horizontal_align_validator.valid?(@horizontal_align)
  true
end