Class: AsposeSlidesCloud::VideoFrame

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

Overview

Represents VideoFrame resource.

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, #hyperlink_click, #hyperlink_mouse_over, #is_decorative, #line_format, #name, #three_d_format, #type, #width, #x, #y, #z_order_position

Attributes inherited from ResourceBase

#alternate_links, #self_uri

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseObject

#_deserialize, #_to_hash, #build_from_hash, #to_body, #to_hash, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ VideoFrame

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
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
 
# File 'lib/aspose_slides_cloud/models/video_frame.rb', line 92

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

  if attributes.has_key?(:'PictureFillFormat')
    self.picture_fill_format = attributes[:'PictureFillFormat']
  end

  if attributes.has_key?(:'TrimFromStart')
    self.trim_from_start = attributes[:'TrimFromStart']
  end

  if attributes.has_key?(:'TrimFromEnd')
    self.trim_from_end = attributes[:'TrimFromEnd']
  end
  self.type = 'VideoFrame'
end

Instance Attribute Details

#base64_data ⇒ Object

Video data encoded in base64.



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

def base64_data
  @base64_data
end

#full_screen_mode ⇒ Object

Determines whether a video is shown in full screen mode.



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

def full_screen_mode
  @full_screen_mode
end

#hide_at_showing ⇒ Object

Determines whether a VideoFrame is hidden.



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

def hide_at_showing
  @hide_at_showing
end

#picture_fill_format ⇒ Object

Picture fill format.



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

def picture_fill_format
  @picture_fill_format
end

#play_loop_mode ⇒ Object

Determines whether a video is looped.



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

def play_loop_mode
  @play_loop_mode
end

#play_mode ⇒ Object

Returns or sets the video play mode.



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

def play_mode
  @play_mode
end

#rewind_video ⇒ Object

Determines whether a video is automatically rewinded to start as soon as the movie has finished playing



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

def rewind_video
  @rewind_video
end

#trim_from_end ⇒ Object

Trim end [ms]



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

def trim_from_end
  @trim_from_end
end

#trim_from_start ⇒ Object

Trim start [ms]



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

def trim_from_start
  @trim_from_start
end

#volume ⇒ Object

Returns or sets the audio volume.



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

def volume
  @volume
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/aspose_slides_cloud/models/video_frame.rb', line 59

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',
    :'picture_fill_format' => :'PictureFillFormat',
    :'trim_from_start' => :'TrimFromStart',
    :'trim_from_end' => :'TrimFromEnd',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/aspose_slides_cloud/models/video_frame.rb', line 75

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',
    :'picture_fill_format' => :'PictureFill',
    :'trim_from_start' => :'Float',
    :'trim_from_end' => :'Float',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/aspose_slides_cloud/models/video_frame.rb', line 177

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 &&
      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 &&
      picture_fill_format == o.picture_fill_format &&
      trim_from_start == o.trim_from_start &&
      trim_from_end == o.trim_from_end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


214
215
216
 
# File 'lib/aspose_slides_cloud/models/video_frame.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/aspose_slides_cloud/models/video_frame.rb', line 220

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, full_screen_mode, hide_at_showing, play_loop_mode, play_mode, rewind_video, volume, base64_data, picture_fill_format, trim_from_start, trim_from_end].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



139
140
141
142
 
# File 'lib/aspose_slides_cloud/models/video_frame.rb', line 139

def list_invalid_properties
  invalid_properties = super
  invalid_properties
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



146
147
148
149
150
151
152
153
 
# File 'lib/aspose_slides_cloud/models/video_frame.rb', line 146

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