sip.js.sessiondescriptionhandler.getdescription.md

Home > sip.js > SessionDescriptionHandler > getDescription

SessionDescriptionHandler.getDescription() method

Gets the local description from the underlying media implementation.

Signature:

getDescription(options?: SessionDescriptionHandlerOptions, modifiers?: Array<SessionDescriptionHandlerModifier>): Promise<BodyAndContentType>;

Parameters

Parameter	Type	Description
options	SessionDescriptionHandlerOptions	Options object to be used by getDescription.
modifiers	Array<SessionDescriptionHandlerModifier>	Array with one time use description modifiers.

Returns:

Promise<BodyAndContentType>

Promise that resolves with the local description to be used for the session. Rejects with ClosedSessionDescriptionHandlerError when this method is called after close or when close occurs before complete.