Method request_stream

core/src/stdlib/pyscript/media.py:120–168

Request a media stream with the specified constraints. This is a class method that requests access to media devices matching the given `audio` and `video` constraints. The browser will prompt the user for permission if needed and return a `MediaStream` object that

(cls, audio=False, video=True)

    @classmethod
    async def request_stream(cls, audio=False, video=True):
        """
        Request a media stream with the specified constraints.

        This is a class method that requests access to media devices matching
        the given `audio` and `video` constraints. The browser will prompt the
        user for permission if needed and return a `MediaStream` object that
        can be assigned to video/audio elements.

        Simple boolean constraints for `audio` and `video` can be used to
        request default devices. More complex constraints can be specified as
        dictionaries conforming to
        [the MediaTrackConstraints interface](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints).

        ```python
        from pyscript import document
        from pyscript.media import Device


        # Get default video stream.
        stream = await Device.request_stream()

        # Get stream with specific constraints.
        stream = await Device.request_stream(
            video={"width": 1920, "height": 1080}
        )

        # Get audio and video.
        stream = await Device.request_stream(audio=True, video=True)

        # Use the stream.
        video_el = document.getElementById("camera")
        video_el.srcObject = stream
        ```

        This method will trigger a browser permission dialog on first use.
        """
        options = {}
        if isinstance(audio, bool):
            options["audio"] = audio
        elif isinstance(audio, dict):
            # audio is a dict of constraints (sampleRate, echoCancellation etc...).
            options["audio"] = audio
        if isinstance(video, bool):
            options["video"] = video
        elif isinstance(video, dict):
            # video is a dict of constraints (width, height etc...).
            options["video"] = video
        return await window.navigator.mediaDevices.getUserMedia(to_js(options))

    @classmethod
    async def load(cls, audio=False, video=True):