Function useStreamApplyVideoProcessor

  • This hook takes stream passed as parameter, and returns either this stream or a stream with video processor applied. This is controlled by the videoProcessorType input attribute. By default the output stream is the input stream. The hook fully manages the output stream (applies 'none' if input stream is set to undefined). The hook never releases the input stream.

    Returns

    new stream with video processor applied (or original stream if no processor applied)

    Parameters

    • stream: undefined | Stream
    • processorType: "none" | "blur" | "backgroundImage"
    • Optional options: VideoProcessorOptions
    • Optional errorCallback: ((error: any) => void)
        • (error: any): void

        • Parameters

          • error: any

          Returns void

    Returns {
        applied: any;
        applying: boolean;
        error: any;
        stream: undefined | Stream;
    }

    • applied: any
    • applying: boolean
    • error: any
    • stream: undefined | Stream

Settings

Member Visibility

Theme

Generated using TypeDoc