Skip to main content

useAutoHideUIInterfaces

function useAutoHideUIInterfaces(
isStreamReady,
isDisabledByConfig,
shouldDisplay?): object;

Hook to signal display state (show/hide) based on UI inactivity timeout

Parameters

ParameterTypeDescription
isStreamReadybooleanonly apply autoHide if we've got a ready stream
isDisabledByConfigbooleanif true then auto hiding is disabled, UI controls will not be hidden
shouldDisplay?(shouldDisplay) => voidcallback to signal when to hide and when to show

Returns

object

control to enable/disable auto hide functionality

NameTypeDefault value
enableAutoHideDispatch<SetStateAction<boolean>>setEnabled
enableAutoHideConstraintBased()(constraint) => void-