Device
constDevice:object
Defined in: device/index.ts:15
Requests requiring a player gesture must be called from the host event itself.
Type Declaration
Section titled “Type Declaration”capabilities
Section titled “capabilities”capabilities: () =>
DeviceCapabilities
Returns
Section titled “Returns”dispose
Section titled “dispose”dispose: () =>
void
Returns
Section titled “Returns”void
fullscreen
Section titled “fullscreen”fullscreen: (
enabled,target?) =>Promise<DeviceResult>
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
target?
Section titled “target?”unknown
Returns
Section titled “Returns”Promise<DeviceResult>
keepScreenOn
Section titled “keepScreenOn”keepScreenOn: (
enabled) =>Promise<DeviceResult>
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”Promise<DeviceResult>
motion
Section titled “motion”motion:
object
motion.onChange
Section titled “motion.onChange”onChange: (
handler) => () =>void
Parameters
Section titled “Parameters”handler
Section titled “handler”(sample) => void
Returns
Section titled “Returns”() => void
motion.start
Section titled “motion.start”start: (
options?) =>Promise<DeviceResult>
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<DeviceResult>
motion.stop
Section titled “motion.stop”stop: () =>
Promise<DeviceResult>
Returns
Section titled “Returns”Promise<DeviceResult>
onChange
Section titled “onChange”onChange: (
handler) => () =>void
Parameters
Section titled “Parameters”handler
Section titled “handler”(state) => void
Returns
Section titled “Returns”() => void
pointerLock
Section titled “pointerLock”pointerLock: (
enabled,target?) =>Promise<DeviceResult>
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
target?
Section titled “target?”unknown
Returns
Section titled “Returns”Promise<DeviceResult>
state: () =>
DeviceState
Returns
Section titled “Returns”vibrate
Section titled “vibrate”vibrate: (
options?) =>Promise<DeviceResult>
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<DeviceResult>