Class VideoCreateParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class VideoCreateParams implements Params
Create a video
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
VideoCreateParams.Builder
A builder for VideoCreateParams.
public final class
VideoCreateParams.Body
Parameters for creating a new video generation job.
-
Method Summary
Modifier and Type Method Description final String
prompt()
Text prompt that describes the video to generate. final Optional<InputStream>
inputReference()
Optional image reference that guides generation. final Optional<VideoModel>
model()
The video generation model to use. final Optional<VideoSeconds>
seconds()
Clip duration in seconds. final Optional<VideoSize>
size()
Output resolution formatted as width x height. final MultipartField<String>
_prompt()
Returns the raw multipart value of prompt. final MultipartField<InputStream>
_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>
_additionalBodyProperties()
final Headers
_additionalHeaders()
Additional headers to send with the request. final QueryParams
_additionalQueryParams()
Additional query param to send with the request. final VideoCreateParams.Builder
toBuilder()
final Map<String, MultipartField<?>>
_body()
Headers
_headers()
The full set of headers in the parameters, including both fixed and additional headers. QueryParams
_queryParams()
The full set of query params in the parameters, including both fixed and additional query params. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static VideoCreateParams.Builder
builder()
Returns a mutable builder for constructing an instance of VideoCreateParams. -
-
Method Detail
-
inputReference
final Optional<InputStream> inputReference()
Optional image reference that guides generation.
-
model
final Optional<VideoModel> model()
The video generation model to use. Defaults to
sora-2
.
-
seconds
final Optional<VideoSeconds> seconds()
Clip duration in seconds. Defaults to 4 seconds.
-
size
final Optional<VideoSize> size()
Output resolution formatted as width x height. 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<InputStream> _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.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final VideoCreateParams.Builder toBuilder()
-
_body
final Map<String, MultipartField<?>> _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static VideoCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of VideoCreateParams.
The following fields are required:
.prompt()
-
-
-
-