useRemoteScreenShare

The useRemoteScreenShare hook allows you to receive the media stream for another peer's screen being shared.

Name	Description	Return Type
videoStream	The video stream for remote peer's screen which is being shared. Null if screen not shared yet.	MediaStream \| null
audioStream	The audio stream for remote peer's screen which is being shared. Null if screen not shared yet.	MediaStream \| null
videoTrack	The video stream track for remote peer's screen which is being shared. Null if screen not shared yet.	MediaStreamTrack \| null
audioTrack	The audio stream track for remote peer's screen which is being shared. Null if screen not shared yet.	MediaStreamTrack \| null
state	State of the remote peer's screenshare stream.	"playable" \| "unavailable" \| "stopped" \| "paused" \| "available"

Example Usage

import { useRemoteScreenShare } from "@huddle01/react/hooks";
import { useEffect, useRef } from 'react';
 
const {
    videoStream,
    audioStream,
    videoTrack,
    audioTrack,
    state,
  } = useRemoteScreenShare({
    peerId: "remote-peer-id",
    onPlayable(data:{
    track: MediaStreamTrack;
    stream: MediaStream;
    label: 'screen-share-video' | 'screen-share-audio';
    }) {},
    onClose() {},
  });
 
const videoRef = useRef<HTMLVideoElement>(null);
const audioRef = useRef<HTMLAudioElement>(null);
 
useEffect(() => {
    if (videoStream && videoRef.current) {
      videoRef.current.srcObject = videoStream;
    }
    if (audioStream && audioRef.current) {
      audioRef.current.srcObject = audioStream;
    }
  }, [videoStream, audioStream]);
 
return (
    <div>
        <video ref={videoRef} autoPlay muted/>
        <audio ref={audioRef} autoPlay />
    </div>
);

Props

The useRemoteScreenShare hook accepts an object with the following fields as props.

peerId

Required

Description	Type
The peerId of the peer whose screenshare stream you want to consume.	string

Example Usage

const remoteScreenShare = useRemoteScreenShare({ peerId: "remote-peer-id" });

onPlayable

OptionalAdvanced

Description	Return Type
This function will be called when the other peer has started sharing their screen and it can now be played on your end.	void

Parameter Name	Type	Description	Required
data	{track: MediaStreamTrack; stream: MediaStream; label: 'share-video' \| 'share-audio';}	The data object containing the media stream and media stream track that can be played.	Yes

Example Usage

const remoteScreenShare = useRemoteScreenShare({ peerId: "remote-peer-id", onPlayable: (data) => {
	console.log("Ready to play remote peer's screen being shared!");
    // your code here
}});

onClose

OptionalAdvanced

Description	Return Type
This function will be called when the other peer stops sharing their screen.	void

Example Usage

const remoteScreenShare = useRemoteScreenShare({ peerId: "remote-peer-id", onClose: () => {
	console.log("Remote peer has stopped sharing their screen!");
    // your code here
}});

useRemoteAudio useDataMessage