Preparing search index...
The search index is not available
platform-sdk-docs - v4.0.1
platform-sdk-docs
platform-sdk/src
InputEmitter
Class InputEmitter
Hierarchy
InputEmitter
Index
Constructors
constructor
Properties
m_
dc
m_
finger
Ids
m_
fingers
m_
ue
Version
Methods
Emit
Command
Emit
Create
Participant
Request
Emit
Descriptor
Emit
Freeze
Frame
Emit
Key
Down
Emit
Key
Press
Emit
Key
Up
Emit
Message
Emit
Mouse
Down
Emit
Mouse
Enter
Emit
Mouse
Leave
Emit
Mouse
Move
Emit
Mouse
Up
Emit
Mouse
Wheel
Emit
Participant
Info
Change
Request
Emit
Participant
Info
Request
Emit
Player
Info
Change
Request
Emit
Player
Info
Request
Emit
Position
Request
Emit
Position
Update
Request
Emit
Remove
Participant
Request
Emit
Request
Quality
Control
Emit
Resize
Emit
Show
Participants
Emit
Touch
Data
EmitUIInteraction
Is
Browser
Key
Normalize
And
Quantize
Signed
Normalize
And
Quantize
Unsigned
Send
Input
Data
filter
Key
Code
forget
Touch
remember
Touch
Constructors
constructor
new
Input
Emitter
(
dataChannel
,
ueVersion
?
)
:
InputEmitter
Parameters
dataChannel
:
RTCDataChannel
Optional
ueVersion
:
string
Returns
InputEmitter
Properties
m_
dc
m_
dc
:
RTCDataChannel
m_
finger
Ids
m_
finger
Ids
:
{}
= {}
Type declaration
m_
fingers
m_
fingers
:
number
[]
= ...
m_
ue
Version
m_
ue
Version
:
string
Methods
Emit
Command
Emit
Command
(
descriptor
)
:
void
Parameters
descriptor
:
unknown
Returns
void
Emit
Create
Participant
Request
Emit
Create
Participant
Request
(
args
)
:
void
Parameters
args
:
{
color
:
{
a
:
number
;
b
:
number
;
g
:
number
;
r
:
number
;
}
;
id
:
string
;
location
:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
;
name
:
string
;
rotation
:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
;
}
color
:
{
a
:
number
;
b
:
number
;
g
:
number
;
r
:
number
;
}
a
:
number
b
:
number
g
:
number
r
:
number
id
:
string
location
:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
x
:
number
y
:
number
z
:
number
name
:
string
rotation
:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
x
:
number
y
:
number
z
:
number
Returns
void
Emit
Descriptor
Emit
Descriptor
(
type
,
descriptor
)
:
void
Parameters
type
:
MessageType
descriptor
:
unknown
Returns
void
Emit
Freeze
Frame
Emit
Freeze
Frame
(
bFreeze
)
:
void
Parameters
bFreeze
:
boolean
Returns
void
Emit
Key
Down
Emit
Key
Down
(
e
)
:
void
Parameters
e
:
KeyboardEvent
Returns
void
Emit
Key
Press
Emit
Key
Press
(
charCode
)
:
void
Parameters
charCode
:
number
Returns
void
Emit
Key
Up
Emit
Key
Up
(
e
)
:
void
Parameters
e
:
KeyboardEvent
Returns
void
Emit
Message
Emit
Message
(
messageType
,
descriptor
)
:
void
Parameters
messageType
:
string
descriptor
:
unknown
Returns
void
Emit
Mouse
Down
Emit
Mouse
Down
(
button
,
x
,
y
,
viewPortHeight
,
viewPortWidth
,
streamHeight
,
streamWidth
)
:
void
Parameters
button
:
MouseButton
x
:
number
y
:
number
viewPortHeight
:
number
viewPortWidth
:
number
streamHeight
:
number
streamWidth
:
number
Returns
void
Emit
Mouse
Enter
Emit
Mouse
Enter
(
)
:
void
Returns
void
Emit
Mouse
Leave
Emit
Mouse
Leave
(
)
:
void
Returns
void
Emit
Mouse
Move
Emit
Mouse
Move
(
x
,
y
,
deltaX
,
deltaY
,
viewPortHeight
,
viewPortWidth
,
streamHeight
,
streamWidth
)
:
void
Parameters
x
:
number
y
:
number
deltaX
:
number
deltaY
:
number
viewPortHeight
:
number
viewPortWidth
:
number
streamHeight
:
number
streamWidth
:
number
Returns
void
Emit
Mouse
Up
Emit
Mouse
Up
(
button
,
x
,
y
,
viewPortHeight
,
viewPortWidth
,
streamHeight
,
streamWidth
)
:
void
Parameters
button
:
MouseButton
x
:
number
y
:
number
viewPortHeight
:
number
viewPortWidth
:
number
streamHeight
:
number
streamWidth
:
number
Returns
void
Emit
Mouse
Wheel
Emit
Mouse
Wheel
(
delta
,
x
,
y
,
viewPortHeight
,
viewPortWidth
,
streamHeight
,
streamWidth
)
:
void
Parameters
delta
:
number
x
:
number
y
:
number
viewPortHeight
:
number
viewPortWidth
:
number
streamHeight
:
number
streamWidth
:
number
Returns
void
Emit
Participant
Info
Change
Request
Emit
Participant
Info
Change
Request
(
args
)
:
void
Parameters
args
:
{
color
?:
{
a
:
number
;
b
:
number
;
g
:
number
;
r
:
number
;
}
;
id
:
string
;
location
?:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
;
name
?:
string
;
pointer
?:
{
enabled
:
boolean
;
point
:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
;
}
;
rotation
?:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
;
}
Optional
color
?:
{
a
:
number
;
b
:
number
;
g
:
number
;
r
:
number
;
}
a
:
number
b
:
number
g
:
number
r
:
number
id
:
string
Optional
location
?:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
x
:
number
y
:
number
z
:
number
Optional
name
?:
string
Optional
pointer
?:
{
enabled
:
boolean
;
point
:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
;
}
enabled
:
boolean
point
:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
x
:
number
y
:
number
z
:
number
Optional
rotation
?:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
x
:
number
y
:
number
z
:
number
Returns
void
Emit
Participant
Info
Request
Emit
Participant
Info
Request
(
)
:
void
Returns
void
Emit
Player
Info
Change
Request
Emit
Player
Info
Change
Request
(
location
?
,
rotation
?
)
:
void
Parameters
Optional
location
:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
x
:
number
y
:
number
z
:
number
Optional
rotation
:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
x
:
number
y
:
number
z
:
number
Returns
void
Emit
Player
Info
Request
Emit
Player
Info
Request
(
)
:
void
Returns
void
Emit
Position
Request
Emit
Position
Request
(
location
,
rotation
)
:
void
Parameters
location
:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
x
:
number
y
:
number
z
:
number
rotation
:
{
x
:
number
;
y
:
number
;
z
:
number
;
}
x
:
number
y
:
number
z
:
number
Returns
void
Emit
Position
Update
Request
Emit
Position
Update
Request
(
)
:
void
Returns
void
Emit
Remove
Participant
Request
Emit
Remove
Participant
Request
(
id
)
:
void
Parameters
id
:
string
Returns
void
Emit
Request
Quality
Control
Emit
Request
Quality
Control
(
)
:
void
Returns
void
Emit
Resize
Emit
Resize
(
viewPortWidth
,
viewPortHeight
)
:
void
Parameters
viewPortWidth
:
number
viewPortHeight
:
number
Returns
void
Emit
Show
Participants
Emit
Show
Participants
(
visible
)
:
void
Parameters
visible
:
boolean
Returns
void
Emit
Touch
Data
Emit
Touch
Data
(
type
,
touches
,
offsetLeft
,
offsetTop
,
viewPortHeight
,
viewPortWidth
,
streamHeight
,
streamWidth
)
:
void
Parameters
type
:
MessageType
touches
:
TouchList
offsetLeft
:
number
offsetTop
:
number
viewPortHeight
:
number
viewPortWidth
:
number
streamHeight
:
number
streamWidth
:
number
Returns
void
EmitUIInteraction
EmitUIInteraction
(
descriptor
)
:
void
Parameters
descriptor
:
unknown
Returns
void
Is
Browser
Key
Is
Browser
Key
(
e
)
:
boolean
Parameters
e
:
KeyboardEvent
Returns
boolean
Normalize
And
Quantize
Signed
Normalize
And
Quantize
Signed
(
x
,
y
,
viewPortHeight
,
viewPortWidth
,
streamHeight
,
streamWidth
)
:
{
x
:
number
;
y
:
number
;
}
Parameters
x
:
number
y
:
number
viewPortHeight
:
number
viewPortWidth
:
number
streamHeight
:
number
streamWidth
:
number
Returns
{
x
:
number
;
y
:
number
;
}
x
:
number
y
:
number
Normalize
And
Quantize
Unsigned
Normalize
And
Quantize
Unsigned
(
x
,
y
,
viewPortHeight
,
viewPortWidth
,
streamHeight
,
streamWidth
)
:
{
inRange
:
boolean
;
x
:
number
;
y
:
number
;
}
Parameters
x
:
number
y
:
number
viewPortHeight
:
number
viewPortWidth
:
number
streamHeight
:
number
streamWidth
:
number
Returns
{
inRange
:
boolean
;
x
:
number
;
y
:
number
;
}
in
Range
:
boolean
x
:
number
y
:
number
Send
Input
Data
Send
Input
Data
(
buffer
)
:
void
Parameters
buffer
:
ArrayBufferLike
Returns
void
filter
Key
Code
filter
Key
Code
(
e
)
:
number
Parameters
e
:
KeyboardEvent
Returns
number
forget
Touch
forget
Touch
(
touch
)
:
void
Parameters
touch
:
Touch
Returns
void
remember
Touch
remember
Touch
(
touch
)
:
void
Parameters
touch
:
Touch
Returns
void
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
constructor
m_
dc
m_
finger
Ids
m_
fingers
m_
ue
Version
Emit
Command
Emit
Create
Participant
Request
Emit
Descriptor
Emit
Freeze
Frame
Emit
Key
Down
Emit
Key
Press
Emit
Key
Up
Emit
Message
Emit
Mouse
Down
Emit
Mouse
Enter
Emit
Mouse
Leave
Emit
Mouse
Move
Emit
Mouse
Up
Emit
Mouse
Wheel
Emit
Participant
Info
Change
Request
Emit
Participant
Info
Request
Emit
Player
Info
Change
Request
Emit
Player
Info
Request
Emit
Position
Request
Emit
Position
Update
Request
Emit
Remove
Participant
Request
Emit
Request
Quality
Control
Emit
Resize
Emit
Show
Participants
Emit
Touch
Data
EmitUIInteraction
Is
Browser
Key
Normalize
And
Quantize
Signed
Normalize
And
Quantize
Unsigned
Send
Input
Data
filter
Key
Code
forget
Touch
remember
Touch
platform-
sdk-
docs -
v4.0.1
platform-
sdk-
react/src
Video
Stream
default
Props
Observable
Message
Type
System
IContribution
Filter
Timeout
Props
Video
Stream
Props
Launch
Request
Options
Idle
Timeout
Video
Stream
use
Agent
Connection
Status
use
Launch
Request
use
Streamer
platform-
sdk/src
default
Agent
Connection
Status
Contribution
Types
Launch
Request
Acknowledgement
Type
Launch
Status
Type
Message
Type
Message
Types
Model
Definition
Type
Mouse
Button
Mouse
Buttons
State
Presence
Types
Resolution
Signalling
Topics
Signalling
Types
Storage
Types
Streamer
Status
Agent
Token
Agent
Utilities
Contribution
Registry
Input
Emitter
Launch
Request
Launch
Status
Event
Legacy
Model
Definition
Local
Agent
Local
Model
Definition
Logger
Provider
Model
Definition
Platform
Credentials
Platform
Next
Remote
Agent
Statistics
Stream
Contribution
Undefined
Model
Definition
Validate
Contribution
IAgent
IAgent
Environment
IContributions
ILaunch
Request
ILocal
Agent
IMessaging
IPresence
ISignalling
Connection
IStorage
Size
Stream
Resolution
Configuration
Streamer
Audio
Configuration
Streamer
Band
Width
Configuration
Streamer
Options
Access
Token
Contribution
Event
Contributions
Event
IRemote
Agent
Message
Event
Presence
Event
Storage
Event
Stream
Contribution
Elements
Agent
PlatformSDK
Default
Streamer
Options
Game
Message
Type
Streamer
Resolutions
attach
Key
Input
attach
Mouse
Input
stream
Resolution
Configuration
Generated using
TypeDoc