Decode

Decode API.

type ApiDecodeFunction = (args: ApiDecodeRequest, opts?: ServerJobOptions) => Promise<DataOrError<(MediaResource|Decoding)>>

/**
 * Configuration options for the decode
 * endpoint of an Api.
 */
interface ApiDecodeOptions 
extends ApiCodeOptions {
  addResource?: boolean
  requestResource?: boolean
  updateResource?: boolean
}

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

interface CommandProbeFunction  {}

interface DecodeInfo  {
  decoding: Decoding
  raw: ProbeRawDecoded | ScanRawDecoded
}

interface DecodeOutputOptions  {}

interface DecodeProperties  {
  decoded?: UnknownRecord
}

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

interface ProbeDecoded 
extends UnknownRecord {
  alpha?: boolean
  audible?: boolean
  duration?: number
  extension?: string
  fps?: number
  height?: number
  width?: number
}

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

interface ProbingFormat  {
  duration?: number | undefined
  filename?: StringOrNot
  format_long_name?: StringOrNot
  probe_score?: number | undefined
  tags?: Record<string, (string|number)> | undefined
}

interface ProbingOptions 
extends DecodeOutputOptions {
  types?: Strings
}

interface ProbingStream 
extends UnknownRecord {
  codec_name?: StringOrNot
  codec_type?: StringOrNot
  duration?: StringOrNot
  height?: number | undefined
  pix_fmt?: StringOrNot
  rotation?: string | number | undefined
  width?: number | undefined
}

interface ScanDecoded 
extends UnknownRecord {
  family: string
}

interface Scanning 
extends Decoding {
  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 assertion for Decoding */
function assertDecoding(
  value: unknown
): void

/** Type assertion for Probing */
function assertProbing(
  value: unknown
): void

/** Type assertion for ProbingOptions */
function assertProbingOptions(
  value: unknown
): void

/** Type assertion for Scanning */
function assertScanning(
  value: unknown
): void

/** Type guard for Decoding */
function isDecoding(
  value: unknown
): boolean

/** Type guard for Probing */
function isProbing(
  value: unknown
): boolean

/** Type guard for ProbingOptions */
function isProbingOptions(
  value: unknown
): boolean

/** Type guard for Scanning */
function isScanning(
  value: unknown
): boolean