sip.js.md

Home > sip.js

sip.js package

A simple yet powerful API which takes care of SIP signaling and WebRTC media sessions for you.

Classes

Class	Description
Ack	A request to confirm a Session (incoming ACK).
Bye	A request to end a Session (incoming BYE).
ContentTypeUnsupportedError	An exception indicating an unsupported content type prevented execution.
Info	An exchange of information (incoming INFO).
Invitation	An invitation is an offer to establish a Session (incoming INVITE).
Inviter	An inviter offers to establish a Session (outgoing INVITE).
Message	A received message (incoming MESSAGE).
Messager	A messager sends a Message (outgoing MESSAGE).
Notification	A notification of an event (incoming NOTIFY).
Publisher	A publisher publishes a publication (outgoing PUBLISH).
Referral	A request to establish a Session elsewhere (incoming REFER).
Registerer	A registerer registers a contact for an address of record (outgoing REGISTER).
RequestPendingError	An exception indicating an outstanding prior request prevented execution.
Session	A session provides real time communication between one or more participants.
SessionDescriptionHandlerError	An exception indicating a session description handler error occured.
SessionTerminatedError	An exception indicating the session terminated before the action completed.
StateTransitionError	An exception indicating an invalid state transition error occured.
Subscriber	A subscriber establishes a Subscription (outgoing SUBSCRIBE).
Subscription	A subscription provides Notification of events.
UserAgent	A user agent sends and receives requests using a Transport.

Enumerations

Enumeration	Description
PublisherState	Publisher state.
RegistererState	Registerer state.
SessionState	Session state.
SIPExtension	SIP extension support level.
SubscriptionState	Subscription state.
TransportState	Transport state.
UserAgentState	UserAgent state.

Interfaces

Interface	Description
BodyAndContentType	Message body content and type.
Emitter	Generic observable.
InvitationAcceptOptions	Options for Invitation.accept().
InvitationProgressOptions	Options for Invitation.progress().
InvitationRejectOptions	Options for Invitation.reject().
InviterCancelOptions	Options for Inviter.cancel().
InviterInviteOptions	Options for Inviter.invite().
InviterOptions	Options for Inviter constructor.
MessagerMessageOptions	Options for Messager.message().
MessagerOptions	Options for Messager constructor.
PublisherOptions	Options for Publisher constructor.
PublisherPublishOptions	Options for Publisher.publish().
PublisherUnpublishOptions	Options for Publisher.unpublish().
RegistererOptions	Options for Registerer constructor.
RegistererRegisterOptions	Options for Registerer.register().
RegistererUnregisterOptions	Options for Registerer.unregister().
SessionByeOptions	Options for Session.bye().
SessionDelegate	Delegate for Session.
SessionDescriptionHandler	Delegate for Session offer/answer exchange.
SessionDescriptionHandlerFactory	Factory for SessionDescriptionHandler.
SessionDescriptionHandlerModifier	Modifier for SessionDescriptionHandler offer/answer.
SessionDescriptionHandlerOptions	Options for SessionDescriptionHandler methods.
SessionInfoOptions	Options for Session.info().
SessionInviteOptions	Options for Session.invite().
SessionMessageOptions	Options for Session.message().
SessionOptions	Options for Session constructor.
SessionReferOptions	Options for Session.refer().
SubscriberOptions	Options for Subscriber constructor.
SubscriberSubscribeOptions	Options for Subscriber.subscribe().
SubscriptionDelegate	Delegate for Subscription.
SubscriptionOptions	Options for Subscription constructor.
SubscriptionSubscribeOptions	Options for Subscription.subscribe().
SubscriptionUnsubscribeOptions	Options for Subscription.unsubscribe().
Transport	Transport layer interface expected by the UserAgent.
UserAgentDelegate	Delegate for UserAgent.
UserAgentOptions	Options for UserAgent constructor.

Variables

Variable	Description
UserAgentRegisteredOptionTags	SIP Option Tags

Type Aliases

Type Alias	Description
LogConnector	Log connector function.
LogLevel	Log level.