VideosResource class
Resource for video generation operations (Sora).
Videos are generated using Sora, OpenAI's video generation model.
Access this resource through OpenAIClient.videos.
Example
// Create a video
final video = await client.videos.create(
CreateVideoRequest(
prompt: 'A cat playing piano in a jazz club',
model: 'sora-2',
size: VideoSize.size1280x720,
seconds: VideoSeconds.s8,
),
);
// Check status
while (!video.isCompleted && !video.isFailed) {
await Future.delayed(Duration(seconds: 10));
video = await client.videos.retrieve(video.id);
print('Progress: ${video.progress}%');
}
// Download content
if (video.isCompleted) {
final content = await client.videos.retrieveContent(video.id);
File('video.mp4').writeAsBytesSync(content);
}
- Inheritance
-
- Object
- ResourceBase
- VideosResource
Constructors
- VideosResource({required OpenAIConfig config, required Client httpClient, required InterceptorChain interceptorChain, required RequestBuilder requestBuilder, void ensureNotClosed()?})
- Creates a VideosResource.
Properties
- config → OpenAIConfig
-
Client configuration.
finalinherited
- ensureNotClosed → void Function()?
-
Callback to check if the client has been closed.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- httpClient → Client
-
HTTP client for making requests.
finalinherited
- interceptorChain → InterceptorChain
-
Interceptor chain for request/response processing.
finalinherited
- requestBuilder → RequestBuilder
-
Request builder for constructing HTTP requests.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- streamClientFactory → Client Function()?
-
Factory for creating dedicated HTTP clients for streaming requests.
finalinherited
Methods
-
create(
CreateVideoRequest request) → Future< Video> - Creates a new video generation job.
-
createEdit(
CreateVideoEditRequest request) → Future< Video> - Creates a new video edit from an existing video.
-
createExtension(
CreateVideoExtendRequest request) → Future< Video> - Creates an extension of a completed video.
-
delete(
String videoId) → Future< DeleteVideoResponse> - Deletes a video.
-
list(
{int? limit, String? order, String? after, String? before}) → Future< VideoList> - Lists all video generation jobs.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
remix(
String videoId, CreateVideoRemixRequest request) → Future< Video> - Creates a remix of an existing video.
-
retrieve(
String videoId) → Future< Video> - Retrieves a video generation job.
-
retrieveCharacter(
String characterId) → Future< VideoCharacter> - Retrieves a video character.
-
retrieveContent(
String videoId, {VideoContentVariant? variant}) → Future< Uint8List> - Retrieves the content of a completed video.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited