Transcode

Transcode API.

type ApiTranscodeFunction = (args: ApiTranscodeRequest, opts?: ServerJobOptions) => Promise<DataOrError<(MediaResource|Transcoding)>>

/**
 * Configuration options for the transcode
 * endpoint of an Api.
 */
interface ApiTranscodeOptions 
extends ApiCodeOptions {
  addResource?: boolean
  requestResource?: boolean
  transcode?: false | Record<MediaType, Array<TranscodingSource>>
  updateResource?: boolean
  waveformTransparency?: Transparency
}

/**
 * A request for the transcode endpoint of
 * an Api.
 */
interface ApiTranscodeRequest 
extends CodeArgs {
  arg: RawStorableResource
  mediaId?: string
  opt?: object
  resourceId?: string
  source: TranscodingSource
}

interface BitmapsOutputOptions 
extends ImageOutputOptions {
  basename?: string
  extension?: string
  format?: string
  options?: ValueRecord
  videoBitrate?: Value
  videoCodec?: string
  videoRate?: number
}

type TranscodeOutputOptions = EncodeOutputOptions | WaveformOutputOptions | BitmapsOutputOptions

interface TranscodeProperties  {}

interface Transcoding 
extends StoredTranscode {
  bytes?: number
  createdAt?: number
  decoded?: UnknownRecord
  deletedAt?: number
  error?: NamedError
  extension: string
  id: string
  request?: EndpointRequest
  source: string
  storedAt?: number
  type: string
  updatedAt?: number
}

type TranscodingSource = MediaType | 'bitmaps' | 'waveform'

interface WaveformOutputOptions 
extends OutputOptions {
  basename?: string
  extension?: string
  format?: string
  options?: ValueRecord
}

/** Type guard for Transcoding */
function isTranscoding(
  value: unknown
): boolean