TeaWeb/shared/js/video/VideoSource.ts

import {Registry} from "tc-shared/events";
import { tr } from "tc-shared/i18n/localize";

export interface VideoSourceCapabilities {
    minWidth: number,
    maxWidth: number,

    minHeight: number,
    maxHeight: number,

    minFrameRate: number,
    maxFrameRate: number
}

export interface VideoSourceInitialSettings {
    width: number | 0,
    height: number | 0,
    frameRate: number
}

export interface VideoSource {
    getId() : string;
    getName() : string;

    getStream() : MediaStream;
    getCapabilities() : VideoSourceCapabilities;
    getInitialSettings() : VideoSourceInitialSettings;

    /** Add a new reference to this stream */
    ref() : this;

    /** Decrease the reference count. If it's zero, it will be automatically destroyed. */
    deref();
}

export enum VideoPermissionStatus {
    Granted,
    UserDenied,
    SystemDenied
}

export interface VideoDriverEvents {
    notify_permissions_changed: { oldStatus: VideoPermissionStatus, newStatus: VideoPermissionStatus },
    notify_device_list_changed: { devices: string[] }
}

export type VideoDevice = { id: string, name: string }
export type ScreenCaptureDevice = {
    id: string,
    name: string,

    type: "full-screen" | "window",

    appIcon?: string,
    appPreview?: string
}

export interface VideoDriver {
    getEvents() : Registry<VideoDriverEvents>;
    getPermissionStatus() : VideoPermissionStatus;

    /**
     * Request permissions to access the video camara and device list.
     * When requesting permissions, we're actually requesting a media stream.
     * If the request succeeds, we're returning that media stream.
     */
    requestPermissions() : Promise<VideoSource | boolean>;
    getDevices() : Promise<VideoDevice[] | false>;

    /**
     * @throws a string if an error occurs
     * @returns A VideoSource on success with an initial ref count of one
     * Will throw a string on error
     */
    createVideoSource(id: string | undefined) : Promise<VideoSource>;

    screenQueryAvailable() : boolean;

    queryScreenCaptureDevices() : Promise<ScreenCaptureDevice[]>;

    /**
     * Create a source from the screen
     */
    createScreenSource(id: string | undefined, allowFocusLoss: boolean) : Promise<VideoSource>;
}

let driverInstance: VideoDriver;
export function getVideoDriver() {
    return driverInstance;
}

export function setVideoDriver(driver: VideoDriver) {
    if(typeof driverInstance !== "undefined") {
        throw tr("A video driver has already be initiated");
    }

    driverInstance = driver;
}