@realsee/vr-signals API Documentation - v2.0.0
Preparing search index...
StandardVRSignalsAPI
Interface StandardVRSignalsAPI<ActionMap, EventMap>
标准化的 VR Signals API 接口
interface
StandardVRSignalsAPI
<
ActionMap
extends
Record
<
string
,
(
...
args
:
any
[]
)
=>
any
>
,
EventMap
extends
Record
<
string
,
(
...
args
:
any
[]
)
=>
any
>
,
>
{
addEventListener
(
type
:
string
,
listener
:
null
|
EventListener
|
EventListenerObject
,
options
?:
boolean
|
AddEventListenerOptions
,
)
:
void
;
removeEventListener
(
type
:
string
,
listener
:
null
|
EventListener
|
EventListenerObject
,
options
?:
boolean
|
EventListenerOptions
,
)
:
void
;
dispatchEvent
(
event
:
Event
)
:
boolean
;
on
<
EventName
extends
string
|
number
|
symbol
>
(
eventName
:
EventName
,
callback
:
EventMap
[
EventName
]
,
)
:
()
=>
void
;
off
<
EventName
extends
string
|
number
|
symbol
>
(
eventName
:
EventName
,
callback
:
EventMap
[
EventName
]
,
)
:
void
;
once
<
EventName
extends
string
|
number
|
symbol
>
(
eventName
:
EventName
,
callback
:
EventMap
[
EventName
]
,
)
:
()
=>
void
;
connect
()
:
Promise
<
void
>
;
disconnect
()
:
void
;
reconnect
()
:
Promise
<
void
>
;
getConnectionStatus
()
:
ConnectionStatus
;
isConnected
()
:
boolean
;
isConnecting
()
:
boolean
;
hasError
()
:
boolean
;
ready
()
:
Promise
<
void
>
;
destroy
()
:
void
;
sendEvent
<
EventName
extends
string
|
number
|
symbol
>
(
eventName
:
EventName
,
data
:
Parameters
<
EventMap
[
EventName
]
>
[
0
]
,
)
:
void
;
}
Type Parameters
ActionMap
extends
Record
<
string
,
(
...
args
:
any
[]
)
=>
any
>
EventMap
extends
Record
<
string
,
(
...
args
:
any
[]
)
=>
any
>
Index
Methods
add
Event
Listener
remove
Event
Listener
dispatch
Event
on
off
once
connect
disconnect
reconnect
get
Connection
Status
is
Connected
is
Connecting
has
Error
ready
destroy
send
Event
Methods
add
Event
Listener
addEventListener
(
type
:
string
,
listener
:
null
|
EventListener
|
EventListenerObject
,
options
?:
boolean
|
AddEventListenerOptions
,
)
:
void
Parameters
type
:
string
listener
:
null
|
EventListener
|
EventListenerObject
Optional
options
:
boolean
|
AddEventListenerOptions
Returns
void
remove
Event
Listener
removeEventListener
(
type
:
string
,
listener
:
null
|
EventListener
|
EventListenerObject
,
options
?:
boolean
|
EventListenerOptions
,
)
:
void
Parameters
type
:
string
listener
:
null
|
EventListener
|
EventListenerObject
Optional
options
:
boolean
|
EventListenerOptions
Returns
void
dispatch
Event
dispatchEvent
(
event
:
Event
)
:
boolean
Parameters
event
:
Event
Returns
boolean
on
on
<
EventName
extends
string
|
number
|
symbol
>
(
eventName
:
EventName
,
callback
:
EventMap
[
EventName
]
,
)
:
()
=>
void
Type Parameters
EventName
extends
string
|
number
|
symbol
Parameters
eventName
:
EventName
callback
:
EventMap
[
EventName
]
Returns
()
=>
void
off
off
<
EventName
extends
string
|
number
|
symbol
>
(
eventName
:
EventName
,
callback
:
EventMap
[
EventName
]
,
)
:
void
Type Parameters
EventName
extends
string
|
number
|
symbol
Parameters
eventName
:
EventName
callback
:
EventMap
[
EventName
]
Returns
void
once
once
<
EventName
extends
string
|
number
|
symbol
>
(
eventName
:
EventName
,
callback
:
EventMap
[
EventName
]
,
)
:
()
=>
void
Type Parameters
EventName
extends
string
|
number
|
symbol
Parameters
eventName
:
EventName
callback
:
EventMap
[
EventName
]
Returns
()
=>
void
connect
connect
()
:
Promise
<
void
>
Returns
Promise
<
void
>
disconnect
disconnect
()
:
void
Returns
void
reconnect
reconnect
()
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Connection
Status
getConnectionStatus
()
:
ConnectionStatus
Returns
ConnectionStatus
is
Connected
isConnected
()
:
boolean
Returns
boolean
is
Connecting
isConnecting
()
:
boolean
Returns
boolean
has
Error
hasError
()
:
boolean
Returns
boolean
ready
ready
()
:
Promise
<
void
>
Returns
Promise
<
void
>
destroy
destroy
()
:
void
Returns
void
send
Event
sendEvent
<
EventName
extends
string
|
number
|
symbol
>
(
eventName
:
EventName
,
data
:
Parameters
<
EventMap
[
EventName
]
>
[
0
]
,
)
:
void
Type Parameters
EventName
extends
string
|
number
|
symbol
Parameters
eventName
:
EventName
data
:
Parameters
<
EventMap
[
EventName
]
>
[
0
]
Returns
void
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Methods
add
Event
Listener
remove
Event
Listener
dispatch
Event
on
off
once
connect
disconnect
reconnect
get
Connection
Status
is
Connected
is
Connecting
has
Error
ready
destroy
send
Event
@realsee/vr-signals API Documentation - v2.0.0
Loading...
标准化的 VR Signals API 接口