class AsposePdfCloud::SoundAnnotation

Provides SoundAnnotation.

Attributes

bits[RW]

Gets or sets the number of bits per sample value per channel.

channels[RW]

Gets or sets the number of sound channels.

color[RW]

Color of the annotation.

contents[RW]

Get the annotation content.

creation_date[RW]

The date and time when the annotation was created.

encoding[RW]

Gets or sets the encoding format for the sample data.

file_path[RW]

A sound file path defining the sound to be played when the annotation is activated.

flags[RW]

Gets Flags of the annotation.

horizontal_alignment[RW]

Gets HorizontalAlignment of the annotation.

icon[RW]

Gets or sets an icon to be used in displaying the annotation.

id[RW]

Gets ID of the annotation.

modified[RW]

The date and time when the annotation was last modified.

name[RW]

Gets Name of the annotation.

page_index[RW]

Gets PageIndex of the annotation.

rate[RW]

Gets or sets the sampling rate, in samples per second.

rect[RW]

Gets Rect of the annotation.

rich_text[RW]

Get the annotation RichText.

subject[RW]

Get the annotation subject.

title[RW]

Get the annotation title.

vertical_alignment[RW]

Gets VerticalAlignment of the annotation.

z_index[RW]

Gets ZIndex of the annotation.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 96
def self.attribute_map
  {
    :'links' => :'Links',
    :'color' => :'Color',
    :'contents' => :'Contents',
    :'modified' => :'Modified',
    :'id' => :'Id',
    :'flags' => :'Flags',
    :'name' => :'Name',
    :'rect' => :'Rect',
    :'page_index' => :'PageIndex',
    :'z_index' => :'ZIndex',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'creation_date' => :'CreationDate',
    :'subject' => :'Subject',
    :'title' => :'Title',
    :'rich_text' => :'RichText',
    :'file_path' => :'FilePath',
    :'icon' => :'Icon',
    :'rate' => :'Rate',
    :'channels' => :'Channels',
    :'bits' => :'Bits',
    :'encoding' => :'Encoding'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 153
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?(:'Links')
    if (value = attributes[:'Links']).is_a?(Array)
      self.links = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 124
def self.swagger_types
  {
    :'links' => :'Array<Link>',
    :'color' => :'Color',
    :'contents' => :'String',
    :'modified' => :'String',
    :'id' => :'String',
    :'flags' => :'Array<AnnotationFlags>',
    :'name' => :'String',
    :'rect' => :'Rectangle',
    :'page_index' => :'Integer',
    :'z_index' => :'Integer',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'creation_date' => :'String',
    :'subject' => :'String',
    :'title' => :'String',
    :'rich_text' => :'String',
    :'file_path' => :'String',
    :'icon' => :'SoundIcon',
    :'rate' => :'Integer',
    :'channels' => :'Integer',
    :'bits' => :'Integer',
    :'encoding' => :'SoundEncoding'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 297
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      links == o.links &&
      color == o.color &&
      contents == o.contents &&
      modified == o.modified &&
      id == o.id &&
      flags == o.flags &&
      name == o.name &&
      rect == o.rect &&
      page_index == o.page_index &&
      z_index == o.z_index &&
      horizontal_alignment == o.horizontal_alignment &&
      vertical_alignment == o.vertical_alignment &&
      creation_date == o.creation_date &&
      subject == o.subject &&
      title == o.title &&
      rich_text == o.rich_text &&
      file_path == o.file_path &&
      icon == o.icon &&
      rate == o.rate &&
      channels == o.channels &&
      bits == o.bits &&
      encoding == o.encoding
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 360
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 = AsposePdfCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 426
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 339
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) click to toggle source

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

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 326
def eql?(o)
  self == o
end
file_path=(file_path) click to toggle source

Custom attribute writer method with validation @param [Object] file_path Value to be assigned

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 283
def file_path=(file_path)
  if file_path.nil?
    fail ArgumentError, "file_path cannot be nil"
  end

  if file_path.to_s.length < 1
    fail ArgumentError, "invalid value for 'file_path', the character length must be great than or equal to 1."
  end

  @file_path = file_path
end
hash() click to toggle source

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

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 332
def hash
  [links, color, contents, modified, id, flags, name, rect, page_index, z_index, horizontal_alignment, vertical_alignment, creation_date, subject, title, rich_text, file_path, icon, rate, channels, bits, encoding].hash
end
list_invalid_properties() click to toggle source

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

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 255
def list_invalid_properties
  invalid_properties = Array.new
  if @rect.nil?
    invalid_properties.push("invalid value for 'rect', rect cannot be nil.")
  end

  if @file_path.nil?
    invalid_properties.push("invalid value for 'file_path', file_path cannot be nil.")
  end

  if @file_path.to_s.length < 1
    invalid_properties.push("invalid value for 'file_path', the character length must be great than or equal to 1.")
  end

  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 406
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 412
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 400
def to_s
  to_hash.to_s
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

# File lib/aspose_pdf_cloud/models/sound_annotation.rb, line 274
def valid?
  return false if @rect.nil?
  return false if @file_path.nil?
  return false if @file_path.to_s.length < 1
  return true
end