AuviousRtc

@auvious/rtc / Exports / AuviousRtc

Interface: AuviousRtc

Main Library Interface. Instances of this type, abstract the webrtc api, and the interaction with auvious-rtc backend.

Table of contents

Methods

• call
• createConference
• endpoint
• identity
• joinConference
• message
• on
• register
• registered
• unregister

Methods

call

▸ call(username, options?): void

Parameters

Name	Type
username	string
options?	ICallOptions

Returns

void

---

createConference

▸ createConference(options?): Promise<IConference>

Parameters

Name	Type
options?	ICreateConferenceOptions

Returns

Promise<IConference>

---

endpoint

▸ endpoint(): string

Returns

string

---

identity

▸ identity(): string

Returns

string

---

joinConference

▸ joinConference(options): Promise<IConferenceSession>

Parameters

Name	Type
options	IJoinConferenceOptions

Returns

Promise<IConferenceSession>

---

message

▸ message(username, message): Promise<void>

Parameters

Name	Type
username	string
message	string

Returns

Promise<void>

---

on

▸ on(event, handler): any

Parameters

Name	Type
event	string
handler	(event: any) => void

Returns

any

---

register

▸ register(options): Promise<void>

Parameters

Name	Type
options	IRegisterOptions

Returns

Promise<void>

---

registered

▸ registered(): boolean

Returns

boolean

---

unregister

▸ unregister(): Promise<void>

Returns

Promise<void>