Class: ApiStream
Properties
log
• Protected Optional log: Category
Methods
LiveApi
▸ LiveApi(): LiveApi
Returns the live api client
Returns
LiveApi
the live api client
LayoutApi
▸ LayoutApi(): LayoutApi
Returns the layout api client
Returns
LayoutApi
the layout api client
EventApi
▸ EventApi(): EventApi
Returns the layout api client
Returns
EventApi
the layout api client
getAccessToken
▸ getAccessToken(): AccessToken
Returns
getGuestProject
▸ getGuestProject(): GuestProject
Are we running as a guest role?
Returns
return the active project if running as a guest role
load
▸ load(accessToken?): Promise<GuestProject>
Initialize the api library and check if we are running inside of the rendering engine
async
Parameters
| Name | Type | Description |
|---|---|---|
accessToken? | string | a valid ApiStream access token |
Returns
Promise<GuestProject>
if we are operating inside of the rendering engine, this is the active project
getLiveKitServer
▸ getLiveKitServer(admin?): string
get the signaling address of the appropriate livekit webrtc server
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
admin | boolean | false | if true, return the admin (vs. client) address |
Returns
string
the address of the appropriate livekit webrtc server
Constructors
constructor
• new ApiStream(opts?)
Create an ApiStream API Client
Parameters
| Name | Type |
|---|---|
opts | ApiStreamOptions |