sip.js.sessiondescriptionhandler.setdescription.md

Home > sip.js > SessionDescriptionHandler > setDescription

SessionDescriptionHandler.setDescription() method

Sets the remote description to the underlying media implementation.

Signature:

setDescription(sdp: string, options?: SessionDescriptionHandlerOptions, modifiers?: Array<SessionDescriptionHandlerModifier>): Promise<void>;

Parameters

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

Returns:

Promise<void>

Promise that resolves once the description is set. Rejects with ClosedSessionDescriptionHandlerError when this method is called after close or when close occurs before complete.