Class: Inttegro::File::Media

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/file/media.rb

Overview

Typed representation of the media object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#aspect_ratio ⇒ String? (readonly)

Value of the aspect_ratio field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: aspect_ratio.

Returns:

  • (String, nil) 


77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/inttegro/file/media.rb', line 77

class Media < T::Struct
  const :kind, T.nilable(String), default: nil
  const :width, T.nilable(Integer), default: nil
  const :height, T.nilable(Integer), default: nil
  const :duration_ms, T.nilable(Integer), default: nil
  const :page_count, T.nilable(Integer), default: nil
  const :frame_count, T.nilable(Integer), default: nil
  const :color_space, T.nilable(String), default: nil
  const :has_alpha, T.nilable(T::Boolean), default: nil
  const :codec, T.nilable(String), default: nil
  const :aspect_ratio, T.nilable(String), default: nil
end

#codec ⇒ String? (readonly)

Value of the codec field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: codec.

Returns:

  • (String, nil) 


77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/inttegro/file/media.rb', line 77

class Media < T::Struct
  const :kind, T.nilable(String), default: nil
  const :width, T.nilable(Integer), default: nil
  const :height, T.nilable(Integer), default: nil
  const :duration_ms, T.nilable(Integer), default: nil
  const :page_count, T.nilable(Integer), default: nil
  const :frame_count, T.nilable(Integer), default: nil
  const :color_space, T.nilable(String), default: nil
  const :has_alpha, T.nilable(T::Boolean), default: nil
  const :codec, T.nilable(String), default: nil
  const :aspect_ratio, T.nilable(String), default: nil
end

#color_space ⇒ String? (readonly)

Value of the color_space field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: color_space.

Returns:

  • (String, nil) 


77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/inttegro/file/media.rb', line 77

class Media < T::Struct
  const :kind, T.nilable(String), default: nil
  const :width, T.nilable(Integer), default: nil
  const :height, T.nilable(Integer), default: nil
  const :duration_ms, T.nilable(Integer), default: nil
  const :page_count, T.nilable(Integer), default: nil
  const :frame_count, T.nilable(Integer), default: nil
  const :color_space, T.nilable(String), default: nil
  const :has_alpha, T.nilable(T::Boolean), default: nil
  const :codec, T.nilable(String), default: nil
  const :aspect_ratio, T.nilable(String), default: nil
end

#duration_ms ⇒ Integer? (readonly)

Value of the duration_ms field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: duration_ms.

Returns:

  • (Integer, nil) 


77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/inttegro/file/media.rb', line 77

class Media < T::Struct
  const :kind, T.nilable(String), default: nil
  const :width, T.nilable(Integer), default: nil
  const :height, T.nilable(Integer), default: nil
  const :duration_ms, T.nilable(Integer), default: nil
  const :page_count, T.nilable(Integer), default: nil
  const :frame_count, T.nilable(Integer), default: nil
  const :color_space, T.nilable(String), default: nil
  const :has_alpha, T.nilable(T::Boolean), default: nil
  const :codec, T.nilable(String), default: nil
  const :aspect_ratio, T.nilable(String), default: nil
end

#frame_count ⇒ Integer? (readonly)

Value of the frame_count field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: frame_count.

Returns:

  • (Integer, nil) 


77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/inttegro/file/media.rb', line 77

class Media < T::Struct
  const :kind, T.nilable(String), default: nil
  const :width, T.nilable(Integer), default: nil
  const :height, T.nilable(Integer), default: nil
  const :duration_ms, T.nilable(Integer), default: nil
  const :page_count, T.nilable(Integer), default: nil
  const :frame_count, T.nilable(Integer), default: nil
  const :color_space, T.nilable(String), default: nil
  const :has_alpha, T.nilable(T::Boolean), default: nil
  const :codec, T.nilable(String), default: nil
  const :aspect_ratio, T.nilable(String), default: nil
end

#has_alpha ⇒ Boolean? (readonly)

Value of the has_alpha field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: has_alpha.

Returns:

  • (Boolean, nil) 


77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/inttegro/file/media.rb', line 77

class Media < T::Struct
  const :kind, T.nilable(String), default: nil
  const :width, T.nilable(Integer), default: nil
  const :height, T.nilable(Integer), default: nil
  const :duration_ms, T.nilable(Integer), default: nil
  const :page_count, T.nilable(Integer), default: nil
  const :frame_count, T.nilable(Integer), default: nil
  const :color_space, T.nilable(String), default: nil
  const :has_alpha, T.nilable(T::Boolean), default: nil
  const :codec, T.nilable(String), default: nil
  const :aspect_ratio, T.nilable(String), default: nil
end

#height ⇒ Integer? (readonly)

Value of the height field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: height.

Returns:

  • (Integer, nil) 


77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/inttegro/file/media.rb', line 77

class Media < T::Struct
  const :kind, T.nilable(String), default: nil
  const :width, T.nilable(Integer), default: nil
  const :height, T.nilable(Integer), default: nil
  const :duration_ms, T.nilable(Integer), default: nil
  const :page_count, T.nilable(Integer), default: nil
  const :frame_count, T.nilable(Integer), default: nil
  const :color_space, T.nilable(String), default: nil
  const :has_alpha, T.nilable(T::Boolean), default: nil
  const :codec, T.nilable(String), default: nil
  const :aspect_ratio, T.nilable(String), default: nil
end

#kind ⇒ String? (readonly)

Value of the kind field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: kind.

Returns:

  • (String, nil) 


77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/inttegro/file/media.rb', line 77

class Media < T::Struct
  const :kind, T.nilable(String), default: nil
  const :width, T.nilable(Integer), default: nil
  const :height, T.nilable(Integer), default: nil
  const :duration_ms, T.nilable(Integer), default: nil
  const :page_count, T.nilable(Integer), default: nil
  const :frame_count, T.nilable(Integer), default: nil
  const :color_space, T.nilable(String), default: nil
  const :has_alpha, T.nilable(T::Boolean), default: nil
  const :codec, T.nilable(String), default: nil
  const :aspect_ratio, T.nilable(String), default: nil
end

#page_count ⇒ Integer? (readonly)

Value of the page_count field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: page_count.

Returns:

  • (Integer, nil) 


77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/inttegro/file/media.rb', line 77

class Media < T::Struct
  const :kind, T.nilable(String), default: nil
  const :width, T.nilable(Integer), default: nil
  const :height, T.nilable(Integer), default: nil
  const :duration_ms, T.nilable(Integer), default: nil
  const :page_count, T.nilable(Integer), default: nil
  const :frame_count, T.nilable(Integer), default: nil
  const :color_space, T.nilable(String), default: nil
  const :has_alpha, T.nilable(T::Boolean), default: nil
  const :codec, T.nilable(String), default: nil
  const :aspect_ratio, T.nilable(String), default: nil
end

#width ⇒ Integer? (readonly)

Value of the width field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: width.

Returns:

  • (Integer, nil) 


77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/inttegro/file/media.rb', line 77

class Media < T::Struct
  const :kind, T.nilable(String), default: nil
  const :width, T.nilable(Integer), default: nil
  const :height, T.nilable(Integer), default: nil
  const :duration_ms, T.nilable(Integer), default: nil
  const :page_count, T.nilable(Integer), default: nil
  const :frame_count, T.nilable(Integer), default: nil
  const :color_space, T.nilable(String), default: nil
  const :has_alpha, T.nilable(T::Boolean), default: nil
  const :codec, T.nilable(String), default: nil
  const :aspect_ratio, T.nilable(String), default: nil
end