Skip to main content

@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

NameType
jitternumber
maxnumber
minnumber

MAX_RECONNECT_ATTEMPTS

Const MAX_RECONNECT_ATTEMPTS: 8


meeSignals

Const meeSignals: Object

Type declaration

NameType
onReconnectedSignal<undefined>
onReconnectingSignal<undefined>
onRosterUpdateSignal<{ [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

NameTypeDescription
argsObjectProvides necessary information like apiAddress and userId
args.apiAddressstring-
args.userIdstring-

Returns

Mee

Wrapper which encapsulates all interactions with MEE backend including WEBRTC


createRecvTransceivers

createRecvTransceivers(kind, length): { direction: "recvonly" = 'recvonly'; kindOrTrack: "audio" | "video" = kind }[]

Parameters

NameType
kind"audio" | "video"
lengthnumber

Returns

{ direction: "recvonly" = 'recvonly'; kindOrTrack: "audio" | "video" = kind }[]


createToken

createToken(userId, scopes?): string

Parameters

NameType
userIdstring
scopesstring[]

Returns

string


retriable

retriable<T>(fn, backoff?, retries?): Promise<T>

Type parameters

Name
T

Parameters

NameTypeDefault value
fn() => Promise<T>undefined
backoffBackoffundefined
retriesnumberMAX_RECONNECT_ATTEMPTS

Returns

Promise<T>


setLogger

setLogger(newLogger): void

Parameters

NameType
newLoggerLogger

Returns

void


sleep

sleep(ms): Promise<unknown>

Parameters

NameType
msnumber

Returns

Promise<unknown>