Utilities related to the API
Interfaces
AudioOutputOptions
Extends OutputOptions. Extended by VideoOutputOptions.
| Property | Type |
|---|---|
audioBitrate? | Value |
audioChannels? | number |
audioCodec? | string |
audioRate? | number |
extension? | string |
format? | string |
options? | ValueRecord |
ImageOutputOptions
Extends Partial<Size>.OutputOptions. Extended by SequenceOutputOptions and VideoOutputOptions.
| Property | Type |
|---|---|
extension? | string |
format? | string |
height? | number |
options? | ValueRecord |
videoBitrate? | Value |
videoCodec? | string |
videoRate? | number |
width? | number |
JobArgs
Extended by DecodeArgs, EncodeArgs, and TranscodeArgs.
| Property | Type |
|---|---|
arg | Storable |
insertResource? | boolean |
opt? | object |
requestResource? | boolean |
updateResource? | boolean |
JobOptions
Extends UnknownRecord.
| Property | Type |
|---|---|
count? | number |
id? | string |
progress? | ServerProgress |
request? | string | EndpointRequest |
user? | string |
validDirectories? | `/${string}`[] |
JobProduct
| Property | Type |
|---|---|
created_at? | string |
id? | string |
type | string |
updated_at? | string |
OutputOptions
Extended by WaveformOutputOptions, AudioOutputOptions, and ImageOutputOptions.
Indexable
[_: string]: string | Value | ValueRecord | undefined
| Property | Type |
|---|---|
extension? | string |
format? | string |
options? | ValueRecord |
SequenceOutputOptions
Extends ImageOutputOptions.
| Property | Type |
|---|---|
extension? | string |
format? | string |
height? | number |
options? | ValueRecord |
videoBitrate? | Value |
videoCodec? | string |
videoRate? | number |
width? | number |
VideoOutputOptions
Extends ImageOutputOptions.AudioOutputOptions.
| Property | Type |
|---|---|
audioBitrate? | Value |
audioChannels? | number |
audioCodec? | string |
audioRate? | number |
extension? | string |
format? | string |
height? | number |
options? | ValueRecord |
videoBitrate? | Value |
videoCodec? | string |
videoRate? | number |
width? | number |
Type Aliases
JobType
JobType:
_decode|_encode|_transcode
OutputAlphaOptionsFunction
OutputAlphaOptionsFunction: (
type,overrides?) =>ImageOutputOptions(type,overrides?) =>SequenceOutputOptions(type,overrides?) =>VideoOutputOptions(type,overrides?) =>OutputOptions
| Parameter | Type |
|---|---|
type | "image" |
overrides? | OutputOptions |
Returns ImageOutputOptions.
| Parameter | Type |
|---|---|
type | "bitmaps" |
overrides? | OutputOptions |
Returns SequenceOutputOptions.
| Parameter | Type |
|---|---|
type | "video" |
overrides? | OutputOptions |
Returns VideoOutputOptions.
| Parameter | Type |
|---|---|
type | AlphaType |
overrides? | OutputOptions |
Returns OutputOptions.
OutputOptionsFunction
OutputOptionsFunction: (
type,overrides?) =>AudioOutputOptions(type,overrides?) =>ImageOutputOptions(type,overrides?) =>SequenceOutputOptions(type,overrides?) =>VideoOutputOptions(type,overrides?) =>WaveformOutputOptions(type,overrides?) =>OutputOptions
| Parameter | Type |
|---|---|
type | "audio" |
overrides? | OutputOptions |
Returns AudioOutputOptions.
| Parameter | Type |
|---|---|
type | "image" |
overrides? | OutputOptions |
Returns ImageOutputOptions.
| Parameter | Type |
|---|---|
type | "bitmaps" |
overrides? | OutputOptions |
Returns SequenceOutputOptions.
| Parameter | Type |
|---|---|
type | "video" |
overrides? | OutputOptions |
Returns VideoOutputOptions.
| Parameter | Type |
|---|---|
type | "waveform" |
overrides? | OutputOptions |
Returns WaveformOutputOptions.
| Parameter | Type |
|---|---|
type | TranscodingSource |
overrides? | OutputOptions |
Returns OutputOptions.
Variables
$status
const$status:"status"
Functions
apiRequest
apiRequest(
apiId,endpointId):DataOrError<EndpointRequest>
| Parameter | Type |
|---|---|
apiId | string |
endpointId | string |
Returns DataOrError<EndpointRequest>.
jobGetStatus
jobGetStatus(
id):Promise<DataOrError<Typed|Date>>
| Parameter | Type |
|---|---|
id | string |
Returns Promise<DataOrError<Typed | Date>>.
jobHasErrored
jobHasErrored(
id,json?):Promise<DataOrError<string>>
| Parameter | Type |
|---|---|
id | string |
json? | any |
Returns Promise<DataOrError<string>>.
jobHasFinished
jobHasFinished(
id,json?):Promise<DataOrError<string>>
| Parameter | Type |
|---|---|
id | string |
json? | JobProduct |
Returns Promise<DataOrError<string>>.
jobHasStarted
jobHasStarted(
id,json?):Promise<DataOrError<string>>
| Parameter | Type |
|---|---|
id | string |
json? | any |
Returns Promise<DataOrError<string>>.
pathOutputFilename
pathOutputFilename(
outputOptions,encodingType,ext?):string
| Parameter | Type |
|---|---|
outputOptions | OutputOptions |
encodingType | string |
ext? | string |
Returns string.
statusAsync
statusAsync(
identified):Promise<DataOrError<Identified|Typed>>
| Parameter | Type |
|---|---|
identified | Identified |
Returns Promise<DataOrError<Identified | Typed>>.
typeOutputAlphaOptions
typeOutputAlphaOptions(type, overrides)
typeOutputAlphaOptions(
type,overrides?):ImageOutputOptions
| Parameter | Type |
|---|---|
type | "image" |
overrides? | OutputOptions |
Returns ImageOutputOptions.
typeOutputAlphaOptions(type, overrides)
typeOutputAlphaOptions(
type,overrides?):SequenceOutputOptions
| Parameter | Type |
|---|---|
type | "bitmaps" |
overrides? | OutputOptions |
Returns SequenceOutputOptions.
typeOutputAlphaOptions(type, overrides)
typeOutputAlphaOptions(
type,overrides?):VideoOutputOptions
| Parameter | Type |
|---|---|
type | "video" |
overrides? | OutputOptions |
Returns VideoOutputOptions.
typeOutputAlphaOptions(type, overrides)
typeOutputAlphaOptions(
type,overrides?):OutputOptions
| Parameter | Type |
|---|---|
type | AlphaType |
overrides? | OutputOptions |
Returns OutputOptions.
typeOutputOptions
typeOutputOptions(type, overrides)
typeOutputOptions(
type,overrides?):AudioOutputOptions
| Parameter | Type |
|---|---|
type | "audio" |
overrides? | OutputOptions |
Returns AudioOutputOptions.
typeOutputOptions(type, overrides)
typeOutputOptions(
type,overrides?):ImageOutputOptions
| Parameter | Type |
|---|---|
type | "image" |
overrides? | OutputOptions |
Returns ImageOutputOptions.
typeOutputOptions(type, overrides)
typeOutputOptions(
type,overrides?):SequenceOutputOptions
| Parameter | Type |
|---|---|
type | "bitmaps" |
overrides? | OutputOptions |
Returns SequenceOutputOptions.
typeOutputOptions(type, overrides)
typeOutputOptions(
type,overrides?):VideoOutputOptions
| Parameter | Type |
|---|---|
type | "video" |
overrides? | OutputOptions |
Returns VideoOutputOptions.
typeOutputOptions(type, overrides)
typeOutputOptions(
type,overrides?):WaveformOutputOptions
| Parameter | Type |
|---|---|
type | "waveform" |
overrides? | OutputOptions |
Returns WaveformOutputOptions.
typeOutputOptions(type, overrides)
typeOutputOptions(
type,overrides?):OutputOptions
| Parameter | Type |
|---|---|
type | TranscodingSource |
overrides? | OutputOptions |
Returns OutputOptions.