Skip to main content

Type Alias: UseScreenshareResult

UseScreenshareResult: object

Type declaration​

audioBroadcast​

audioBroadcast: Track | null

audioTrack​

audioTrack: MediaStreamTrack | null

currentTracksMiddleware​

currentTracksMiddleware: TracksMiddleware | null

setTracksMiddleware()​

setTracksMiddleware: (middleware) => Promise<void>

Parameters​

ParameterType
middlewareTracksMiddleware | null

Returns​

Promise<void>

startStreaming()​

startStreaming: (props?) => Promise<void>

Parameters​

ParameterType
props?{ audioConstraints: boolean | MediaTrackConstraints; videoConstraints: boolean | MediaTrackConstraints; }
props.audioConstraints?boolean | MediaTrackConstraints
props.videoConstraints?boolean | MediaTrackConstraints

Returns​

Promise<void>

stopStreaming()​

stopStreaming: () => Promise<void>

Returns​

Promise<void>

stream​

stream: MediaStream | null

videoBroadcast​

videoBroadcast: Track | null

videoTrack​

videoTrack: MediaStreamTrack | null

Defined in​

packages/react-client/src/hooks/useScreenShare.ts:9