usePresentation

function usePresentation(__namedParameters): object;

Parameters

Parameter	Type
__namedParameters	{ getPresentationCapability: { send: boolean; recv: boolean; }; handlaGetDisplayMediaError?: (error) => void; handleGetDisplayMedia: (constraints?) => Promise<MediaStream | undefined>; isCallRestarting?: () => boolean; present: (stream) => void; presentationConnectionStateChangeSignal: Signal<{ send: RTCPeerConnectionState; recv: RTCPeerConnectionState; }>; presentationPresenterNameSignal?: Signal<string, string>; presentationReceiveStreamSignal: Signal<MediaStream>; stopPresentation: () => void; }
__namedParameters.getPresentationCapability
__namedParameters.handlaGetDisplayMediaError?	(error) => void
__namedParameters.handleGetDisplayMedia	(constraints?) => Promise<MediaStream | undefined>
__namedParameters.isCallRestarting?	() => boolean
__namedParameters.present	(stream) => void
__namedParameters.presentationConnectionStateChangeSignal	Signal<{ send: RTCPeerConnectionState; recv: RTCPeerConnectionState; }>
__namedParameters.presentationPresenterNameSignal?	Signal<string, string>
__namedParameters.presentationReceiveStreamSignal	Signal<MediaStream>
__namedParameters.stopPresentation	() => void

Returns

object

Name	Type
emphasis	| PresentationEmphasis | undefined
isPrimaryExpanded	boolean
isShowSteal	boolean
isPresenting	boolean
size	PresentationSize | undefined
localIsPresenting	boolean
localMediaStream	MediaStream | undefined
remoteIsPresenting	boolean
remoteMediaStream	MediaStream | undefined
activity	| PresentationActivityState | undefined
presenterName	string | undefined
handlePresentationRequest()	() => void
setEmphasis()	(emphasis) => void
setExpandPrimary()	(expandPrimary) => void
setShowSteal()	(showSteal) => void
setSize()	(size) => void
startPresentation()	(mediaStream?) => Promise<void>
stopPresentation()	() => void
poppedOut	object
poppedOut.isPresentationPoppedOut	boolean
poppedOut.remotePopOutRef	RefObject<Window | null>
poppedOut.setIsPresentationPoppedOut	Dispatch<SetStateAction<boolean>>
poppedOut.toggleIsPresentationPoppedOut()	() => void