class AsposeSlidesCloud::AudioFrame

Represents AudioFrame resource.

Attributes

audio_cd_end_track[RW]

Returns or sets a last track index.

audio_cd_end_track_time[RW]

Returns or sets a last track time.

audio_cd_start_track[RW]

Returns or sets a start track index.

audio_cd_start_track_time[RW]

Returns or sets a start track time.

base64_data[RW]

Audio data encoded in base64.

embedded[RW]

Determines whether a sound is embedded to a presentation.

hide_at_showing[RW]

Determines whether an AudioFrame is hidden.

picture_fill_format[RW]

Picture fill format.

play_across_slides[RW]

Determines whether an audio is playing across the slides.

play_loop_mode[RW]

Determines whether an audio is looped.

play_mode[RW]

Returns or sets the audio play mode.

rewind_audio[RW]

Determines whether audio is automatically rewound to start after playing.

volume[RW]

Returns or sets the audio volume.

Public Class Methods

attribute_map() click to toggle source

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

Calls superclass method
# File lib/aspose_slides_cloud/models/audio_frame.rb, line 68
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',
    :'play_across_slides' => :'PlayAcrossSlides',
    :'rewind_audio' => :'RewindAudio',
    :'picture_fill_format' => :'PictureFillFormat',
  })
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Calls superclass method
# File lib/aspose_slides_cloud/models/audio_frame.rb, line 107
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

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

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

  if attributes.has_key?(:'PictureFillFormat')
    self.picture_fill_format = attributes[:'PictureFillFormat']
  end
  self.type = 'AudioFrame'
end
swagger_types() click to toggle source

Attribute type mapping.

Calls superclass method
# File lib/aspose_slides_cloud/models/audio_frame.rb, line 87
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',
    :'play_across_slides' => :'BOOLEAN',
    :'rewind_audio' => :'BOOLEAN',
    :'picture_fill_format' => :'PictureFill',
  })
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/audio_frame.rb, line 204
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 &&
      is_decorative == o.is_decorative &&
      x == o.x &&
      y == o.y &&
      z_order_position == o.z_order_position &&
      fill_format == o.fill_format &&
      effect_format == o.effect_format &&
      three_d_format == o.three_d_format &&
      line_format == o.line_format &&
      hyperlink_click == o.hyperlink_click &&
      hyperlink_mouse_over == o.hyperlink_mouse_over &&
      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 &&
      play_across_slides == o.play_across_slides &&
      rewind_audio == o.rewind_audio &&
      picture_fill_format == o.picture_fill_format
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/audio_frame.rb, line 244
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose_slides_cloud/models/audio_frame.rb, line 250
def hash
  [self_uri, alternate_links, name, width, height, alternative_text, alternative_text_title, hidden, is_decorative, x, y, z_order_position, fill_format, effect_format, three_d_format, line_format, hyperlink_click, hyperlink_mouse_over, 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, play_across_slides, rewind_audio, picture_fill_format].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Calls superclass method
# File lib/aspose_slides_cloud/models/audio_frame.rb, line 166
def list_invalid_properties
  invalid_properties = super
  invalid_properties
end
play_mode=(play_mode) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] play_mode Object to be assigned

# File lib/aspose_slides_cloud/models/audio_frame.rb, line 184
def play_mode=(play_mode)
  validator = EnumAttributeValidator.new('String', ['Auto', 'OnClick', 'AllSlides', 'InClickSequence', 'Mixed'])
  unless validator.valid?(play_mode)
    fail ArgumentError, 'invalid value for "play_mode", must be one of #{validator.allowable_values}.'
  end
  @play_mode = play_mode
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

Calls superclass method
# File lib/aspose_slides_cloud/models/audio_frame.rb, line 173
def valid?
  return false if !super
  play_mode_validator = EnumAttributeValidator.new('String', ['Auto', 'OnClick', 'AllSlides', 'InClickSequence', '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
volume=(volume) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] volume Object to be assigned

# File lib/aspose_slides_cloud/models/audio_frame.rb, line 194
def volume=(volume)
  validator = EnumAttributeValidator.new('String', ['Mute', 'Low', 'Medium', 'Loud', 'Mixed'])
  unless validator.valid?(volume)
    fail ArgumentError, 'invalid value for "volume", must be one of #{validator.allowable_values}.'
  end
  @volume = volume
end