Interface ITranscodeProvider

Contract implemented by custom transcode providers used by the SDK.

interface ITranscodeProvider {
    destroy(): Promise<void>;
    init(): Promise<void>;
    supportsInput(mediaMetadata: TranscodeMediaDetails): Promise<boolean>;
    supportsInputURL(): Promise<boolean>;
    supportsOutput(outputType: TranscodeSupportType): Promise<boolean>;
    transcode(
        source: Uint8Array<ArrayBufferLike> | URL,
        mediaMetadata: TranscodeMediaDetails,
        outputType: TranscodeSupportType,
        control: TranscodeControl,
        progressCallback?: (progressInfo: TranscodeProgressInfo) => void,
    ): Promise<null | TranscodeResult>;
}

Index

Methods

destroy init supportsInput supportsInputURL supportsOutput transcode

Methods

destroy

destroy(): Promise<void>
Releases all resources owned by the provider.

Returns Promise<void>
A promise that resolves after teardown completes.

init

init(): Promise<void>
Initializes the provider and allocates any runtime resources it needs.

Returns Promise<void>
A promise that resolves after initialization completes.

supportsInput

supportsInput(mediaMetadata: TranscodeMediaDetails): Promise<boolean>
Indicates whether the provider can transcode the supplied source media.
Parameters
- mediaMetadata: TranscodeMediaDetails
  Source media details used for capability checks.
Returns Promise<boolean>
A promise that resolves to true if the provider can accept the input.

supportsInputURL

supportsInputURL(): Promise<boolean>
Indicates whether the provider can transcode media using only a URL reference.

Returns Promise<boolean>
A promise that resolves to true if URL-only inputs are supported.

supportsOutput

supportsOutput(outputType: TranscodeSupportType): Promise<boolean>
Indicates whether the provider can produce the requested output format.
Parameters
- outputType: TranscodeSupportType
  Requested output format description.
Returns Promise<boolean>
A promise that resolves to true if the output is supported.

transcode

transcode(
    source: Uint8Array<ArrayBufferLike> | URL,
    mediaMetadata: TranscodeMediaDetails,
    outputType: TranscodeSupportType,
    control: TranscodeControl,
    progressCallback?: (progressInfo: TranscodeProgressInfo) => void,
): Promise<null | TranscodeResult>
Transcodes source media into a supported output format.
Parameters
- source: Uint8Array<ArrayBufferLike> | URL
  Source media bytes or URL.
- mediaMetadata: TranscodeMediaDetails
  Source media details used during transcoding.
- outputType: TranscodeSupportType
  Requested output format description.
- control: TranscodeControl
  Mutable control object used to signal cancellation.
- OptionalprogressCallback: (progressInfo: TranscodeProgressInfo) => void
  Optional callback that receives normalized progress updates.
Returns Promise<null | TranscodeResult>
A promise that resolves to the transcoded output, or null if transcoding is canceled or fails cleanly.