Class: Imagekitio::Models::VideoTransformationReadyEvent::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/imagekitio/models/video_transformation_ready_event.rb

Defined Under Namespace

Classes: Asset, Transformation

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(url: ) ⇒ Object

Information about the source video asset being transformed.

Parameters:

  • url (String) (defaults to: ) —

    URL to download or access the source video file.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/imagekitio/models/video_transformation_ready_event.rb', line 50

class Data < Imagekitio::Internal::Type::BaseModel
  # @!attribute asset
  #   Information about the source video asset being transformed.
  #
  #   @return [Imagekitio::Models::VideoTransformationReadyEvent::Data::Asset]
  required :asset, -> { Imagekitio::VideoTransformationReadyEvent::Data::Asset }

  # @!attribute transformation
  #
  #   @return [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation]
  required :transformation, -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation }

  # @!method initialize(asset:, transformation:)
  #   @param asset [Imagekitio::Models::VideoTransformationReadyEvent::Data::Asset] Information about the source video asset being transformed.
  #
  #   @param transformation [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation]

  # @see Imagekitio::Models::VideoTransformationReadyEvent::Data#asset
  class Asset < Imagekitio::Internal::Type::BaseModel
    # @!attribute url
    #   URL to download or access the source video file.
    #
    #   @return [String]
    required :url, String

    # @!method initialize(url:)
    #   Information about the source video asset being transformed.
    #
    #   @param url [String] URL to download or access the source video file.
  end

  # @see Imagekitio::Models::VideoTransformationReadyEvent::Data#transformation
  class Transformation < Imagekitio::Internal::Type::BaseModel
    # @!attribute type
    #   Type of video transformation:
    #
    #   - `video-transformation`: Standard video processing (resize, format conversion,
    #     etc.)
    #   - `gif-to-video`: Convert animated GIF to video format
    #   - `video-thumbnail`: Generate thumbnail image from video
    #
    #   @return [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Type]
    required :type, enum: -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Type }

    # @!attribute options
    #   Configuration options for video transformations.
    #
    #   @return [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options, nil]
    optional :options, -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options }

    # @!attribute output
    #   Information about the transformed output video.
    #
    #   @return [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Output, nil]
    optional :output, -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output }

    # @!method initialize(type:, options: nil, output: nil)
    #   Some parameter documentations has been truncated, see
    #   {Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation} for
    #   more details.
    #
    #   @param type [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Type] Type of video transformation:
    #
    #   @param options [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options] Configuration options for video transformations.
    #
    #   @param output [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Output] Information about the transformed output video.

    # Type of video transformation:
    #
    # - `video-transformation`: Standard video processing (resize, format conversion,
    #   etc.)
    # - `gif-to-video`: Convert animated GIF to video format
    # - `video-thumbnail`: Generate thumbnail image from video
    #
    # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation#type
    module Type
      extend Imagekitio::Internal::Type::Enum

      VIDEO_TRANSFORMATION = :"video-transformation"
      GIF_TO_VIDEO = :"gif-to-video"
      VIDEO_THUMBNAIL = :"video-thumbnail"

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation#options
    class Options < Imagekitio::Internal::Type::BaseModel
      # @!attribute audio_codec
      #   Audio codec used for encoding (aac or opus).
      #
      #   @return [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec, nil]
      optional :audio_codec,
               enum: -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec }

      # @!attribute auto_rotate
      #   Whether to automatically rotate the video based on metadata.
      #
      #   @return [Boolean, nil]
      optional :auto_rotate, Imagekitio::Internal::Type::Boolean

      # @!attribute format_
      #   Output format for the transformed video or thumbnail.
      #
      #   @return [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format, nil]
      optional :format_,
               enum: -> {
                 Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::Format
               },
               api_name: :format

      # @!attribute quality
      #   Quality setting for the output video.
      #
      #   @return [Integer, nil]
      optional :quality, Integer

      # @!attribute stream_protocol
      #   Streaming protocol for adaptive bitrate streaming.
      #
      #   @return [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol, nil]
      optional :stream_protocol,
               enum: -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol }

      # @!attribute variants
      #   Array of quality representations for adaptive bitrate streaming.
      #
      #   @return [Array<String>, nil]
      optional :variants, Imagekitio::Internal::Type::ArrayOf[String]

      # @!attribute video_codec
      #   Video codec used for encoding (h264, vp9, or av1).
      #
      #   @return [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec, nil]
      optional :video_codec,
               enum: -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec }

      # @!method initialize(audio_codec: nil, auto_rotate: nil, format_: nil, quality: nil, stream_protocol: nil, variants: nil, video_codec: nil)
      #   Configuration options for video transformations.
      #
      #   @param audio_codec [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::AudioCodec] Audio codec used for encoding (aac or opus).
      #
      #   @param auto_rotate [Boolean] Whether to automatically rotate the video based on metadata.
      #
      #   @param format_ [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::Format] Output format for the transformed video or thumbnail.
      #
      #   @param quality [Integer] Quality setting for the output video.
      #
      #   @param stream_protocol [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::StreamProtocol] Streaming protocol for adaptive bitrate streaming.
      #
      #   @param variants [Array<String>] Array of quality representations for adaptive bitrate streaming.
      #
      #   @param video_codec [Symbol, Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options::VideoCodec] Video codec used for encoding (h264, vp9, or av1).

      # Audio codec used for encoding (aac or opus).
      #
      # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options#audio_codec
      module AudioCodec
        extend Imagekitio::Internal::Type::Enum

        AAC = :aac
        OPUS = :opus

        # @!method self.values
        #   @return [Array<Symbol>]
      end

      # Output format for the transformed video or thumbnail.
      #
      # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options#format_
      module Format
        extend Imagekitio::Internal::Type::Enum

        MP4 = :mp4
        WEBM = :webm
        JPG = :jpg
        PNG = :png
        WEBP = :webp

        # @!method self.values
        #   @return [Array<Symbol>]
      end

      # Streaming protocol for adaptive bitrate streaming.
      #
      # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options#stream_protocol
      module StreamProtocol
        extend Imagekitio::Internal::Type::Enum

        HLS = :HLS
        DASH = :DASH

        # @!method self.values
        #   @return [Array<Symbol>]
      end

      # Video codec used for encoding (h264, vp9, or av1).
      #
      # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Options#video_codec
      module VideoCodec
        extend Imagekitio::Internal::Type::Enum

        H264 = :h264
        VP9 = :vp9
        AV1 = :av1

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation#output
    class Output < Imagekitio::Internal::Type::BaseModel
      # @!attribute url
      #   URL to access the transformed video.
      #
      #   @return [String]
      required :url, String

      # @!attribute video_metadata
      #   Metadata of the output video file.
      #
      #   @return [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata, nil]
      optional :video_metadata,
               -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata }

      # @!method initialize(url:, video_metadata: nil)
      #   Information about the transformed output video.
      #
      #   @param url [String] URL to access the transformed video.
      #
      #   @param video_metadata [Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Output::VideoMetadata] Metadata of the output video file.

      # @see Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation::Output#video_metadata
      class VideoMetadata < Imagekitio::Internal::Type::BaseModel
        # @!attribute bitrate
        #   Bitrate of the output video in bits per second.
        #
        #   @return [Integer]
        required :bitrate, Integer

        # @!attribute duration
        #   Duration of the output video in seconds.
        #
        #   @return [Float]
        required :duration, Float

        # @!attribute height
        #   Height of the output video in pixels.
        #
        #   @return [Integer]
        required :height, Integer

        # @!attribute width
        #   Width of the output video in pixels.
        #
        #   @return [Integer]
        required :width, Integer

        # @!method initialize(bitrate:, duration:, height:, width:)
        #   Metadata of the output video file.
        #
        #   @param bitrate [Integer] Bitrate of the output video in bits per second.
        #
        #   @param duration [Float] Duration of the output video in seconds.
        #
        #   @param height [Integer] Height of the output video in pixels.
        #
        #   @param width [Integer] Width of the output video in pixels.
      end
    end
  end
end

Instance Attribute Details

#asset ⇒ Imagekitio::Models::VideoTransformationReadyEvent::Data::Asset

Information about the source video asset being transformed.

Returns:



55
 
# File 'lib/imagekitio/models/video_transformation_ready_event.rb', line 55

required :asset, -> { Imagekitio::VideoTransformationReadyEvent::Data::Asset }

#transformation ⇒ Imagekitio::Models::VideoTransformationReadyEvent::Data::Transformation

Returns:



60
 
# File 'lib/imagekitio/models/video_transformation_ready_event.rb', line 60

required :transformation, -> { Imagekitio::VideoTransformationReadyEvent::Data::Transformation }