All Implemented Interfaces:


public final class VideoCreateParams.Body.Builder

A builder for Body.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final VideoCreateParams.Body.Builder`	`prompt(String prompt)`	Text prompt that describes the video to generate.
`final VideoCreateParams.Body.Builder`	`prompt(MultipartField<String> prompt)`	Sets Builder.prompt to an arbitrary multipart value.
`final VideoCreateParams.Body.Builder`	`inputReference(VideoCreateParams.InputReference inputReference)`	Optional reference asset upload or reference object that guides generation.
`final VideoCreateParams.Body.Builder`	`inputReference(MultipartField<VideoCreateParams.InputReference> inputReference)`	Sets Builder.inputReference to an arbitrary multipart value.
`final VideoCreateParams.Body.Builder`	`inputReference(InputStream stream)`	Alias for calling inputReference with `InputReference.ofStream(stream)`.
`final VideoCreateParams.Body.Builder`	`inputReference(ByteArray stream)`	Optional reference asset upload or reference object that guides generation.
`final VideoCreateParams.Body.Builder`	`inputReference(Path path)`	Optional reference asset upload or reference object that guides generation.
`final VideoCreateParams.Body.Builder`	`inputReference(ImageInputReferenceParam imageInputReferenceParam)`	Alias for calling inputReference with `InputReference.ofImageInputReferenceParam(imageInputReferenceParam)`.
`final VideoCreateParams.Body.Builder`	`model(VideoModel model)`	The video generation model to use (allowed values: sora-2, sora-2-pro).
`final VideoCreateParams.Body.Builder`	`model(MultipartField<VideoModel> model)`	Sets Builder.model to an arbitrary multipart value.
`final VideoCreateParams.Body.Builder`	`model(String value)`	Sets model to an arbitrary String.
`final VideoCreateParams.Body.Builder`	`seconds(VideoSeconds seconds)`	Clip duration in seconds (allowed values: 4, 8, 12).
`final VideoCreateParams.Body.Builder`	`seconds(MultipartField<VideoSeconds> seconds)`	Sets Builder.seconds to an arbitrary multipart value.
`final VideoCreateParams.Body.Builder`	`size(VideoSize size)`	Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024).
`final VideoCreateParams.Body.Builder`	`size(MultipartField<VideoSize> size)`	Sets Builder.size to an arbitrary multipart value.
`final VideoCreateParams.Body.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final VideoCreateParams.Body.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final VideoCreateParams.Body.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final VideoCreateParams.Body.Builder`	`removeAdditionalProperty(String key)`
`final VideoCreateParams.Body.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final VideoCreateParams.Body`	`build()`	Returns an immutable instance of Body.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - prompt
```
 final VideoCreateParams.Body.Builder prompt(String prompt)
```
    Text prompt that describes the video to generate.
  - prompt
```
 final VideoCreateParams.Body.Builder prompt(MultipartField<String> prompt)
```
    Sets Builder.prompt to an arbitrary multipart value.
    You should usually call Builder.prompt with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - inputReference
```
 final VideoCreateParams.Body.Builder inputReference(VideoCreateParams.InputReference inputReference)
```
    Optional reference asset upload or reference object that guides generation.
  - inputReference
```
 final VideoCreateParams.Body.Builder inputReference(MultipartField<VideoCreateParams.InputReference> inputReference)
```
    Sets Builder.inputReference to an arbitrary multipart value.
    You should usually call Builder.inputReference with a well-typed InputReference value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - inputReference
```
 final VideoCreateParams.Body.Builder inputReference(InputStream stream)
```
    Alias for calling inputReference with InputReference.ofStream(stream).
  - inputReference
```
 final VideoCreateParams.Body.Builder inputReference(ByteArray stream)
```
    Optional reference asset upload or reference object that guides generation.
  - inputReference
```
 final VideoCreateParams.Body.Builder inputReference(Path path)
```
    Optional reference asset upload or reference object that guides generation.
  - inputReference
```
 final VideoCreateParams.Body.Builder inputReference(ImageInputReferenceParam imageInputReferenceParam)
```
    Alias for calling inputReference with InputReference.ofImageInputReferenceParam(imageInputReferenceParam).
  - model
```
 final VideoCreateParams.Body.Builder model(VideoModel model)
```
    The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults to sora-2.
  - model
```
 final VideoCreateParams.Body.Builder model(MultipartField<VideoModel> model)
```
    Sets Builder.model to an arbitrary multipart value.
    You should usually call Builder.model with a well-typed VideoModel value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - model
```
 final VideoCreateParams.Body.Builder model(String value)
```
    Sets model to an arbitrary String.
    You should usually call model with a well-typed VideoModel constant instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - seconds
```
 final VideoCreateParams.Body.Builder seconds(VideoSeconds seconds)
```
    Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.
  - seconds
```
 final VideoCreateParams.Body.Builder seconds(MultipartField<VideoSeconds> seconds)
```
    Sets Builder.seconds to an arbitrary multipart value.
    You should usually call Builder.seconds with a well-typed VideoSeconds value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - size
```
 final VideoCreateParams.Body.Builder size(VideoSize size)
```
    Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.
  - size
```
 final VideoCreateParams.Body.Builder size(MultipartField<VideoSize> size)
```
    Sets Builder.size to an arbitrary multipart value.
    You should usually call Builder.size with a well-typed VideoSize value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - additionalProperties
```
 final VideoCreateParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final VideoCreateParams.Body.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final VideoCreateParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final VideoCreateParams.Body.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final VideoCreateParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final VideoCreateParams.Body build()
```
    Returns an immutable instance of Body.
    Further updates to this Builder will not mutate the returned instance.
    The following fields are required:
    .prompt()

Class VideoCreateParams.Body.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

prompt

prompt

inputReference

inputReference

inputReference

inputReference

inputReference

inputReference

model

model

model

seconds

seconds

size

size

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build