Interface IRealtimeFrameSampler

A frame sampler a host supplies through IRealtimeMediaHost.CreateFrameSampler. FrameSampler from @memberjunction/ai-realtime-client/media is one.

interface IRealtimeFrameSampler {
Start(): boolean;
Stop(): void;
}

Index

Methods

Methods

Start

Start(): boolean
Starts taking frames.

Returns boolean
false when the sampler cannot take frames on this platform; the runtime then fails the capture.
- Defined in packages/RealtimeRuntime/src/hosts/IRealtimeMediaHost.ts:140

Stop

Stop(): void
Stops taking frames and releases what the sampler holds. Never stops the stream's tracks.

Returns void
- Defined in packages/RealtimeRuntime/src/hosts/IRealtimeMediaHost.ts:143