2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

SessionService

The SessionService allows an application to register its participants' information in the Voxeet service. It is mandatory for the application to open a session before it can interact with the service further. The application may open and close sessions multiple times.


Accessors

participant

get participant(): Participant

Provides the local participant object that belongs to the current session.

Returns: Participant

Methods

close

close(): any

Closes the current session.

Returns: any


open

open(info: ParticipantInfo): Promise‹void›

Opens a new session.

Parameters:

NameTypeDefaultDescription
infoParticipantInfo{}Information about the current participant (optional)

Returns: Promise‹void›