Skip to main content
Version: Next

Type Alias: UseScreenShareResult

UseScreenShareResult = Omit<ReturnType<typeof useScreenShareReactClient>, "stream" | "videoTrack" | "audioTrack" | "currentTracksMiddleware" | "setTracksMiddleware"> & object

Defined in: mobile-client/src/overrides/types.ts:81

Type declaration

audioTrack

audioTrack: MediaStreamTrack | null

currentTracksMiddleware

currentTracksMiddleware: TracksMiddleware | null

presentBroadcastPicker()

presentBroadcastPicker: () => Promise<void>

iOS only. Presents the system RPSystemBroadcastPickerView. When a broadcast is active, this opens the system "Stop Broadcast" sheet so the user can end it cleanly (via broadcastFinished()) and avoid the "Screen sharing stopped" error dialog that stopStreaming triggers by force-closing the host-side socket. No-op on non-iOS.

Returns

Promise<void>

setTracksMiddleware()

setTracksMiddleware: (middleware) => Promise<void>

Parameters

ParameterType
middlewareTracksMiddleware | null

Returns

Promise<void>

stream

stream: MediaStream | null

videoTrack

videoTrack: MediaStreamTrack | null