@pexip/mee-sdk
Enumerations
Interfaces
Type Aliases
MEEWebsocketMessageTypesUnion
Ƭ MEEWebsocketMessageTypesUnion: Error & { id?: string ; ref?: string ; type: "error" } | Ping & { id?: string ; ref?: string ; type: "ping" } | Pong & { id?: string ; ref?: string ; type: "pong" } | Success & { id?: string ; ref?: string ; type: "success" } | Auth & { id?: string ; ref?: string ; type: "authenticate" } | MediaOffer & { id?: string ; ref?: string ; type: "media_offer" } | AddNewCandidate & { id?: string ; ref?: string ; type: "add_new_candidate" } | RosterUpdate & { id?: string ; ref?: string ; type: "roster_update" } | RequestStream & { id?: string ; ref?: string ; type: "request_stream" } | RequestStreamResponse & { id?: string ; ref?: string ; type: "request_stream_response" } | DisconnectStream & { id?: string ; ref?: string ; type: "disconnect_stream" }
This interface was referenced by MEEWebsocketMessageTypes's JSON-Schema
via the definition "MEEWebsocketMessageTypesUnion".
Roster
Ƭ Roster: RosterUpdate["participants"]
RosterEntry
Ƭ RosterEntry: RosterUpdate["participants"][``"streams"``]
SocketManager
Ƭ SocketManager: ReturnType<typeof createSocketManager>
SocketSignals
Ƭ SocketSignals: typeof socketSignals
Variables
BACKOFF_BASE_SETTINGS
• Const BACKOFF_BASE_SETTINGS: Object
Type declaration
| Name | Type |
|---|---|
jitter | number |
max | number |
min | number |
MAX_RECONNECT_ATTEMPTS
• Const MAX_RECONNECT_ATTEMPTS: 8
meeSignals
• Const meeSignals: Object
Type declaration
| Name | Type |
|---|---|
onReconnected | Signal<undefined> |
onReconnecting | Signal<undefined> |
onRosterUpdate | Signal<{ [k: string]: RosterEntry; }> |
pcMainSignals
• Const pcMainSignals: Pick<CorePeerConnectionSignals & Omit<PeerConnectionCommandSignals, "onReceiveIceCandidate"> & Required<PCOptionalsSignals>, "onError" | "onIceCandidate" | "onConnectionStateChange" | "onRemoteStreams" | "onOfferRequired" | "onReceiveAnswer" | "onReceiveOffer" | "onOffer" | "onOfferIgnored" | "onAnswer">
socketSignals
• Const socketSignals: Pick<Required<SocketSignals<MEEWebsocketMessageTypesUnion>>, "onConnecting" | "onConnected" | "onReconnecting" | "onReconnected" | "onDisconnected" | "onError" | "onMessage">
Functions
createMee
▸ createMee(args): Mee
Creates MEE wrapper for the given apiAddress and userID
Parameters
| Name | Type | Description |
|---|---|---|
args | Object | Provides necessary information like apiAddress and userId |
args.apiAddress | string | - |
args.userId | string | - |
Returns
Wrapper which encapsulates all interactions with MEE backend including WEBRTC
createRecvTransceivers
▸ createRecvTransceivers(kind, length): { direction: "recvonly" = 'recvonly'; kindOrTrack: "audio" | "video" = kind }[]
Parameters
| Name | Type |
|---|---|
kind | "audio" | "video" |
length | number |
Returns
{ direction: "recvonly" = 'recvonly'; kindOrTrack: "audio" | "video" = kind }[]
createToken
▸ createToken(userId, scopes?): string
Parameters
| Name | Type |
|---|---|
userId | string |
scopes | string[] |
Returns
string
retriable
▸ retriable<T>(fn, backoff?, retries?): Promise<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Default value |
|---|---|---|
fn | () => Promise<T> | undefined |
backoff | Backoff | undefined |
retries | number | MAX_RECONNECT_ATTEMPTS |
Returns
Promise<T>
setLogger
▸ setLogger(newLogger): void
Parameters
| Name | Type |
|---|---|
newLogger | Logger |
Returns
void
sleep
▸ sleep(ms): Promise<unknown>
Parameters
| Name | Type |
|---|---|
ms | number |
Returns
Promise<unknown>