Metatell AI Bot - v0.0.10
GitHub
NPM
Preparing search index...
@metatell/bot-sdk
AgentClient
Interface AgentClient
interface
AgentClient
{
connect
(
options
:
ConnectionOptions
)
:
Promise
<
void
>
;
disconnect
()
:
Promise
<
void
>
;
getAvailableAnimations
()
:
Promise
<
VRMAnimation
[]
>
;
getCurrentAnimation
()
:
null
|
string
;
getRateLimit
(
key
:
"messages"
|
"moves"
|
"looks"
)
:
undefined
|
number
;
getStatus
()
:
ConnectionStatus
;
getUser
(
id
:
string
)
:
undefined
|
UserAvatar
;
getUsers
()
:
UserAvatar
[]
;
getUsersNearby
(
radius
:
number
)
:
UserAvatar
[]
;
isVoiceMuted
()
:
boolean
;
join
(
room
:
string
)
:
Promise
<
void
>
;
leave
()
:
Promise
<
void
>
;
look
(
target
:
{
x
:
number
;
y
:
number
;
z
:
number
}
|
{
userId
:
string
}
,
)
:
Promise
<
void
>
;
lookAtNearest
()
:
Promise
<
void
>
;
move
(
position
:
{
x
:
number
;
y
:
number
;
z
:
number
}
)
:
Promise
<
void
>
;
muteVoice
(
muted
:
boolean
)
:
Promise
<
void
>
;
off
<
E
extends
keyof
AgentClientEvents
>
(
event
:
E
,
handler
:
AgentClientEvents
[
E
]
,
)
:
this
;
on
<
E
extends
keyof
AgentClientEvents
>
(
event
:
E
,
handler
:
AgentClientEvents
[
E
]
,
)
:
this
;
playAnimation
(
animationId
:
string
,
options
?:
AnimationPlayOptions
,
)
:
Promise
<
AnimationPlaybackResult
>
;
send
(
message
:
string
)
:
Promise
<
void
>
;
sendVoiceFrame
(
pcmData
:
Int16Array
)
:
Promise
<
void
>
;
setRateLimit
(
key
:
"messages"
|
"moves"
|
"looks"
,
perSecond
:
number
)
:
void
;
stopAnimation
()
:
Promise
<
void
>
;
}
Implemented by
DefaultAgentClient
Index
Methods
connect
disconnect
get
Available
Animations
get
Current
Animation
get
Rate
Limit
get
Status
get
User
get
Users
get
Users
Nearby
is
Voice
Muted
join
leave
look
look
At
Nearest
move
mute
Voice
off
on
play
Animation
send
send
Voice
Frame
set
Rate
Limit
stop
Animation
Methods
connect
connect
(
options
:
ConnectionOptions
)
:
Promise
<
void
>
Parameters
options
:
ConnectionOptions
Returns
Promise
<
void
>
disconnect
disconnect
()
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Available
Animations
getAvailableAnimations
()
:
Promise
<
VRMAnimation
[]
>
Returns
Promise
<
VRMAnimation
[]
>
get
Current
Animation
getCurrentAnimation
()
:
null
|
string
Returns
null
|
string
get
Rate
Limit
getRateLimit
(
key
:
"messages"
|
"moves"
|
"looks"
)
:
undefined
|
number
Parameters
key
:
"messages"
|
"moves"
|
"looks"
Returns
undefined
|
number
get
Status
getStatus
()
:
ConnectionStatus
Returns
ConnectionStatus
get
User
getUser
(
id
:
string
)
:
undefined
|
UserAvatar
Parameters
id
:
string
Returns
undefined
|
UserAvatar
get
Users
getUsers
()
:
UserAvatar
[]
Returns
UserAvatar
[]
get
Users
Nearby
getUsersNearby
(
radius
:
number
)
:
UserAvatar
[]
Parameters
radius
:
number
Returns
UserAvatar
[]
is
Voice
Muted
isVoiceMuted
()
:
boolean
Returns
boolean
join
join
(
room
:
string
)
:
Promise
<
void
>
Parameters
room
:
string
Returns
Promise
<
void
>
leave
leave
()
:
Promise
<
void
>
Returns
Promise
<
void
>
look
look
(
target
:
{
x
:
number
;
y
:
number
;
z
:
number
}
|
{
userId
:
string
}
,
)
:
Promise
<
void
>
Parameters
target
:
{
x
:
number
;
y
:
number
;
z
:
number
}
|
{
userId
:
string
}
Returns
Promise
<
void
>
look
At
Nearest
lookAtNearest
()
:
Promise
<
void
>
Returns
Promise
<
void
>
move
move
(
position
:
{
x
:
number
;
y
:
number
;
z
:
number
}
)
:
Promise
<
void
>
Parameters
position
:
{
x
:
number
;
y
:
number
;
z
:
number
}
Returns
Promise
<
void
>
mute
Voice
muteVoice
(
muted
:
boolean
)
:
Promise
<
void
>
Parameters
muted
:
boolean
Returns
Promise
<
void
>
off
off
<
E
extends
keyof
AgentClientEvents
>
(
event
:
E
,
handler
:
AgentClientEvents
[
E
]
,
)
:
this
Type Parameters
E
extends
keyof
AgentClientEvents
Parameters
event
:
E
handler
:
AgentClientEvents
[
E
]
Returns
this
on
on
<
E
extends
keyof
AgentClientEvents
>
(
event
:
E
,
handler
:
AgentClientEvents
[
E
]
,
)
:
this
Type Parameters
E
extends
keyof
AgentClientEvents
Parameters
event
:
E
handler
:
AgentClientEvents
[
E
]
Returns
this
play
Animation
playAnimation
(
animationId
:
string
,
options
?:
AnimationPlayOptions
,
)
:
Promise
<
AnimationPlaybackResult
>
Parameters
animationId
:
string
Optional
options
:
AnimationPlayOptions
Returns
Promise
<
AnimationPlaybackResult
>
send
send
(
message
:
string
)
:
Promise
<
void
>
Parameters
message
:
string
Returns
Promise
<
void
>
send
Voice
Frame
sendVoiceFrame
(
pcmData
:
Int16Array
)
:
Promise
<
void
>
Parameters
pcmData
:
Int16Array
Returns
Promise
<
void
>
set
Rate
Limit
setRateLimit
(
key
:
"messages"
|
"moves"
|
"looks"
,
perSecond
:
number
)
:
void
Parameters
key
:
"messages"
|
"moves"
|
"looks"
perSecond
:
number
Returns
void
stop
Animation
stopAnimation
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Methods
connect
disconnect
get
Available
Animations
get
Current
Animation
get
Rate
Limit
get
Status
get
User
get
Users
get
Users
Nearby
is
Voice
Muted
join
leave
look
look
At
Nearest
move
mute
Voice
off
on
play
Animation
send
send
Voice
Frame
set
Rate
Limit
stop
Animation
GitHub
NPM
Metatell AI Bot - v0.0.10
Loading...