class

OpenAI::VideoResource

Inherits JSON::Serializable < Reference < Object

Structured information describing a generated video job.

Constructors

new(pull : JSON::PullParser)
Source
new(id : String = "", object : VideoResourceObject = VideoResourceObject::Video, model : VideoModel = VideoModel::Sora2, status : VideoStatus = VideoStatus::Queued, progress : Int64 = 0, created_at : Int64 = 0, completed_at : VideoResourceCompletedAt = nil, expires_at : VideoResourceExpiresAt = nil, prompt : VideoResourcePrompt = nil, size : VideoSize = VideoSize::N720X1280, seconds : VideoSeconds = VideoSeconds::N4, remixed_from_video_id : VideoResourceRemixedFromVideoId = nil, error : VideoResourceError = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

completed_at
Source
completed_at=(completed_at : VideoResourceCompletedAt)
Source
created_at

Unix timestamp (seconds) for when the job was created.

Source
created_at=(created_at : Int64)

Unix timestamp (seconds) for when the job was created.

Source
error
Source
error=(error : VideoResourceError)
Source
expires_at
Source
expires_at=(expires_at : VideoResourceExpiresAt)
Source
id

Unique identifier for the video job.

Source
id=(id : String)

Unique identifier for the video job.

Source
model

The video generation model that produced the job.

Source
model=(model : VideoModel)

The video generation model that produced the job.

Source
object

The object type, which is always video.

Source
object=(object : VideoResourceObject)

The object type, which is always video.

Source
progress

Approximate completion percentage for the generation task.

Source
progress=(progress : Int64)

Approximate completion percentage for the generation task.

Source
prompt
Source
prompt=(prompt : VideoResourcePrompt)
Source
remixed_from_video_id
Source
remixed_from_video_id=(remixed_from_video_id : VideoResourceRemixedFromVideoId)
Source
seconds

Duration of the generated clip in seconds.

Source
seconds=(seconds : VideoSeconds)

Duration of the generated clip in seconds.

Source
size

The resolution of the generated video.

Source
size=(size : VideoSize)

The resolution of the generated video.

Source
status

Current lifecycle status of the video job.

Source
status=(status : VideoStatus)

Current lifecycle status of the video job.

Source