SeydSession
Defined in: seyd/sdks/js/core/src/session.ts:59
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SeydSession(
o):SeydSession
Defined in: seyd/sdks/js/core/src/session.ts:83
Parameters
Section titled “Parameters”Returns
Section titled “Returns”SeydSession
Properties
Section titled “Properties”candidates
Section titled “candidates”candidates:
Candidate[] =[]
Defined in: seyd/sdks/js/core/src/session.ts:70
Candidates the robot advertised in the last offer (label/url/priority).
channels
Section titled “channels”channels:
ChannelInfo[] =[]
Defined in: seyd/sdks/js/core/src/session.ts:61
lastFailure
Section titled “lastFailure”lastFailure:
P2pFailure|null=null
Defined in: seyd/sdks/js/core/src/session.ts:72
lastStats
Section titled “lastStats”lastStats:
PilotStats|null=null
Defined in: seyd/sdks/js/core/src/session.ts:71
pathLabel
Section titled “pathLabel”pathLabel:
string|null=null
Defined in: seyd/sdks/js/core/src/session.ts:66
qos:
QosInfo|null=null
Defined in: seyd/sdks/js/core/src/session.ts:62
robotId
Section titled “robotId”robotId:
string|null=null
Defined in: seyd/sdks/js/core/src/session.ts:65
role:
"driver"|"observer"|null=null
Defined in: seyd/sdks/js/core/src/session.ts:63
sessionId
Section titled “sessionId”sessionId:
string|null=null
Defined in: seyd/sdks/js/core/src/session.ts:64
state:
SessionState='idle'
Defined in: seyd/sdks/js/core/src/session.ts:60
transport
Section titled “transport”transport:
TransportKind|null=null
Defined in: seyd/sdks/js/core/src/session.ts:68
‘p2p’ or ‘relay’ once connected (ADR 0010); null before.
Methods
Section titled “Methods”close()
Section titled “close()”close():
void
Defined in: seyd/sdks/js/core/src/session.ts:238
Returns
Section titled “Returns”void
connect()
Section titled “connect()”connect(
robotId):Promise<void>
Defined in: seyd/sdks/js/core/src/session.ts:127
Parameters
Section titled “Parameters”robotId
Section titled “robotId”string
Returns
Section titled “Returns”Promise<void>
hasCommandChannel()
Section titled “hasCommandChannel()”hasCommandChannel(
name):boolean
Defined in: seyd/sdks/js/core/src/session.ts:234
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
on<
K>(type,h): () =>void
Defined in: seyd/sdks/js/core/src/session.ts:118
Type Parameters
Section titled “Type Parameters”K extends keyof SessionEvents
Parameters
Section titled “Parameters”K
Handler<SessionEvents[K]>
Returns
Section titled “Returns”() => void
requestKeyframe()
Section titled “requestKeyframe()”requestKeyframe():
void
Defined in: seyd/sdks/js/core/src/session.ts:236
Returns
Section titled “Returns”void
send()
Section titled “send()”send(
channel,payload,_opts?):boolean
Defined in: seyd/sdks/js/core/src/session.ts:226
Send a command on a named command channel. JSON-encodes objects for codec ‘json’.
Parameters
Section titled “Parameters”channel
Section titled “channel”string
payload
Section titled “payload”unknown
_opts?
Section titled “_opts?”reliable?
Section titled “reliable?”boolean
Returns
Section titled “Returns”boolean
setQos()
Section titled “setQos()”setQos(
profile):void
Defined in: seyd/sdks/js/core/src/session.ts:235
Parameters
Section titled “Parameters”profile
Section titled “profile”string
Returns
Section titled “Returns”void