@pexip/mee-api
Interfaces
- AddNewCandidate
- Api
- AudioStream
- Auth
- DisconnectStream
- Error
- JoinMeeting
- Layer
- MEEWebsocketMessageTypes
- MediaOffer
- Meeting
- Participant
- Ping
- Pong
- RequestStream
- RequestStreamResponse
- RosterEntry
- RosterUpdate
- Status
- Success
- VideoStream
Type Aliases
Codec
Ƭ Codec: "h264"
| "vp8"
| "vp9"
| "opus"
| "rtx"
This interface was referenced by MEEWebsocketMessageTypes
's JSON-Schema
via the definition
"Codec".
ErrorType
Ƭ ErrorType: "authentication_failed"
| "unsupported_message"
| "invalid_json"
| "invalid_message"
| "sdp_offer_processing"
| "server_error"
| "invalid_parameter"
| "resource_unavailable"
This interface was referenced by MEEWebsocketMessageTypes
's JSON-Schema
via the definition
"ErrorType".
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".
MediaSemantic
Ƭ MediaSemantic: "main"
| "presentation"
| "misc"
This interface was referenced by MEEWebsocketMessageTypes
's JSON-Schema
via the definition
"MediaSemantic".
MediaStream
Ƭ MediaStream: VideoStream
| AudioStream
This interface was referenced by undefined
's JSON-Schema definition
via the patternProperty
".*".
This interface was referenced by MEEWebsocketMessageTypes
's JSON-Schema
via the definition
"MediaStream".
ParticipantIDStr
Ƭ ParticipantIDStr: string
This interface was referenced by MEEWebsocketMessageTypes
's JSON-Schema
via the definition
"ParticipantIDStr".
StreamID
Ƭ StreamID: string
This interface was referenced by MEEWebsocketMessageTypes
's JSON-Schema
via the definition
"StreamID".
Functions
createApi
▸ createApi(apiAddress
, token
): Api
Creates MEE api wrapper for the given apiAddress
and token
Parameters
Name | Type |
---|---|
apiAddress | string |
token | string |
Returns
Api wrapper with all the main CRUD fns
withHeaders
▸ withHeaders(fetcher
, token
, contentType?
): (input
: RequestInfo
| URL
, init?
: RequestInit
) => Promise
<Response
>
Parameters
Name | Type | Default value |
---|---|---|
fetcher | (input : RequestInfo | URL , init? : RequestInit ) => Promise <Response > | undefined |
token | string | undefined |
contentType | JSON | ContentType.JSON |
Returns
fn
▸ (input
, init?
): Promise
<Response
>
Parameters
Name | Type |
---|---|
input | RequestInfo | URL |
init? | RequestInit |
Returns
Promise
<Response
>