useScreenShare

useScreenShare(params?): Object useScreenShare can also be used to set up optional callbacks for the local-screen-share-started and local-screen-share-stopped events.

Parameters (optional)

An object with the following properties:

onError

Function

Callback for the nonfatal-error event with type 'screen-share-error'.

Callback for the local-screen-share-started event.

Callback for the local-screen-share-stopped event.

Return value

An object with the following properties:

Indicates whether the local user is sharing a screen.

screens

Array

Array of screen share objects.

Show screens properties

audio

Object

Track state for associated screenAudio, see tracks properties for details.

local

boolean

Indicates if this is a local screen share.

screen_id

string

Unique identifier for the screen.

session_id

string

Unique identifier for the participant screen sharing.

video

Object

Track state for associated screenVideo, see tracks properties for details.

See startScreenShare().

See stopScreenShare().

{
  "isSharingScreen": false,
  "screens": [{
    "audio": <Object>,
    "local": true,
    "screen_id": "25bfe2e4-3a3d-4c6f-b877-392ce7c998e4-screen",
    "session_id": "25bfe2e4-3a3d-4c6f-b877-392ce7c998e4",
    "video": <Object>,
  }],
  "startScreenShare": <Function>,
  "stopScreenShare": <Function>,
}

Example

import { useScreenShare } from '@daily-co/daily-react';

export const UseScreenShareDemo = () => {
  const state = useScreenShare();

  return <div>Sharing Screen: {state?.isSharingScreen}</div>;
};

daily-js methods

Events

useRoomExp useSendSettings

Components

Hooks

useScreenShare

Parameters (optional)

Return value

Example

See also

daily-js methods

Events

​Parameters (optional)

​Return value

​Example

​See also

daily-js methods

Events

Parameters (optional)

Return value

Example

See also