Class: WhopSDK::Models::MediaGenerateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::MediaGenerateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/media_generate_params.rb,
sig/whop_sdk/models/media_generate_params.rbs

Overview

See Also:

• WhopSDK::Resources::Media#generate

Defined Under Namespace

Modules: DurationSeconds, Resolution, Type

Instance Attribute Summary

• #account_id ⇒ String^?

  Account ID, prefixed biz_.

• #duration_seconds ⇒ Integer, ...

  Video length in seconds.

• #prompt ⇒ String

  What to generate.

• #reference_media ⇒ Array<String>^?

  Optional reference image file IDs (file_ prefixed), up to 4.

• #resolution ⇒ Symbol, ...

  Video resolution.

• #type ⇒ Symbol, WhopSDK::Models::MediaGenerateParams::Type

  The kind of media to generate.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Integer>

Instance Method Summary

• #initialize(prompt:, type:, account_id: nil, duration_seconds: nil, reference_media: nil, resolution: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see MediaGenerateParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(prompt:, type:, account_id: nil, duration_seconds: nil, reference_media: nil, resolution: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::MediaGenerateParams for more details.

Parameters:

• prompt (String) —

  What to generate. Up to 2,000 characters.

• type (Symbol, WhopSDK::Models::MediaGenerateParams::Type) —

  The kind of media to generate.

• account_id (String) (defaults to: nil) —

  Account ID, prefixed biz_. Defaults to the account the API key belongs to.

• duration_seconds (Integer, WhopSDK::Models::MediaGenerateParams::DurationSeconds) (defaults to: nil) —

  Video length in seconds. Video only; defaults to 5.

• reference_media (Array<String>) (defaults to: nil) —

  Optional reference image file IDs (file_ prefixed), up to 4. For video, a sing

• resolution (Symbol, WhopSDK::Models::MediaGenerateParams::Resolution) (defaults to: nil) —

  Video resolution. Video only; defaults to 1080p. 1080p is not supported by S

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/whop_sdk/models/media_generate_params.rb', line 49

Instance Attribute Details

#account_id ⇒ String^?

Account ID, prefixed biz_. Defaults to the account the API key belongs to.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/media_generate_params.rb', line 26

optional :account_id, String

#duration_seconds ⇒ Integer, ...

Video length in seconds. Video only; defaults to 5.

Returns:

• (Integer, WhopSDK::Models::MediaGenerateParams::DurationSeconds, nil)

# File 'lib/whop_sdk/models/media_generate_params.rb', line 32

optional :duration_seconds, enum: -> { WhopSDK::MediaGenerateParams::DurationSeconds }

#prompt ⇒ String

What to generate. Up to 2,000 characters.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/whop_sdk/models/media_generate_params.rb', line 14

required :prompt, String

#reference_media ⇒ Array<String>^?

Optional reference image file IDs (file_ prefixed), up to 4. For video, a single reference seeds the opening frame; multiple references guide subject and style instead.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/whop_sdk/models/media_generate_params.rb', line 40

optional :reference_media, WhopSDK::Internal::Type::ArrayOf[String]

#resolution ⇒ Symbol, ...

Video resolution. Video only; defaults to 1080p. 1080p is not supported by Seedance 2.0 Fast or Mini; 4k is only supported by Seedance 2.0.

Returns:

• (Symbol, WhopSDK::Models::MediaGenerateParams::Resolution, nil)

# File 'lib/whop_sdk/models/media_generate_params.rb', line 47

optional :resolution, enum: -> { WhopSDK::MediaGenerateParams::Resolution }

#type ⇒ Symbol, WhopSDK::Models::MediaGenerateParams::Type

The kind of media to generate.

Parameters:

• value (WhopSDK::Models::MediaGenerateParams::type_)

Returns:

• (Symbol, WhopSDK::Models::MediaGenerateParams::Type)

# File 'lib/whop_sdk/models/media_generate_params.rb', line 20

required :type, enum: -> { WhopSDK::MediaGenerateParams::Type }

Class Method Details

.values ⇒ Array<Integer>

Returns:

• (Array<Integer>)

# File 'lib/whop_sdk/models/media_generate_params.rb', line 74

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/whop_sdk/models/media_generate_params.rbs', line 52

def to_hash: -> {