Interface Task

Optional export?: { ipfs?: ExportToIPFSOutput }

• Optional ipfs?: ExportToIPFSOutput

Optional import?: { assetSpec?: Asset; metadataFilePath?: string; videoFilePath?: string }

• [k: string]: unknown

• Optional assetSpec?: Asset

• Optional metadataFilePath?: string

• Optional videoFilePath?: string

Optional transcode?: { asset?: { assetSpec?: { createdAt?: number; deleted?: boolean; downloadUrl?: string; hash?: { algorithm?: string; hash?: string }[]; id?: string; meta?: {}; name: string; objectStoreId?: string; playbackId?: string; size?: number; sourceAssetId?: string; status?: "waiting" | "ready" | "failed"; type?: "video" | "audio"; updatedAt?: number; userId?: string; videoSpec?: { bitrate?: number; duration?: number; format?: string; tracks?: { bitDepth?: number; bitrate?: number; channels?: number; codec: string; duration?: number; fps?: number; height?: number; pixelFormat?: string; sampleRate?: number; startTime?: number; type: "video" | "audio"; width?: number }[] } }; metadataFilePath?: string; videoFilePath?: string } }

• Optional asset?: { assetSpec?: { createdAt?: number; deleted?: boolean; downloadUrl?: string; hash?: { algorithm?: string; hash?: string }[]; id?: string; meta?: {}; name: string; objectStoreId?: string; playbackId?: string; size?: number; sourceAssetId?: string; status?: "waiting" | "ready" | "failed"; type?: "video" | "audio"; updatedAt?: number; userId?: string; videoSpec?: { bitrate?: number; duration?: number; format?: string; tracks?: { bitDepth?: number; bitrate?: number; channels?: number; codec: string; duration?: number; fps?: number; height?: number; pixelFormat?: string; sampleRate?: number; startTime?: number; type: "video" | "audio"; width?: number }[] } }; metadataFilePath?: string; videoFilePath?: string }

  • [k: string]: unknown

  • Optional assetSpec?: { createdAt?: number; deleted?: boolean; downloadUrl?: string; hash?: { algorithm?: string; hash?: string }[]; id?: string; meta?: {}; name: string; objectStoreId?: string; playbackId?: string; size?: number; sourceAssetId?: string; status?: "waiting" | "ready" | "failed"; type?: "video" | "audio"; updatedAt?: number; userId?: string; videoSpec?: { bitrate?: number; duration?: number; format?: string; tracks?: { bitDepth?: number; bitrate?: number; channels?: number; codec: string; duration?: number; fps?: number; height?: number; pixelFormat?: string; sampleRate?: number; startTime?: number; type: "video" | "audio"; width?: number }[] } }

    • Optional createdAt?: number

      Timestamp (in milliseconds) at which asset was created

    • Optional deleted?: boolean

      Set to true when the asset is deleted

    • Optional downloadUrl?: string

      URL to manually download the asset if desired

    • Optional hash?: { algorithm?: string; hash?: string }[]

      Hash of the asset

    • Optional id?: string

    • Optional meta?: {}

      User input metadata associated with the asset

      • [k: string]: string

    • name: string

      Name of the asset. This is not necessarily the filename, can be a custom name or title

    • Optional objectStoreId?: string

      Object store ID where the asset is stored

    • Optional playbackId?: string

      Used to form playback URL and storage folder

    • Optional size?: number

      Size of the asset in bytes

    • Optional sourceAssetId?: string

      ID of the source asset (root) - If missing, this is a root asset

    • Optional status?: "waiting" | "ready" | "failed"

      Status of the asset

    • Optional type?: "video" | "audio"

      Type of the asset.

    • Optional updatedAt?: number

      Timestamp (in milliseconds) at which the asset was last updated

    • Optional userId?: string

      owner of the asset

    • Optional videoSpec?: { bitrate?: number; duration?: number; format?: string; tracks?: { bitDepth?: number; bitrate?: number; channels?: number; codec: string; duration?: number; fps?: number; height?: number; pixelFormat?: string; sampleRate?: number; startTime?: number; type: "video" | "audio"; width?: number }[] }

      Video metadata

      • Optional bitrate?: number

        Bitrate of the video in bits per second

      • Optional duration?: number

        Duration of the asset in seconds (float)

      • Optional format?: string

        Format of the asset

      • Optional tracks?: { bitDepth?: number; bitrate?: number; channels?: number; codec: string; duration?: number; fps?: number; height?: number; pixelFormat?: string; sampleRate?: number; startTime?: number; type: "video" | "audio"; width?: number }[]

        List of tracks associated with the asset when the format contemplates them (e.g. mp4)

  • Optional metadataFilePath?: string

  • Optional videoFilePath?: string

Optional export?: { custom: { headers?: {}; method?: string; url: string } } | { ipfs: { nftMetadata?: {}; pinata?: { jwt: string } | { apiKey: string; apiSecret: string } } }

Optional import?: { uploadedObjectKey?: string; url?: string }

• Optional uploadedObjectKey?: string

  S3 object key of the uploaded asset

• Optional url?: string

  URL of the asset to import

Optional transcode?: { profile?: FfmpegProfile }

• Optional profile?: FfmpegProfile

Optional errorMessage?: string

Optional phase?: "waiting" | "failed" | "pending" | "running" | "completed" | "cancelled"

Optional progress?: number

Optional updatedAt?: number