Function useMediaStreamBuilder

Creates a media stream builder that provides functionality to capture audio, video, and screen using the WebRTC API.

  • useMediaStreamBuilder(params?): {
        hasAudioCapture: boolean;
        hasCameraCapture: boolean;
        hasScreenCapture: boolean;
        mediaStream: MediaStream;
        requestAudioCapture: (() => Promise<void>);
        requestCameraCapture: (() => Promise<void>);
        requestScreenCapture: (() => Promise<void>);
        stopAudioCapture: (() => void);
        stopCameraCapture: (() => void);
        stopScreenCapture: (() => void);
    }

  • Parameters

    • Optionalparams: IParams = {}

      The parameters for the media stream builder.

    Returns {
        hasAudioCapture: boolean;
        hasCameraCapture: boolean;
        hasScreenCapture: boolean;
        mediaStream: MediaStream;
        requestAudioCapture: (() => Promise<void>);
        requestCameraCapture: (() => Promise<void>);
        requestScreenCapture: (() => Promise<void>);
        stopAudioCapture: (() => void);
        stopCameraCapture: (() => void);
        stopScreenCapture: (() => void);
    }

    The media stream builder.

    • hasAudioCapture: boolean
    • hasCameraCapture: boolean
    • hasScreenCapture: boolean
    • mediaStream: MediaStream
    • requestAudioCapture: (() => Promise<void>)
        • (): Promise<void>

        • Returns Promise<void>

    • requestCameraCapture: (() => Promise<void>)
        • (): Promise<void>

        • Returns Promise<void>

    • requestScreenCapture: (() => Promise<void>)
        • (): Promise<void>

        • Returns Promise<void>

    • stopAudioCapture: (() => void)
        • (): void

        • Returns void

    • stopCameraCapture: (() => void)
        • (): void

        • Returns void

    • stopScreenCapture: (() => void)
        • (): void

        • Returns void

Settings

Member Visibility