@snap/camera-kit
Version:
Camera Kit Web
27 lines • 1.04 kB
TypeScript
import type { CameraKitDeviceOptions } from "./CameraKitSource";
import { CameraKitSource } from "./CameraKitSource";
/**
* Video source options.
*
* @category Rendering
*/
export interface VideoSourceOptions extends CameraKitDeviceOptions {
/**
* Optional pre-computed tracking data to enhance rendering performance.
* While not commonly provided, this can be used in specific scenarios
* where such data is available to optimize video processing.
*/
trackingData: ArrayBuffer;
}
/**
* Create a {@link CameraKitSource} from an
* [HTMLVideoElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement).
*
* @param video CameraKit performs best when the source video is 720p – arbitrary resolutions are supported, but very
* high resolutions may not perform well.
* @param options Options.
*
* @category Rendering
*/
export declare function createVideoSource(video: HTMLVideoElement, options?: Partial<VideoSourceOptions>): CameraKitSource;
//# sourceMappingURL=VideoSource.d.ts.map