Class: AsposeSlidesCloud::AudioFrame

Inherits:
GeometryShape show all
Defined in:
lib/aspose_slides_cloud/models/audio_frame.rb

Overview

Represents AudioFrame resource.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from GeometryShape

#shape_type

Attributes inherited from ShapeBase

#alternative_text, #alternative_text_title, #effect_format, #fill_format, #height, #hidden, #line_format, #name, #shapes, #type, #width, #x, #y, #z_order_position

Attributes inherited from ResourceBase

#alternate_links, #self_uri

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AudioFrame

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 114

def initialize(attributes = {})
  super

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'Base64Data')
    self.base64_data = attributes[:'Base64Data']
  end
  self.type = "AudioFrame"
end

Instance Attribute Details

#audio_cd_end_track ⇒ Object

Returns or sets a last track index.



29
30
31
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 29

def audio_cd_end_track
  @audio_cd_end_track
end

#audio_cd_end_track_time ⇒ Object

Returns or sets a last track time.



32
33
34
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 32

def audio_cd_end_track_time
  @audio_cd_end_track_time
end

#audio_cd_start_track ⇒ Object

Returns or sets a start track index.



35
36
37
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 35

def audio_cd_start_track
  @audio_cd_start_track
end

#audio_cd_start_track_time ⇒ Object

Returns or sets a start track time.



38
39
40
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 38

def audio_cd_start_track_time
  @audio_cd_start_track_time
end

#base64_data ⇒ Object

Audio data encoded in base64.



56
57
58
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 56

def base64_data
  @base64_data
end

#embedded ⇒ Object

Determines whether a sound is embedded to a presentation.



41
42
43
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 41

def embedded
  @embedded
end

#hide_at_showing ⇒ Object

Determines whether an AudioFrame is hidden.



44
45
46
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 44

def hide_at_showing
  @hide_at_showing
end

#play_loop_mode ⇒ Object

Determines whether an audio is looped.



47
48
49
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 47

def play_loop_mode
  @play_loop_mode
end

#play_mode ⇒ Object

Returns or sets the audio play mode.



50
51
52
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 50

def play_mode
  @play_mode
end

#volume ⇒ Object

Returns or sets the audio volume.



53
54
55
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 53

def volume
  @volume
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 81

def self.attribute_map
  super.merge({
    :'audio_cd_end_track' => :'AudioCdEndTrack',
    :'audio_cd_end_track_time' => :'AudioCdEndTrackTime',
    :'audio_cd_start_track' => :'AudioCdStartTrack',
    :'audio_cd_start_track_time' => :'AudioCdStartTrackTime',
    :'embedded' => :'Embedded',
    :'hide_at_showing' => :'HideAtShowing',
    :'play_loop_mode' => :'PlayLoopMode',
    :'play_mode' => :'PlayMode',
    :'volume' => :'Volume',
    :'base64_data' => :'Base64Data',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 97

def self.swagger_types
  super.merge({
    :'audio_cd_end_track' => :'Integer',
    :'audio_cd_end_track_time' => :'Integer',
    :'audio_cd_start_track' => :'Integer',
    :'audio_cd_start_track_time' => :'Integer',
    :'embedded' => :'BOOLEAN',
    :'hide_at_showing' => :'BOOLEAN',
    :'play_loop_mode' => :'BOOLEAN',
    :'play_mode' => :'String',
    :'volume' => :'String',
    :'base64_data' => :'String',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      name == o.name &&
      width == o.width &&
      height == o.height &&
      alternative_text == o.alternative_text &&
      alternative_text_title == o.alternative_text_title &&
      hidden == o.hidden &&
      x == o.x &&
      y == o.y &&
      z_order_position == o.z_order_position &&
      shapes == o.shapes &&
      fill_format == o.fill_format &&
      effect_format == o.effect_format &&
      line_format == o.line_format &&
      type == o.type &&
      shape_type == o.shape_type &&
      audio_cd_end_track == o.audio_cd_end_track &&
      audio_cd_end_track_time == o.audio_cd_end_track_time &&
      audio_cd_start_track == o.audio_cd_start_track &&
      audio_cd_start_track_time == o.audio_cd_start_track_time &&
      embedded == o.embedded &&
      hide_at_showing == o.hide_at_showing &&
      play_loop_mode == o.play_loop_mode &&
      play_mode == o.play_mode &&
      volume == o.volume &&
      base64_data == o.base64_data
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



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/aspose_slides_cloud/models/audio_frame.rb', line 279

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 = AsposeSlidesCloud.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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 345

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



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
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 246

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    mapKey = self.class.attribute_map[key]
    if !mapKey.nil?
      val = attributes[mapKey]
      if val.nil?
        mapKeyString = mapKey.to_s
        mapKeyString[0] = mapKeyString[0].downcase
        mapKey = mapKeyString.to_sym
        val = attributes[mapKey]
      end
      if !val.nil?
        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 val.is_a?(Array)
            self.send("#{key}=", val.map { |v| _deserialize($1, v) })
          end
        else
          self.send("#{key}=", _deserialize(type, val))
        end
      end
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


233
234
235
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



239
240
241
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 239

def hash
  [self_uri, alternate_links, name, width, height, alternative_text, alternative_text_title, hidden, x, y, z_order_position, shapes, fill_format, effect_format, line_format, type, shape_type, audio_cd_end_track, audio_cd_end_track_time, audio_cd_start_track, audio_cd_start_track_time, embedded, hide_at_showing, play_loop_mode, play_mode, volume, base64_data].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



161
162
163
164
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 161

def list_invalid_properties
  invalid_properties = super
  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



325
326
327
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 325

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



331
332
333
334
335
336
337
338
339
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 331

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



319
320
321
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 319

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



168
169
170
171
172
173
174
175
 
# File 'lib/aspose_slides_cloud/models/audio_frame.rb', line 168

def valid?
  return false if !super
  play_mode_validator = EnumAttributeValidator.new('String', ['Auto', 'OnClick', 'AllSlides', 'Mixed'])
  return false unless play_mode_validator.valid?(@play_mode)
  volume_validator = EnumAttributeValidator.new('String', ['Mute', 'Low', 'Medium', 'Loud', 'Mixed'])
  return false unless volume_validator.valid?(@volume)
  true
end