SessionAPI

Description

The session API allows to share the state of the instanceGraph between multiple user.
attachMediaTrack(streamID, track, stream)
Arguments

  • streamID (number()) –

  • track (MediaStreamTrack()) –

  • stream (MediaStream()) –

Returns

void

awaitStream(conditions)
Arguments
Returns

Promise<ISessionStreamData>

changeSessionParameter(sessionParameter, value, flags)
Arguments

  • sessionParameter (string()) –

  • value (any()) – Optional

  • flags (any()) – Optional

Returns

void

connectToSession(sessionID, name, scenarioURI, hints)
Arguments

  • sessionID (string()) – Optional

  • name (string()) – Optional

  • scenarioURI (string()) – Optional

  • hints – (SessionConnectionHints ) Optional

Returns

Promise<ISessionStateData>

disconnectFromSession()
Returns

void

getSessionMemberID()
Returns

number

getSessionMembers()
Returns

Promise<Array<ISessionMemberData>>

getSessionStateData()
Returns

ISessionStateData

getSessionStreams(conditions)
Arguments
Returns

Promise<Array<ISessionStreamData>>

loadScenario(scenarioURI)
Arguments

  • scenarioURI (string()) –

Returns

Promise<void>

onMediaTrack(streamID, callback)
Arguments

  • streamID (number()) –

  • callback (any()) –

Returns

void

onStreamStateChange(streamID, callback)
Arguments

  • streamID (number()) –

  • callback (SessionStreamStateChangeCallback()) –

Returns

void

promoteSessionMember(memberID)
Arguments

  • memberID (number()) –

Returns

void

publishStream(data)
Arguments
Returns

Promise<number>

readSessionParameter(sessionParameter, flags)
Arguments

  • sessionParameter (string()) –

  • flags (any()) –

Returns

Promise<any>

removeSessionMember(memberID)
Arguments

  • memberID (number()) –

Returns

void

requestDerivedSessionToken()
Returns

Promise<string>

sendToStream(streamID, message)
Arguments

  • streamID (number()) –

  • message (string|ArrayBuffer()) –

Returns

void

shutdownSession()
Returns

Promise<void>

subscribeStream(streamID, callback)
Arguments

  • streamID (number()) –

  • callback (SessionStreamMessageCallback()) – Optional

Returns

Promise<void>

unsubscribeStream(streamID, callback)
Arguments

  • streamID (number()) –

  • callback (SessionStreamMessageCallback()) –

Returns

void