Class SoraVideoJob

Inheritance
object
SoraVideoJob
Implements
Inherited Members
Namespace: Glitch9.AIDevKit.OpenAI
Assembly: Glitch9.AIDevKit.Provider.OpenAI.dll
Syntax
public class SoraVideoJob : IProgressPollingJob, IPollingJob, IDeletionStatus

Properties

| Edit this page View Source

CompletedAt

Optional. Unix timestamp (seconds) for when the job completed, if finished.

Declaration
[JsonProperty("completed_at")]
public UnixTime? CompletedAt { get; set; }
Property Value
Type Description
UnixTime?
| Edit this page View Source

CreatedAt

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

Declaration
[JsonProperty("created_at")]
public UnixTime CreatedAt { get; set; }
Property Value
Type Description
UnixTime
| Edit this page View Source

Error

Optional. Error payload that explains why generation failed, if applicable.

Declaration
[JsonProperty("error")]
public SoraVideoJob.SoraError Error { get; set; }
Property Value
Type Description
SoraVideoJob.SoraError
| Edit this page View Source

ExpiresAt

Optional. Unix timestamp (seconds) for when the downloadable assets expire, if set.

Declaration
[JsonProperty("expires_at")]
public UnixTime? ExpiresAt { get; set; }
Property Value
Type Description
UnixTime?
| Edit this page View Source

Id

Required. Unique identifier for the video job.

Declaration
[JsonProperty("id")]
public string Id { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Model

Required. The video generation model that produced the job.

Declaration
[JsonProperty("model")]
public string Model { get; set; }
Property Value
Type Description
string
| Edit this page View Source

ObjectType

Required. The object type, which is always video.

Declaration
[JsonProperty("object")]
public string ObjectType { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Progress

Optional. Approximate completion percentage for the generation task.

Declaration
[JsonProperty("progress")]
public int? Progress { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

RemixedFromVideoId

Optional. Identifier of the source video if this video is a remix.

Declaration
[JsonProperty("remixed_from_video_id")]
public string RemixedFromVideoId { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Seconds

Required. Duration of the generated clip in seconds.

Declaration
[JsonProperty("seconds")]
public string Seconds { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Size

Required. The resolution of the generated video.

Declaration
[JsonProperty("size")]
public string Size { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Status

Required. Current lifecycle status of the video job.

Declaration
[JsonProperty("status")]
public string Status { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

IsCompleted()

Declaration
public bool IsCompleted()
Returns
Type Description
bool
| Edit this page View Source

IsDeleted()

Declaration
public bool IsDeleted()
Returns
Type Description
bool
| Edit this page View Source

TryGetError(out string)

Declaration
public bool TryGetError(out string error)
Parameters
Type Name Description
string error
Returns
Type Description
bool

Implements

Extension Methods