class AsposeSlidesCloud::VideoFrame
Represents VideoFrame
resource.
Attributes
Video data encoded in base64.
Determines whether a video is shown in full screen mode.
Determines whether a VideoFrame
is hidden.
Determines whether a video is looped.
Returns or sets the video play mode.
Determines whether a video is automatically rewinded to start as soon as the movie has finished playing
Returns or sets the audio volume.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
AsposeSlidesCloud::GeometryShape::attribute_map
# File lib/aspose_slides_cloud/models/video_frame.rb, line 72 def self.attribute_map super.merge({ :'full_screen_mode' => :'FullScreenMode', :'hide_at_showing' => :'HideAtShowing', :'play_loop_mode' => :'PlayLoopMode', :'play_mode' => :'PlayMode', :'rewind_video' => :'RewindVideo', :'volume' => :'Volume', :'base64_data' => :'Base64Data', }) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
AsposeSlidesCloud::GeometryShape::new
# File lib/aspose_slides_cloud/models/video_frame.rb, line 99 def initialize(attributes = {}) super if attributes.has_key?(:'FullScreenMode') self.full_screen_mode = attributes[:'FullScreenMode'] 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?(:'RewindVideo') self.rewind_video = attributes[:'RewindVideo'] end if attributes.has_key?(:'Volume') self.volume = attributes[:'Volume'] end if attributes.has_key?(:'Base64Data') self.base64_data = attributes[:'Base64Data'] end self.type = "VideoFrame" end
Attribute type mapping.
AsposeSlidesCloud::GeometryShape::swagger_types
# File lib/aspose_slides_cloud/models/video_frame.rb, line 85 def self.swagger_types super.merge({ :'full_screen_mode' => :'BOOLEAN', :'hide_at_showing' => :'BOOLEAN', :'play_loop_mode' => :'BOOLEAN', :'play_mode' => :'String', :'rewind_video' => :'BOOLEAN', :'volume' => :'String', :'base64_data' => :'String', }) end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/aspose_slides_cloud/models/video_frame.rb, line 172 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 && full_screen_mode == o.full_screen_mode && hide_at_showing == o.hide_at_showing && play_loop_mode == o.play_loop_mode && play_mode == o.play_mode && rewind_video == o.rewind_video && volume == o.volume && base64_data == o.base64_data end
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_slides_cloud/models/video_frame.rb, line 249 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
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_slides_cloud/models/video_frame.rb, line 315 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/aspose_slides_cloud/models/video_frame.rb, line 216 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
@see the `==` method @param [Object] Object to be compared
# File lib/aspose_slides_cloud/models/video_frame.rb, line 203 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose_slides_cloud/models/video_frame.rb, line 209 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, full_screen_mode, hide_at_showing, play_loop_mode, play_mode, rewind_video, volume, base64_data].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
AsposeSlidesCloud::GeometryShape#list_invalid_properties
# File lib/aspose_slides_cloud/models/video_frame.rb, line 134 def list_invalid_properties invalid_properties = super invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] play_mode
Object to be assigned
# File lib/aspose_slides_cloud/models/video_frame.rb, line 152 def play_mode=(play_mode) validator = EnumAttributeValidator.new('String', ['Auto', 'OnClick', 'AllSlides', '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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/aspose_slides_cloud/models/video_frame.rb, line 301 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/aspose_slides_cloud/models/video_frame.rb, line 289 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
AsposeSlidesCloud::GeometryShape#valid?
# File lib/aspose_slides_cloud/models/video_frame.rb, line 141 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
Custom attribute writer method checking allowed values (enum). @param [Object] volume Object to be assigned
# File lib/aspose_slides_cloud/models/video_frame.rb, line 162 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