Interface VideoFrameDecoderRegistration

One decoder the registry can create.

interface VideoFrameDecoderRegistration {
    Kind: RealtimeVideoFrameKind;
    Name: string;
    Priority: number;
    CanPlay(mimeType: string): boolean;
    Create(context: VideoFrameDecoderContext): IVideoFrameDecoder;
}

Index

Properties

Kind Name Priority

Methods

Properties

Kind

Kind: RealtimeVideoFrameKind

The kind of frame it plays.

Name

Name: string

Its name, unique in the registry: registering the same name again replaces it. Built in: 'mse-fmp4', 'webcodecs', 'image'.

Priority

Priority: number

Among the decoders that can play a type, a higher priority is tried first. The built-ins have 0.

Methods

CanPlay

CanPlay(mimeType: string): boolean
Whether it can play frames of this MIME type in this browser, answered at once. A decoder whose exact answer needs an asynchronous check answers from what it can see now, and calls Failed later if the check says no.
Parameters
- mimeType: string
Returns boolean
- Defined in packages/AI/RealtimeClient/src/media/videoFrameDecoder.ts:85

Create

Create(context: VideoFrameDecoderContext): IVideoFrameDecoder
A new decoder, for one player.
Parameters
- context: VideoFrameDecoderContext
Returns IVideoFrameDecoder
- Defined in packages/AI/RealtimeClient/src/media/videoFrameDecoder.ts:87