sip.js.sessiondescriptionhandleroptions.md

September 26, 2022 ยท View on GitHub

Home > sip.js > SessionDescriptionHandlerOptions

SessionDescriptionHandlerOptions interface

Options for SessionDescriptionHandler.

Signature:

export interface SessionDescriptionHandlerOptions extends SessionDescriptionHandlerOptionsDefinition 

Extends: SessionDescriptionHandlerOptionsDefinition

Properties

PropertyModifiersTypeDescription
answerOptionsRTCAnswerOptionsAnswer options to use when creating an answer.
constraintsMediaStreamConstraintsConstraints to use when creating local media stream.
dataChannelbooleanIf true, create a data channel when making initial offer.
dataChannelLabelstringA human-readable name to use when creating the data channel.
dataChannelOptionsRTCDataChannelInitConfiguration options for creating the data channel.
holdbooleanIf true, offer and answer directions will be set to place peer on hold.
iceGatheringTimeoutnumberThe maximum duration to wait in ms for ICE gathering to complete. No timeout if undefined or zero.
offerOptionsRTCOfferOptionsOffer options to use when creating an offer.
onDataChannel(dataChannel: RTCDataChannel) => voidCalled upon creating a data channel.