Function: useScreenShare()

useScreenShare(): object

Defined in: packages/react-native-client/src/hooks/useScreenShare.ts:42

This hook can toggle screen sharing on/off and provides current screen share state.

Returns

object

An object with functions to manage screen share.

handleScreenSharePermission()

handleScreenSharePermission: () => Promise<"granted" | "denied">

Returns

Promise<"granted" | "denied">

isScreenShareOn

isScreenShareOn: boolean

simulcastConfig

simulcastConfig: SimulcastConfig

toggleScreenShare()

toggleScreenShare: (screenShareOptions) => Promise<void>

Toggles the screen share on/off Emits warning on ios when user is screensharing app screen.

Parameters

Parameter	Type
screenShareOptions	Partial<ScreenShareOptions>

Returns

Promise<void>