Class VideoCreateParams.Body
-
- All Implemented Interfaces:
public final class VideoCreateParams.BodyMultipart parameters for creating a new video generation job.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classVideoCreateParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final Stringprompt()Text prompt that describes the video to generate. final Optional<VideoCreateParams.InputReference>inputReference()Optional reference asset upload or reference object that guides generation. final Optional<VideoModel>model()The video generation model to use (allowed values: sora-2, sora-2-pro). final Optional<VideoSeconds>seconds()Clip duration in seconds (allowed values: 4, 8, 12). final Optional<VideoSize>size()Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). final MultipartField<String>_prompt()Returns the raw multipart value of prompt. final MultipartField<VideoCreateParams.InputReference>_inputReference()Returns the raw multipart value of inputReference. final MultipartField<VideoModel>_model()Returns the raw multipart value of model. final MultipartField<VideoSeconds>_seconds()Returns the raw multipart value of seconds. final MultipartField<VideoSize>_size()Returns the raw multipart value of size. final Map<String, JsonValue>_additionalProperties()final VideoCreateParams.Body.BuildertoBuilder()final VideoCreateParams.Bodyvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static VideoCreateParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
inputReference
final Optional<VideoCreateParams.InputReference> inputReference()
Optional reference asset upload or reference object that guides generation.
-
model
final Optional<VideoModel> model()
The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults to
sora-2.
-
seconds
final Optional<VideoSeconds> seconds()
Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.
-
size
final Optional<VideoSize> size()
Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.
-
_prompt
final MultipartField<String> _prompt()
Returns the raw multipart value of prompt.
Unlike prompt, this method doesn't throw if the multipart field has an unexpected type.
-
_inputReference
final MultipartField<VideoCreateParams.InputReference> _inputReference()
Returns the raw multipart value of inputReference.
Unlike inputReference, this method doesn't throw if the multipart field has an unexpected type.
-
_model
final MultipartField<VideoModel> _model()
Returns the raw multipart value of model.
Unlike model, this method doesn't throw if the multipart field has an unexpected type.
-
_seconds
final MultipartField<VideoSeconds> _seconds()
Returns the raw multipart value of seconds.
Unlike seconds, this method doesn't throw if the multipart field has an unexpected type.
-
_size
final MultipartField<VideoSize> _size()
Returns the raw multipart value of size.
Unlike size, this method doesn't throw if the multipart field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final VideoCreateParams.Body.Builder toBuilder()
-
validate
final VideoCreateParams.Body validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static VideoCreateParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.prompt()
-
-
-
-