From 185d128208d92adb0f52d32b0d4ae6a1bfe3a3c0 Mon Sep 17 00:00:00 2001 From: John Riordan Date: Wed, 10 Jun 2020 11:55:21 -0400 Subject: [PATCH] Update docs --- docs/api/sip.js.invitationacceptoptions.md | 4 +-- ...ions.sessiondescriptionhandlermodifiers.md | 2 +- ...ptions.sessiondescriptionhandleroptions.md | 2 +- docs/api/sip.js.invitationprogressoptions.md | 4 +-- ...ions.sessiondescriptionhandlermodifiers.md | 2 +- ...ptions.sessiondescriptionhandleroptions.md | 2 +- docs/api/sip.js.inviterinviteoptions.md | 4 +-- ...ions.sessiondescriptionhandlermodifiers.md | 2 ++ ...ptions.sessiondescriptionhandleroptions.md | 2 ++ docs/api/sip.js.inviteroptions.md | 6 ++-- ...ions.sessiondescriptionhandlermodifiers.md | 2 +- ...siondescriptionhandlermodifiersreinvite.md | 13 ++++++++ ...ptions.sessiondescriptionhandleroptions.md | 2 +- ...essiondescriptionhandleroptionsreinvite.md | 13 ++++++++ docs/api/sip.js.session.md | 4 +++ ...sion.sessiondescriptionhandlermodifiers.md | 20 +++++++++++++ ...siondescriptionhandlermodifiersreinvite.md | 20 +++++++++++++ ...ession.sessiondescriptionhandleroptions.md | 20 +++++++++++++ ...essiondescriptionhandleroptionsreinvite.md | 20 +++++++++++++ docs/api/sip.js.sessioninviteoptions.md | 4 +-- ...ions.sessiondescriptionhandlermodifiers.md | 2 ++ ...ptions.sessiondescriptionhandleroptions.md | 2 ++ ...sessiondescriptionhandler._constructor_.md | 4 +-- ....sessiondescriptionhandler._datachannel.md | 13 ++++++++ ...iondescriptionhandler._localmediastream.md | 2 ++ ...ssiondescriptionhandler._peerconnection.md | 2 ++ ...ionhandler._peerconnectionconfiguration.md | 11 ------- ...criptionhandler._peerconnectiondelegate.md | 2 ++ ...ondescriptionhandler._remotemediastream.md | 2 ++ ...iondescriptionhandler.createdatachannel.md | 28 +++++++++++++++++ ...s.sessiondescriptionhandler.datachannel.md | 13 ++++++++ ...ndescriptionhandler.getlocalmediastream.md | 2 +- ...ptionhandler.getlocalsessiondescription.md | 2 +- ...descriptionhandler.icegatheringcomplete.md | 17 +++++++++++ ...sip.js.sessiondescriptionhandler.logger.md | 2 ++ .../sip.js.sessiondescriptionhandler.md | 30 +++++++++++-------- ...ondescriptionhandler.mediastreamfactory.md | 2 ++ ....sessiondescriptionhandlerconfiguration.md | 4 ++- ...essiondescriptionhandler.setdescription.md | 2 +- ...ndescriptionhandler.setlocalmediastream.md | 6 ++-- ...ptionhandler.setlocalsessiondescription.md | 2 +- ...tionhandler.setremotesessiondescription.md | 2 +- ...tionhandler.waitforicegatheringcomplete.md | 25 ++++++++++++++++ ...ondescriptionhandleroptions.constraints.md | 5 ++++ ...ondescriptionhandleroptions.datachannel.md | 13 ++++++++ ...criptionhandleroptions.datachannellabel.md | 13 ++++++++ ...iptionhandleroptions.datachanneloptions.md | 13 ++++++++ ...sip.js.sessiondescriptionhandleroptions.md | 4 +++ ...descriptionhandleroptions.ondatachannel.md | 13 ++++++++ docs/simple-user/sip.js.simpleuser.answer.md | 2 +- docs/simple-user/sip.js.simpleuser.call.md | 4 +-- .../sip.js.simpleusermedia.constraints.md | 7 ++++- docs/simple-user/sip.js.simpleusermedia.md | 2 +- etc/api/sip.js.api.md | 18 ++++++----- etc/session-description-handler/sip.js.api.md | 27 ++++++++--------- 55 files changed, 368 insertions(+), 78 deletions(-) create mode 100644 docs/api/sip.js.inviteroptions.sessiondescriptionhandlermodifiersreinvite.md create mode 100644 docs/api/sip.js.inviteroptions.sessiondescriptionhandleroptionsreinvite.md create mode 100644 docs/api/sip.js.session.sessiondescriptionhandlermodifiers.md create mode 100644 docs/api/sip.js.session.sessiondescriptionhandlermodifiersreinvite.md create mode 100644 docs/api/sip.js.session.sessiondescriptionhandleroptions.md create mode 100644 docs/api/sip.js.session.sessiondescriptionhandleroptionsreinvite.md create mode 100644 docs/session-description-handler/sip.js.sessiondescriptionhandler._datachannel.md delete mode 100644 docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnectionconfiguration.md create mode 100644 docs/session-description-handler/sip.js.sessiondescriptionhandler.createdatachannel.md create mode 100644 docs/session-description-handler/sip.js.sessiondescriptionhandler.datachannel.md create mode 100644 docs/session-description-handler/sip.js.sessiondescriptionhandler.icegatheringcomplete.md create mode 100644 docs/session-description-handler/sip.js.sessiondescriptionhandler.waitforicegatheringcomplete.md create mode 100644 docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachannel.md create mode 100644 docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachannellabel.md create mode 100644 docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachanneloptions.md create mode 100644 docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.ondatachannel.md diff --git a/docs/api/sip.js.invitationacceptoptions.md b/docs/api/sip.js.invitationacceptoptions.md index 3132ad398..6690514e4 100644 --- a/docs/api/sip.js.invitationacceptoptions.md +++ b/docs/api/sip.js.invitationacceptoptions.md @@ -16,6 +16,6 @@ export interface InvitationAcceptOptions | Property | Type | Description | | --- | --- | --- | -| [sessionDescriptionHandlerModifiers](./sip.js.invitationacceptoptions.sessiondescriptionhandlermodifiers.md) | Array<SessionDescriptionHandlerModifier> | Modifiers to pass to SessionDescriptionHandler's getDescription() and setDescription(). | -| [sessionDescriptionHandlerOptions](./sip.js.invitationacceptoptions.sessiondescriptionhandleroptions.md) | SessionDescriptionHandlerOptions | Options to pass to SessionDescriptionHandler's getDescription() and setDescription(). | +| [sessionDescriptionHandlerModifiers](./sip.js.invitationacceptoptions.sessiondescriptionhandlermodifiers.md) | Array<SessionDescriptionHandlerModifier> | Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. | +| [sessionDescriptionHandlerOptions](./sip.js.invitationacceptoptions.sessiondescriptionhandleroptions.md) | SessionDescriptionHandlerOptions | Options to pass to SessionDescriptionHandler during the initial INVITE transaction. | diff --git a/docs/api/sip.js.invitationacceptoptions.sessiondescriptionhandlermodifiers.md b/docs/api/sip.js.invitationacceptoptions.sessiondescriptionhandlermodifiers.md index 6478e5e54..b51297fbb 100644 --- a/docs/api/sip.js.invitationacceptoptions.sessiondescriptionhandlermodifiers.md +++ b/docs/api/sip.js.invitationacceptoptions.sessiondescriptionhandlermodifiers.md @@ -4,7 +4,7 @@ ## InvitationAcceptOptions.sessionDescriptionHandlerModifiers property -Modifiers to pass to SessionDescriptionHandler's getDescription() and setDescription(). +Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. Signature: diff --git a/docs/api/sip.js.invitationacceptoptions.sessiondescriptionhandleroptions.md b/docs/api/sip.js.invitationacceptoptions.sessiondescriptionhandleroptions.md index 956147196..a50295ac0 100644 --- a/docs/api/sip.js.invitationacceptoptions.sessiondescriptionhandleroptions.md +++ b/docs/api/sip.js.invitationacceptoptions.sessiondescriptionhandleroptions.md @@ -4,7 +4,7 @@ ## InvitationAcceptOptions.sessionDescriptionHandlerOptions property -Options to pass to SessionDescriptionHandler's getDescription() and setDescription(). +Options to pass to SessionDescriptionHandler during the initial INVITE transaction. Signature: diff --git a/docs/api/sip.js.invitationprogressoptions.md b/docs/api/sip.js.invitationprogressoptions.md index 460d72567..48138a9a0 100644 --- a/docs/api/sip.js.invitationprogressoptions.md +++ b/docs/api/sip.js.invitationprogressoptions.md @@ -20,7 +20,7 @@ export interface InvitationProgressOptions | [extraHeaders](./sip.js.invitationprogressoptions.extraheaders.md) | Array<string> | Array of extra headers added to the response. | | [reasonPhrase](./sip.js.invitationprogressoptions.reasonphrase.md) | string | Reason phrase for response. | | [rel100](./sip.js.invitationprogressoptions.rel100.md) | boolean | Send reliable response. | -| [sessionDescriptionHandlerModifiers](./sip.js.invitationprogressoptions.sessiondescriptionhandlermodifiers.md) | Array<SessionDescriptionHandlerModifier> | Modifiers to pass to SessionDescriptionHandler's getDescription() and setDescription(). | -| [sessionDescriptionHandlerOptions](./sip.js.invitationprogressoptions.sessiondescriptionhandleroptions.md) | SessionDescriptionHandlerOptions | Options to pass to SessionDescriptionHandler's getDescription() and setDescription(). | +| [sessionDescriptionHandlerModifiers](./sip.js.invitationprogressoptions.sessiondescriptionhandlermodifiers.md) | Array<SessionDescriptionHandlerModifier> | Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. | +| [sessionDescriptionHandlerOptions](./sip.js.invitationprogressoptions.sessiondescriptionhandleroptions.md) | SessionDescriptionHandlerOptions | Options to pass to SessionDescriptionHandler during the initial INVITE transaction. | | [statusCode](./sip.js.invitationprogressoptions.statuscode.md) | number | Status code for response. | diff --git a/docs/api/sip.js.invitationprogressoptions.sessiondescriptionhandlermodifiers.md b/docs/api/sip.js.invitationprogressoptions.sessiondescriptionhandlermodifiers.md index bbe8ea026..5bd8a5b69 100644 --- a/docs/api/sip.js.invitationprogressoptions.sessiondescriptionhandlermodifiers.md +++ b/docs/api/sip.js.invitationprogressoptions.sessiondescriptionhandlermodifiers.md @@ -4,7 +4,7 @@ ## InvitationProgressOptions.sessionDescriptionHandlerModifiers property -Modifiers to pass to SessionDescriptionHandler's getDescription() and setDescription(). +Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. Signature: diff --git a/docs/api/sip.js.invitationprogressoptions.sessiondescriptionhandleroptions.md b/docs/api/sip.js.invitationprogressoptions.sessiondescriptionhandleroptions.md index 7bba9ddb8..f53e3eef3 100644 --- a/docs/api/sip.js.invitationprogressoptions.sessiondescriptionhandleroptions.md +++ b/docs/api/sip.js.invitationprogressoptions.sessiondescriptionhandleroptions.md @@ -4,7 +4,7 @@ ## InvitationProgressOptions.sessionDescriptionHandlerOptions property -Options to pass to SessionDescriptionHandler's getDescription() and setDescription(). +Options to pass to SessionDescriptionHandler during the initial INVITE transaction. Signature: diff --git a/docs/api/sip.js.inviterinviteoptions.md b/docs/api/sip.js.inviterinviteoptions.md index 9fae6b233..0f4051f07 100644 --- a/docs/api/sip.js.inviterinviteoptions.md +++ b/docs/api/sip.js.inviterinviteoptions.md @@ -18,7 +18,7 @@ export interface InviterInviteOptions | --- | --- | --- | | [requestDelegate](./sip.js.inviterinviteoptions.requestdelegate.md) | OutgoingRequestDelegate | See core API. | | [requestOptions](./sip.js.inviterinviteoptions.requestoptions.md) | RequestOptions | See core API. | -| [sessionDescriptionHandlerModifiers](./sip.js.inviterinviteoptions.sessiondescriptionhandlermodifiers.md) | Array<SessionDescriptionHandlerModifier> | | -| [sessionDescriptionHandlerOptions](./sip.js.inviterinviteoptions.sessiondescriptionhandleroptions.md) | SessionDescriptionHandlerOptions | | +| [sessionDescriptionHandlerModifiers](./sip.js.inviterinviteoptions.sessiondescriptionhandlermodifiers.md) | Array<SessionDescriptionHandlerModifier> | Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. | +| [sessionDescriptionHandlerOptions](./sip.js.inviterinviteoptions.sessiondescriptionhandleroptions.md) | SessionDescriptionHandlerOptions | Options to pass to SessionDescriptionHandler during the initial INVITE transaction. | | [withoutSdp](./sip.js.inviterinviteoptions.withoutsdp.md) | boolean | If true, send INVITE without SDP. Default is false. | diff --git a/docs/api/sip.js.inviterinviteoptions.sessiondescriptionhandlermodifiers.md b/docs/api/sip.js.inviterinviteoptions.sessiondescriptionhandlermodifiers.md index d20b95b71..7d036774f 100644 --- a/docs/api/sip.js.inviterinviteoptions.sessiondescriptionhandlermodifiers.md +++ b/docs/api/sip.js.inviterinviteoptions.sessiondescriptionhandlermodifiers.md @@ -4,6 +4,8 @@ ## InviterInviteOptions.sessionDescriptionHandlerModifiers property +Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. + Signature: ```typescript diff --git a/docs/api/sip.js.inviterinviteoptions.sessiondescriptionhandleroptions.md b/docs/api/sip.js.inviterinviteoptions.sessiondescriptionhandleroptions.md index e8502068a..e98eb456d 100644 --- a/docs/api/sip.js.inviterinviteoptions.sessiondescriptionhandleroptions.md +++ b/docs/api/sip.js.inviterinviteoptions.sessiondescriptionhandleroptions.md @@ -4,6 +4,8 @@ ## InviterInviteOptions.sessionDescriptionHandlerOptions property +Options to pass to SessionDescriptionHandler during the initial INVITE transaction. + Signature: ```typescript diff --git a/docs/api/sip.js.inviteroptions.md b/docs/api/sip.js.inviteroptions.md index 13cd6b594..e6d84a8b2 100644 --- a/docs/api/sip.js.inviteroptions.md +++ b/docs/api/sip.js.inviteroptions.md @@ -23,6 +23,8 @@ export interface InviterOptions extends SessionOptions | [params](./sip.js.inviteroptions.params.md) | {
fromDisplayName?: string;
fromTag?: string;
fromUri?: string | URI;
toDisplayName?: string;
toUri?: string | URI;
} | | | [renderbody](./sip.js.inviteroptions.renderbody.md) | string | | | [rendertype](./sip.js.inviteroptions.rendertype.md) | string | | -| [sessionDescriptionHandlerModifiers](./sip.js.inviteroptions.sessiondescriptionhandlermodifiers.md) | Array<SessionDescriptionHandlerModifier> | Modifiers to pass to SessionDescriptionHandler's getDescription() and setDescription(). | -| [sessionDescriptionHandlerOptions](./sip.js.inviteroptions.sessiondescriptionhandleroptions.md) | SessionDescriptionHandlerOptions | Options to pass to SessionDescriptionHandler's getDescription() and setDescription(). | +| [sessionDescriptionHandlerModifiers](./sip.js.inviteroptions.sessiondescriptionhandlermodifiers.md) | Array<SessionDescriptionHandlerModifier> | Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. | +| [sessionDescriptionHandlerModifiersReInvite](./sip.js.inviteroptions.sessiondescriptionhandlermodifiersreinvite.md) | Array<SessionDescriptionHandlerModifier> | Modifiers to pass to SessionDescriptionHandler during re-INVITE transactions. | +| [sessionDescriptionHandlerOptions](./sip.js.inviteroptions.sessiondescriptionhandleroptions.md) | SessionDescriptionHandlerOptions | Options to pass to SessionDescriptionHandler during the initial INVITE transaction. | +| [sessionDescriptionHandlerOptionsReInvite](./sip.js.inviteroptions.sessiondescriptionhandleroptionsreinvite.md) | SessionDescriptionHandlerOptions | Options to pass to SessionDescriptionHandler during re-INVITE transactions. | diff --git a/docs/api/sip.js.inviteroptions.sessiondescriptionhandlermodifiers.md b/docs/api/sip.js.inviteroptions.sessiondescriptionhandlermodifiers.md index b2b0c9177..4c0156d38 100644 --- a/docs/api/sip.js.inviteroptions.sessiondescriptionhandlermodifiers.md +++ b/docs/api/sip.js.inviteroptions.sessiondescriptionhandlermodifiers.md @@ -4,7 +4,7 @@ ## InviterOptions.sessionDescriptionHandlerModifiers property -Modifiers to pass to SessionDescriptionHandler's getDescription() and setDescription(). +Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. Signature: diff --git a/docs/api/sip.js.inviteroptions.sessiondescriptionhandlermodifiersreinvite.md b/docs/api/sip.js.inviteroptions.sessiondescriptionhandlermodifiersreinvite.md new file mode 100644 index 000000000..a6443d995 --- /dev/null +++ b/docs/api/sip.js.inviteroptions.sessiondescriptionhandlermodifiersreinvite.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [InviterOptions](./sip.js.inviteroptions.md) > [sessionDescriptionHandlerModifiersReInvite](./sip.js.inviteroptions.sessiondescriptionhandlermodifiersreinvite.md) + +## InviterOptions.sessionDescriptionHandlerModifiersReInvite property + +Modifiers to pass to SessionDescriptionHandler during re-INVITE transactions. + +Signature: + +```typescript +sessionDescriptionHandlerModifiersReInvite?: Array; +``` diff --git a/docs/api/sip.js.inviteroptions.sessiondescriptionhandleroptions.md b/docs/api/sip.js.inviteroptions.sessiondescriptionhandleroptions.md index a1051cab9..19c7b6c8d 100644 --- a/docs/api/sip.js.inviteroptions.sessiondescriptionhandleroptions.md +++ b/docs/api/sip.js.inviteroptions.sessiondescriptionhandleroptions.md @@ -4,7 +4,7 @@ ## InviterOptions.sessionDescriptionHandlerOptions property -Options to pass to SessionDescriptionHandler's getDescription() and setDescription(). +Options to pass to SessionDescriptionHandler during the initial INVITE transaction. Signature: diff --git a/docs/api/sip.js.inviteroptions.sessiondescriptionhandleroptionsreinvite.md b/docs/api/sip.js.inviteroptions.sessiondescriptionhandleroptionsreinvite.md new file mode 100644 index 000000000..d102ea0eb --- /dev/null +++ b/docs/api/sip.js.inviteroptions.sessiondescriptionhandleroptionsreinvite.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [InviterOptions](./sip.js.inviteroptions.md) > [sessionDescriptionHandlerOptionsReInvite](./sip.js.inviteroptions.sessiondescriptionhandleroptionsreinvite.md) + +## InviterOptions.sessionDescriptionHandlerOptionsReInvite property + +Options to pass to SessionDescriptionHandler during re-INVITE transactions. + +Signature: + +```typescript +sessionDescriptionHandlerOptionsReInvite?: SessionDescriptionHandlerOptions; +``` diff --git a/docs/api/sip.js.session.md b/docs/api/sip.js.session.md index 7f4c00bac..ed880b735 100644 --- a/docs/api/sip.js.session.md +++ b/docs/api/sip.js.session.md @@ -33,6 +33,10 @@ The constructor for this class is marked as internal. Third-party code should no | [replacee](./sip.js.session.replacee.md) | | Session | undefined | The session being replace by this one. | | [sessionDescriptionHandler](./sip.js.session.sessiondescriptionhandler.md) | | SessionDescriptionHandler | undefined | Session description handler. | | [sessionDescriptionHandlerFactory](./sip.js.session.sessiondescriptionhandlerfactory.md) | | SessionDescriptionHandlerFactory | Session description handler factory. | +| [sessionDescriptionHandlerModifiers](./sip.js.session.sessiondescriptionhandlermodifiers.md) | | Array<SessionDescriptionHandlerModifier> | SDH modifiers for the initial INVITE transaction. | +| [sessionDescriptionHandlerModifiersReInvite](./sip.js.session.sessiondescriptionhandlermodifiersreinvite.md) | | Array<SessionDescriptionHandlerModifier> | SDH modifiers for re-INVITE transactions. | +| [sessionDescriptionHandlerOptions](./sip.js.session.sessiondescriptionhandleroptions.md) | | SessionDescriptionHandlerOptions | SDH options for the initial INVITE transaction. | +| [sessionDescriptionHandlerOptionsReInvite](./sip.js.session.sessiondescriptionhandleroptionsreinvite.md) | | SessionDescriptionHandlerOptions | SDH options for re-INVITE transactions. | | [state](./sip.js.session.state.md) | | SessionState | Session state. | | [stateChange](./sip.js.session.statechange.md) | | Emitter<SessionState> | Session state change emitter. | | [userAgent](./sip.js.session.useragent.md) | | UserAgent | The user agent. | diff --git a/docs/api/sip.js.session.sessiondescriptionhandlermodifiers.md b/docs/api/sip.js.session.sessiondescriptionhandlermodifiers.md new file mode 100644 index 000000000..c490d2b57 --- /dev/null +++ b/docs/api/sip.js.session.sessiondescriptionhandlermodifiers.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [Session](./sip.js.session.md) > [sessionDescriptionHandlerModifiers](./sip.js.session.sessiondescriptionhandlermodifiers.md) + +## Session.sessionDescriptionHandlerModifiers property + +SDH modifiers for the initial INVITE transaction. + +Signature: + +```typescript +get sessionDescriptionHandlerModifiers(): Array; + +set sessionDescriptionHandlerModifiers(modifiers: Array); +``` + +## Remarks + +Used in all cases when handling the initial INVITE transaction as either UAC or UAS. May be set directly at anytime. May optionally be set via constructor option. May optionally be set via options passed to Inviter.invite() or Invitation.accept(). + diff --git a/docs/api/sip.js.session.sessiondescriptionhandlermodifiersreinvite.md b/docs/api/sip.js.session.sessiondescriptionhandlermodifiersreinvite.md new file mode 100644 index 000000000..f3c68fabc --- /dev/null +++ b/docs/api/sip.js.session.sessiondescriptionhandlermodifiersreinvite.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [Session](./sip.js.session.md) > [sessionDescriptionHandlerModifiersReInvite](./sip.js.session.sessiondescriptionhandlermodifiersreinvite.md) + +## Session.sessionDescriptionHandlerModifiersReInvite property + +SDH modifiers for re-INVITE transactions. + +Signature: + +```typescript +get sessionDescriptionHandlerModifiersReInvite(): Array; + +set sessionDescriptionHandlerModifiersReInvite(modifiers: Array); +``` + +## Remarks + +Used in all cases when handling a re-INVITE transaction as either UAC or UAS. May be set directly at anytime. May optionally be set via constructor option. May optionally be set via options passed to Session.invite(). + diff --git a/docs/api/sip.js.session.sessiondescriptionhandleroptions.md b/docs/api/sip.js.session.sessiondescriptionhandleroptions.md new file mode 100644 index 000000000..542c6f956 --- /dev/null +++ b/docs/api/sip.js.session.sessiondescriptionhandleroptions.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [Session](./sip.js.session.md) > [sessionDescriptionHandlerOptions](./sip.js.session.sessiondescriptionhandleroptions.md) + +## Session.sessionDescriptionHandlerOptions property + +SDH options for the initial INVITE transaction. + +Signature: + +```typescript +get sessionDescriptionHandlerOptions(): SessionDescriptionHandlerOptions; + +set sessionDescriptionHandlerOptions(options: SessionDescriptionHandlerOptions); +``` + +## Remarks + +Used in all cases when handling the initial INVITE transaction as either UAC or UAS. May be set directly at anytime. May optionally be set via constructor option. May optionally be set via options passed to Inviter.invite() or Invitation.accept(). + diff --git a/docs/api/sip.js.session.sessiondescriptionhandleroptionsreinvite.md b/docs/api/sip.js.session.sessiondescriptionhandleroptionsreinvite.md new file mode 100644 index 000000000..037d5f410 --- /dev/null +++ b/docs/api/sip.js.session.sessiondescriptionhandleroptionsreinvite.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [Session](./sip.js.session.md) > [sessionDescriptionHandlerOptionsReInvite](./sip.js.session.sessiondescriptionhandleroptionsreinvite.md) + +## Session.sessionDescriptionHandlerOptionsReInvite property + +SDH options for re-INVITE transactions. + +Signature: + +```typescript +get sessionDescriptionHandlerOptionsReInvite(): SessionDescriptionHandlerOptions; + +set sessionDescriptionHandlerOptionsReInvite(options: SessionDescriptionHandlerOptions); +``` + +## Remarks + +Used in all cases when handling a re-INVITE transaction as either UAC or UAS. May be set directly at anytime. May optionally be set via constructor option. May optionally be set via options passed to Session.invite(). + diff --git a/docs/api/sip.js.sessioninviteoptions.md b/docs/api/sip.js.sessioninviteoptions.md index 194fd1299..0e992c9d0 100644 --- a/docs/api/sip.js.sessioninviteoptions.md +++ b/docs/api/sip.js.sessioninviteoptions.md @@ -18,7 +18,7 @@ export interface SessionInviteOptions | --- | --- | --- | | [requestDelegate](./sip.js.sessioninviteoptions.requestdelegate.md) | OutgoingRequestDelegate | See core API. | | [requestOptions](./sip.js.sessioninviteoptions.requestoptions.md) | RequestOptions | See core API. | -| [sessionDescriptionHandlerModifiers](./sip.js.sessioninviteoptions.sessiondescriptionhandlermodifiers.md) | Array<SessionDescriptionHandlerModifier> | | -| [sessionDescriptionHandlerOptions](./sip.js.sessioninviteoptions.sessiondescriptionhandleroptions.md) | SessionDescriptionHandlerOptions | | +| [sessionDescriptionHandlerModifiers](./sip.js.sessioninviteoptions.sessiondescriptionhandlermodifiers.md) | Array<SessionDescriptionHandlerModifier> | Modifiers to pass to SessionDescriptionHandler during re-INVITE transaction. | +| [sessionDescriptionHandlerOptions](./sip.js.sessioninviteoptions.sessiondescriptionhandleroptions.md) | SessionDescriptionHandlerOptions | Options to pass to SessionDescriptionHandler during re-INVITE transaction. | | [withoutSdp](./sip.js.sessioninviteoptions.withoutsdp.md) | boolean | If true, send INVITE without SDP. Default is false. | diff --git a/docs/api/sip.js.sessioninviteoptions.sessiondescriptionhandlermodifiers.md b/docs/api/sip.js.sessioninviteoptions.sessiondescriptionhandlermodifiers.md index 48a092f8f..3b6f8b2be 100644 --- a/docs/api/sip.js.sessioninviteoptions.sessiondescriptionhandlermodifiers.md +++ b/docs/api/sip.js.sessioninviteoptions.sessiondescriptionhandlermodifiers.md @@ -4,6 +4,8 @@ ## SessionInviteOptions.sessionDescriptionHandlerModifiers property +Modifiers to pass to SessionDescriptionHandler during re-INVITE transaction. + Signature: ```typescript diff --git a/docs/api/sip.js.sessioninviteoptions.sessiondescriptionhandleroptions.md b/docs/api/sip.js.sessioninviteoptions.sessiondescriptionhandleroptions.md index 6ed8d7fda..c35fe3012 100644 --- a/docs/api/sip.js.sessioninviteoptions.sessiondescriptionhandleroptions.md +++ b/docs/api/sip.js.sessioninviteoptions.sessiondescriptionhandleroptions.md @@ -4,6 +4,8 @@ ## SessionInviteOptions.sessionDescriptionHandlerOptions property +Options to pass to SessionDescriptionHandler during re-INVITE transaction. + Signature: ```typescript diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler._constructor_.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler._constructor_.md index 4aa70b94d..e7638e285 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler._constructor_.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler._constructor_.md @@ -9,7 +9,7 @@ Constructor Signature: ```typescript -constructor(logger: Logger, mediaStreamFactory: MediaStreamFactory, sessionDescriptionHandlerConfiguration?: SessionDescriptionHandlerConfiguration | undefined); +constructor(logger: Logger, mediaStreamFactory: MediaStreamFactory, sessionDescriptionHandlerConfiguration?: SessionDescriptionHandlerConfiguration); ``` ## Parameters @@ -18,5 +18,5 @@ constructor(logger: Logger, mediaStreamFactory: MediaStreamFactory, sessionDescr | --- | --- | --- | | logger | Logger | A logger | | mediaStreamFactory | MediaStreamFactory | A factory to provide a MediaStream | -| sessionDescriptionHandlerConfiguration | SessionDescriptionHandlerConfiguration | undefined | | +| sessionDescriptionHandlerConfiguration | SessionDescriptionHandlerConfiguration | | diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler._datachannel.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler._datachannel.md new file mode 100644 index 000000000..d4631c4b9 --- /dev/null +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler._datachannel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [SessionDescriptionHandler](./sip.js.sessiondescriptionhandler.md) > [\_dataChannel](./sip.js.sessiondescriptionhandler._datachannel.md) + +## SessionDescriptionHandler.\_dataChannel property + +The data channel. Undefined before created. + +Signature: + +```typescript +protected _dataChannel: RTCDataChannel | undefined; +``` diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler._localmediastream.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler._localmediastream.md index e6139a308..c00f9f6aa 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler._localmediastream.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler._localmediastream.md @@ -4,6 +4,8 @@ ## SessionDescriptionHandler.\_localMediaStream property +The local media stream. + Signature: ```typescript diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnection.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnection.md index e9922c328..f0423c9e5 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnection.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnection.md @@ -4,6 +4,8 @@ ## SessionDescriptionHandler.\_peerConnection property +The peer conneciton. Undefined after SessionDesriptionHandler.close(). + Signature: ```typescript diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnectionconfiguration.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnectionconfiguration.md deleted file mode 100644 index 3bf4a9eab..000000000 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnectionconfiguration.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [sip.js](./sip.js.md) > [SessionDescriptionHandler](./sip.js.sessiondescriptionhandler.md) > [\_peerConnectionConfiguration](./sip.js.sessiondescriptionhandler._peerconnectionconfiguration.md) - -## SessionDescriptionHandler.\_peerConnectionConfiguration property - -Signature: - -```typescript -protected _peerConnectionConfiguration: RTCConfiguration | undefined; -``` diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnectiondelegate.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnectiondelegate.md index 31ef8ed9f..753945350 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnectiondelegate.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler._peerconnectiondelegate.md @@ -4,6 +4,8 @@ ## SessionDescriptionHandler.\_peerConnectionDelegate property +The peer conneciton delegate. + Signature: ```typescript diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler._remotemediastream.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler._remotemediastream.md index eccea3983..05a03be8c 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler._remotemediastream.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler._remotemediastream.md @@ -4,6 +4,8 @@ ## SessionDescriptionHandler.\_remoteMediaStream property +The remote media stream. + Signature: ```typescript diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.createdatachannel.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.createdatachannel.md new file mode 100644 index 000000000..5b29eedb7 --- /dev/null +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.createdatachannel.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [SessionDescriptionHandler](./sip.js.sessiondescriptionhandler.md) > [createDataChannel](./sip.js.sessiondescriptionhandler.createdatachannel.md) + +## SessionDescriptionHandler.createDataChannel() method + +Create a data channel. + +Signature: + +```typescript +protected createDataChannel(options?: SessionDescriptionHandlerOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | SessionDescriptionHandlerOptions | Session description handler options. | + +Returns: + +`Promise` + +## Remarks + +Only creates a data channel if SessionDescriptionHandlerOptions.dataChannel is true. Only creates a data channel if creating a local offer. Only if one does not already exist. + diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.datachannel.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.datachannel.md new file mode 100644 index 000000000..a81911d6d --- /dev/null +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.datachannel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [SessionDescriptionHandler](./sip.js.sessiondescriptionhandler.md) > [dataChannel](./sip.js.sessiondescriptionhandler.datachannel.md) + +## SessionDescriptionHandler.dataChannel property + +The data channel. Undefined before it is created. + +Signature: + +```typescript +get dataChannel(): RTCDataChannel | undefined; +``` diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.getlocalmediastream.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.getlocalmediastream.md index 986a71f91..5d62532c6 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler.getlocalmediastream.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.getlocalmediastream.md @@ -4,7 +4,7 @@ ## SessionDescriptionHandler.getLocalMediaStream() method -If we have not already done so, get and set local user media. +Get a media stream from the media stream factory and set the local media stream. Signature: diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.getlocalsessiondescription.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.getlocalsessiondescription.md index cd1d5a4d8..b58269a59 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler.getlocalsessiondescription.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.getlocalsessiondescription.md @@ -4,7 +4,7 @@ ## SessionDescriptionHandler.getLocalSessionDescription() method -Gets the local session description. +Gets the peer connection's local session description. Signature: diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.icegatheringcomplete.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.icegatheringcomplete.md new file mode 100644 index 000000000..aa8de9355 --- /dev/null +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.icegatheringcomplete.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [SessionDescriptionHandler](./sip.js.sessiondescriptionhandler.md) > [iceGatheringComplete](./sip.js.sessiondescriptionhandler.icegatheringcomplete.md) + +## SessionDescriptionHandler.iceGatheringComplete() method + +Called when ICE gathering completes and resolves any waiting promise. + +Signature: + +```typescript +protected iceGatheringComplete(): void; +``` +Returns: + +`void` + diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.logger.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.logger.md index 03dc772e4..80cc1c0e2 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler.logger.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.logger.md @@ -4,6 +4,8 @@ ## SessionDescriptionHandler.logger property +Logger. + Signature: ```typescript diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.md index 13ebcceb3..abd11d9e7 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.md @@ -26,18 +26,19 @@ It is expected/intended to be extended by specific WebRTC based applications. | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [\_localMediaStream](./sip.js.sessiondescriptionhandler._localmediastream.md) | | MediaStream | | -| [\_peerConnection](./sip.js.sessiondescriptionhandler._peerconnection.md) | | RTCPeerConnection | undefined | | -| [\_peerConnectionConfiguration](./sip.js.sessiondescriptionhandler._peerconnectionconfiguration.md) | | RTCConfiguration | undefined | | -| [\_peerConnectionDelegate](./sip.js.sessiondescriptionhandler._peerconnectiondelegate.md) | | PeerConnectionDelegate | undefined | | -| [\_remoteMediaStream](./sip.js.sessiondescriptionhandler._remotemediastream.md) | | MediaStream | | +| [\_dataChannel](./sip.js.sessiondescriptionhandler._datachannel.md) | | RTCDataChannel | undefined | The data channel. Undefined before created. | +| [\_localMediaStream](./sip.js.sessiondescriptionhandler._localmediastream.md) | | MediaStream | The local media stream. | +| [\_peerConnection](./sip.js.sessiondescriptionhandler._peerconnection.md) | | RTCPeerConnection | undefined | The peer conneciton. Undefined after SessionDesriptionHandler.close(). | +| [\_peerConnectionDelegate](./sip.js.sessiondescriptionhandler._peerconnectiondelegate.md) | | PeerConnectionDelegate | undefined | The peer conneciton delegate. | +| [\_remoteMediaStream](./sip.js.sessiondescriptionhandler._remotemediastream.md) | | MediaStream | The remote media stream. | +| [dataChannel](./sip.js.sessiondescriptionhandler.datachannel.md) | | RTCDataChannel | undefined | The data channel. Undefined before it is created. | | [localMediaStream](./sip.js.sessiondescriptionhandler.localmediastream.md) | | MediaStream | The local media stream currently being sent. | -| [logger](./sip.js.sessiondescriptionhandler.logger.md) | | Logger | | -| [mediaStreamFactory](./sip.js.sessiondescriptionhandler.mediastreamfactory.md) | | MediaStreamFactory | | +| [logger](./sip.js.sessiondescriptionhandler.logger.md) | | Logger | Logger. | +| [mediaStreamFactory](./sip.js.sessiondescriptionhandler.mediastreamfactory.md) | | MediaStreamFactory | Media stream factory. | | [peerConnection](./sip.js.sessiondescriptionhandler.peerconnection.md) | | RTCPeerConnection | undefined | The peer connection. Undefined if peer connection has closed. | | [peerConnectionDelegate](./sip.js.sessiondescriptionhandler.peerconnectiondelegate.md) | | PeerConnectionDelegate | undefined | A delegate which provides access to the peer connection event handlers. | | [remoteMediaStream](./sip.js.sessiondescriptionhandler.remotemediastream.md) | | MediaStream | The remote media stream currently being received. | -| [sessionDescriptionHandlerConfiguration](./sip.js.sessiondescriptionhandler.sessiondescriptionhandlerconfiguration.md) | | SessionDescriptionHandlerConfiguration | undefined | | +| [sessionDescriptionHandlerConfiguration](./sip.js.sessiondescriptionhandler.sessiondescriptionhandlerconfiguration.md) | | SessionDescriptionHandlerConfiguration | Configuration options. | ## Methods @@ -45,16 +46,19 @@ It is expected/intended to be extended by specific WebRTC based applications. | --- | --- | --- | | [applyModifiers(sdp, modifiers)](./sip.js.sessiondescriptionhandler.applymodifiers.md) | | Applies modifiers to SDP prior to setting the local or remote description. | | [close()](./sip.js.sessiondescriptionhandler.close.md) | | Stop tracks and close peer connection. | +| [createDataChannel(options)](./sip.js.sessiondescriptionhandler.createdatachannel.md) | | Create a data channel. | | [createLocalOfferOrAnswer(options)](./sip.js.sessiondescriptionhandler.createlocalofferoranswer.md) | | Depending on current signaling state, create a local offer or answer. | | [getDescription(options, modifiers)](./sip.js.sessiondescriptionhandler.getdescription.md) | | Creates an offer or answer. | -| [getLocalMediaStream(options)](./sip.js.sessiondescriptionhandler.getlocalmediastream.md) | | If we have not already done so, get and set local user media. | -| [getLocalSessionDescription()](./sip.js.sessiondescriptionhandler.getlocalsessiondescription.md) | | Gets the local session description. | +| [getLocalMediaStream(options)](./sip.js.sessiondescriptionhandler.getlocalmediastream.md) | | Get a media stream from the media stream factory and set the local media stream. | +| [getLocalSessionDescription()](./sip.js.sessiondescriptionhandler.getlocalsessiondescription.md) | | Gets the peer connection's local session description. | | [hasDescription(contentType)](./sip.js.sessiondescriptionhandler.hasdescription.md) | | Returns true if the SessionDescriptionHandler can handle the Content-Type described by a SIP message. | | [holdModifier(sessionDescription)](./sip.js.sessiondescriptionhandler.holdmodifier.md) | | The modifier that should be used when the session would like to place the call on hold. | +| [iceGatheringComplete()](./sip.js.sessiondescriptionhandler.icegatheringcomplete.md) | | Called when ICE gathering completes and resolves any waiting promise. | | [sendDtmf(tones, options)](./sip.js.sessiondescriptionhandler.senddtmf.md) | | Send DTMF via RTP (RFC 4733). Returns true if DTMF send is successful, false otherwise. | | [setDescription(sdp, options, modifiers)](./sip.js.sessiondescriptionhandler.setdescription.md) | | Sets an offer or answer. | -| [setLocalMediaStream(stream)](./sip.js.sessiondescriptionhandler.setlocalmediastream.md) | | Sets the peer connections sender tracks and local media stream tracks. | -| [setLocalSessionDescription(sessionDescription)](./sip.js.sessiondescriptionhandler.setlocalsessiondescription.md) | | Sets the local session description. | -| [setRemoteSessionDescription(sessionDescription)](./sip.js.sessiondescriptionhandler.setremotesessiondescription.md) | | Sets the remote session description. | +| [setLocalMediaStream(stream)](./sip.js.sessiondescriptionhandler.setlocalmediastream.md) | | Sets the peer connection's sender tracks and local media stream tracks. | +| [setLocalSessionDescription(sessionDescription)](./sip.js.sessiondescriptionhandler.setlocalsessiondescription.md) | | Sets the peer connection's local session description. | +| [setRemoteSessionDescription(sessionDescription)](./sip.js.sessiondescriptionhandler.setremotesessiondescription.md) | | Sets the peer connection's remote session description. | | [setRemoteTrack(track)](./sip.js.sessiondescriptionhandler.setremotetrack.md) | | Sets a remote media stream track. | +| [waitForIceGatheringComplete(restart, timeout)](./sip.js.sessiondescriptionhandler.waitforicegatheringcomplete.md) | | Wait for ICE gathering to complete. | diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.mediastreamfactory.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.mediastreamfactory.md index e87e7fa9e..865b7548f 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler.mediastreamfactory.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.mediastreamfactory.md @@ -4,6 +4,8 @@ ## SessionDescriptionHandler.mediaStreamFactory property +Media stream factory. + Signature: ```typescript diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.sessiondescriptionhandlerconfiguration.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.sessiondescriptionhandlerconfiguration.md index 4928e6024..fb36b01e4 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler.sessiondescriptionhandlerconfiguration.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.sessiondescriptionhandlerconfiguration.md @@ -4,8 +4,10 @@ ## SessionDescriptionHandler.sessionDescriptionHandlerConfiguration property +Configuration options. + Signature: ```typescript -protected sessionDescriptionHandlerConfiguration?: SessionDescriptionHandlerConfiguration | undefined; +protected sessionDescriptionHandlerConfiguration?: SessionDescriptionHandlerConfiguration; ``` diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.setdescription.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.setdescription.md index 1c45f4b07..38273ac7a 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler.setdescription.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.setdescription.md @@ -16,7 +16,7 @@ setDescription(sdp: string, options?: SessionDescriptionHandlerOptions, modifier | Parameter | Type | Description | | --- | --- | --- | -| sdp | string | | +| sdp | string | The session description. | | options | SessionDescriptionHandlerOptions | Options bucket. | | modifiers | Array<SessionDescriptionHandlerModifier> | Modifiers. | diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.setlocalmediastream.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.setlocalmediastream.md index 38c0f2b6f..80b9ab837 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler.setlocalmediastream.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.setlocalmediastream.md @@ -4,12 +4,12 @@ ## SessionDescriptionHandler.setLocalMediaStream() method -Sets the peer connections sender tracks and local media stream tracks. +Sets the peer connection's sender tracks and local media stream tracks. Signature: ```typescript -protected setLocalMediaStream(stream: MediaStream): void; +protected setLocalMediaStream(stream: MediaStream): Promise; ``` ## Parameters @@ -20,7 +20,7 @@ protected setLocalMediaStream(stream: MediaStream): void; Returns: -`void` +`Promise` ## Remarks diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.setlocalsessiondescription.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.setlocalsessiondescription.md index 63c523336..1a3e96496 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler.setlocalsessiondescription.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.setlocalsessiondescription.md @@ -4,7 +4,7 @@ ## SessionDescriptionHandler.setLocalSessionDescription() method -Sets the local session description. +Sets the peer connection's local session description. Signature: diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.setremotesessiondescription.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.setremotesessiondescription.md index 77f261413..f8081f37f 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandler.setremotesessiondescription.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.setremotesessiondescription.md @@ -4,7 +4,7 @@ ## SessionDescriptionHandler.setRemoteSessionDescription() method -Sets the remote session description. +Sets the peer connection's remote session description. Signature: diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandler.waitforicegatheringcomplete.md b/docs/session-description-handler/sip.js.sessiondescriptionhandler.waitforicegatheringcomplete.md new file mode 100644 index 000000000..204ddd057 --- /dev/null +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandler.waitforicegatheringcomplete.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [SessionDescriptionHandler](./sip.js.sessiondescriptionhandler.md) > [waitForIceGatheringComplete](./sip.js.sessiondescriptionhandler.waitforicegatheringcomplete.md) + +## SessionDescriptionHandler.waitForIceGatheringComplete() method + +Wait for ICE gathering to complete. + +Signature: + +```typescript +protected waitForIceGatheringComplete(restart?: boolean, timeout?: number): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| restart | boolean | If true, waits if current state is "complete" (waits for transition to "complete"). | +| timeout | number | Milliseconds after which waiting times out. No timeout if 0. | + +Returns: + +`Promise` + diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.constraints.md b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.constraints.md index 7d317dc61..72f914daa 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.constraints.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.constraints.md @@ -11,3 +11,8 @@ Constraints to use when creating local media stream. ```typescript constraints?: MediaStreamConstraints; ``` + +## Remarks + +If undefined, defaults to audio true and video false. If audio and video are false, media stream will have no tracks. + diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachannel.md b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachannel.md new file mode 100644 index 000000000..0fcdc6bf7 --- /dev/null +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachannel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [SessionDescriptionHandlerOptions](./sip.js.sessiondescriptionhandleroptions.md) > [dataChannel](./sip.js.sessiondescriptionhandleroptions.datachannel.md) + +## SessionDescriptionHandlerOptions.dataChannel property + +If true, create a data channel when making initial offer. + +Signature: + +```typescript +dataChannel?: boolean; +``` diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachannellabel.md b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachannellabel.md new file mode 100644 index 000000000..35ee68cc0 --- /dev/null +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachannellabel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [SessionDescriptionHandlerOptions](./sip.js.sessiondescriptionhandleroptions.md) > [dataChannelLabel](./sip.js.sessiondescriptionhandleroptions.datachannellabel.md) + +## SessionDescriptionHandlerOptions.dataChannelLabel property + +A human-readable name to use when creating the data channel. + +Signature: + +```typescript +dataChannelLabel?: string; +``` diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachanneloptions.md b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachanneloptions.md new file mode 100644 index 000000000..876e5ac87 --- /dev/null +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.datachanneloptions.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [SessionDescriptionHandlerOptions](./sip.js.sessiondescriptionhandleroptions.md) > [dataChannelOptions](./sip.js.sessiondescriptionhandleroptions.datachanneloptions.md) + +## SessionDescriptionHandlerOptions.dataChannelOptions property + +Configuration options for creating the data channel. + +Signature: + +```typescript +dataChannelOptions?: RTCDataChannelInit; +``` diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.md b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.md index 2e7aceae1..8a93a9144 100644 --- a/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.md +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.md @@ -18,6 +18,10 @@ export interface SessionDescriptionHandlerOptions extends SessionDescriptionHand | --- | --- | --- | | [answerOptions](./sip.js.sessiondescriptionhandleroptions.answeroptions.md) | RTCAnswerOptions | Answer options to use when creating an answer. | | [constraints](./sip.js.sessiondescriptionhandleroptions.constraints.md) | MediaStreamConstraints | Constraints to use when creating local media stream. | +| [dataChannel](./sip.js.sessiondescriptionhandleroptions.datachannel.md) | boolean | If true, create a data channel when making initial offer. | +| [dataChannelLabel](./sip.js.sessiondescriptionhandleroptions.datachannellabel.md) | string | A human-readable name to use when creating the data channel. | +| [dataChannelOptions](./sip.js.sessiondescriptionhandleroptions.datachanneloptions.md) | RTCDataChannelInit | Configuration options for creating the data channel. | | [iceGatheringTimeout](./sip.js.sessiondescriptionhandleroptions.icegatheringtimeout.md) | number | The maximum duration to wait in ms for ICE gathering to complete. No timeout if undefined or zero. | | [offerOptions](./sip.js.sessiondescriptionhandleroptions.offeroptions.md) | RTCOfferOptions | Offer options to use when creating an offer. | +| [onDataChannel](./sip.js.sessiondescriptionhandleroptions.ondatachannel.md) | (dataChannel: RTCDataChannel) => void | Called upon creating a data channel. | diff --git a/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.ondatachannel.md b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.ondatachannel.md new file mode 100644 index 000000000..465a8e7b3 --- /dev/null +++ b/docs/session-description-handler/sip.js.sessiondescriptionhandleroptions.ondatachannel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [SessionDescriptionHandlerOptions](./sip.js.sessiondescriptionhandleroptions.md) > [onDataChannel](./sip.js.sessiondescriptionhandleroptions.ondatachannel.md) + +## SessionDescriptionHandlerOptions.onDataChannel property + +Called upon creating a data channel. + +Signature: + +```typescript +onDataChannel?: (dataChannel: RTCDataChannel) => void; +``` diff --git a/docs/simple-user/sip.js.simpleuser.answer.md b/docs/simple-user/sip.js.simpleuser.answer.md index 4960141bc..b2d1b47f1 100644 --- a/docs/simple-user/sip.js.simpleuser.answer.md +++ b/docs/simple-user/sip.js.simpleuser.answer.md @@ -16,7 +16,7 @@ answer(invitationAcceptOptions?: InvitationAcceptOptions): Promise; | Parameter | Type | Description | | --- | --- | --- | -| invitationAcceptOptions | InvitationAcceptOptions | | +| invitationAcceptOptions | InvitationAcceptOptions | Optional options for Inviter.accept(). | Returns: diff --git a/docs/simple-user/sip.js.simpleuser.call.md b/docs/simple-user/sip.js.simpleuser.call.md index 9c3068f05..f9d7d0588 100644 --- a/docs/simple-user/sip.js.simpleuser.call.md +++ b/docs/simple-user/sip.js.simpleuser.call.md @@ -17,8 +17,8 @@ call(destination: string, inviterOptions?: InviterOptions, inviterInviteOptions? | Parameter | Type | Description | | --- | --- | --- | | destination | string | The target destination to call. A SIP address to send the INVITE to. | -| inviterOptions | InviterOptions | | -| inviterInviteOptions | InviterInviteOptions | | +| inviterOptions | InviterOptions | Optional options for Inviter constructor. | +| inviterInviteOptions | InviterInviteOptions | Optional options for Inviter.invite(). | Returns: diff --git a/docs/simple-user/sip.js.simpleusermedia.constraints.md b/docs/simple-user/sip.js.simpleusermedia.constraints.md index 858bb4540..a3ba8e33c 100644 --- a/docs/simple-user/sip.js.simpleusermedia.constraints.md +++ b/docs/simple-user/sip.js.simpleusermedia.constraints.md @@ -4,10 +4,15 @@ ## SimpleUserMedia.constraints property -Offer/Answer constraints determine of audio and/or video are utilized. If not specified, only audio is offered (audio is true, video is false). +Offer/Answer constraints determine if audio and/or video are utilized. If not specified, only audio is utilized (audio is true, video is false). Signature: ```typescript constraints?: SimpleUserMediaConstraints; ``` + +## Remarks + +Constraints are used when creating local media stream. If undefined, defaults to audio true and video false. If audio and video are false, media stream will have no tracks. + diff --git a/docs/simple-user/sip.js.simpleusermedia.md b/docs/simple-user/sip.js.simpleusermedia.md index 06bba83c2..fa711d8df 100644 --- a/docs/simple-user/sip.js.simpleusermedia.md +++ b/docs/simple-user/sip.js.simpleusermedia.md @@ -16,7 +16,7 @@ export interface SimpleUserMedia | Property | Type | Description | | --- | --- | --- | -| [constraints](./sip.js.simpleusermedia.constraints.md) | SimpleUserMediaConstraints | Offer/Answer constraints determine of audio and/or video are utilized. If not specified, only audio is offered (audio is true, video is false). | +| [constraints](./sip.js.simpleusermedia.constraints.md) | SimpleUserMediaConstraints | Offer/Answer constraints determine if audio and/or video are utilized. If not specified, only audio is utilized (audio is true, video is false). | | [local](./sip.js.simpleusermedia.local.md) | SimpleUserMediaLocal | HTML elements for local media streams. | | [remote](./sip.js.simpleusermedia.remote.md) | SimpleUserMediaRemote | Local HTML media elements. | diff --git a/etc/api/sip.js.api.md b/etc/api/sip.js.api.md index 7e2b6fbfc..3b0debce1 100644 --- a/etc/api/sip.js.api.md +++ b/etc/api/sip.js.api.md @@ -165,9 +165,7 @@ export interface InviterInviteOptions { requestDelegate?: OutgoingRequestDelegate; // Warning: (ae-forgotten-export) The symbol "RequestOptions" needs to be exported by the entry point index.d.ts requestOptions?: RequestOptions; - // (undocumented) sessionDescriptionHandlerModifiers?: Array; - // (undocumented) sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions; withoutSdp?: boolean; } @@ -191,7 +189,9 @@ export interface InviterOptions extends SessionOptions { // @deprecated (undocumented) rendertype?: string; sessionDescriptionHandlerModifiers?: Array; + sessionDescriptionHandlerModifiersReInvite?: Array; sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions; + sessionDescriptionHandlerOptionsReInvite?: SessionDescriptionHandlerOptions; } // @public @@ -481,10 +481,14 @@ export abstract class Session { protected rollbackOffer(): Promise; get sessionDescriptionHandler(): SessionDescriptionHandler | undefined; get sessionDescriptionHandlerFactory(): SessionDescriptionHandlerFactory; - // @internal (undocumented) - protected _sessionDescriptionHandlerModifiers: Array | undefined; - // @internal (undocumented) - protected _sessionDescriptionHandlerOptions: SessionDescriptionHandlerOptions | undefined; + get sessionDescriptionHandlerModifiers(): Array; + set sessionDescriptionHandlerModifiers(modifiers: Array); + get sessionDescriptionHandlerModifiersReInvite(): Array; + set sessionDescriptionHandlerModifiersReInvite(modifiers: Array); + get sessionDescriptionHandlerOptions(): SessionDescriptionHandlerOptions; + set sessionDescriptionHandlerOptions(options: SessionDescriptionHandlerOptions); + get sessionDescriptionHandlerOptionsReInvite(): SessionDescriptionHandlerOptions; + set sessionDescriptionHandlerOptionsReInvite(options: SessionDescriptionHandlerOptions); // @internal protected setAnswer(answer: Body, options: { sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions; @@ -566,9 +570,7 @@ export interface SessionInfoOptions { export interface SessionInviteOptions { requestDelegate?: OutgoingRequestDelegate; requestOptions?: RequestOptions; - // (undocumented) sessionDescriptionHandlerModifiers?: Array; - // (undocumented) sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions; withoutSdp?: boolean; } diff --git a/etc/session-description-handler/sip.js.api.md b/etc/session-description-handler/sip.js.api.md index 946e0ea15..30871175f 100644 --- a/etc/session-description-handler/sip.js.api.md +++ b/etc/session-description-handler/sip.js.api.md @@ -34,10 +34,13 @@ export interface PeerConnectionDelegate { // // @public export class SessionDescriptionHandler implements SessionDescriptionHandler_2 { - constructor(logger: Logger, mediaStreamFactory: MediaStreamFactory, sessionDescriptionHandlerConfiguration?: SessionDescriptionHandlerConfiguration | undefined); + constructor(logger: Logger, mediaStreamFactory: MediaStreamFactory, sessionDescriptionHandlerConfiguration?: SessionDescriptionHandlerConfiguration); protected applyModifiers(sdp: RTCSessionDescriptionInit, modifiers?: Array): Promise; close(): void; + protected createDataChannel(options?: SessionDescriptionHandlerOptions): Promise; protected createLocalOfferOrAnswer(options?: SessionDescriptionHandlerOptions): Promise; + get dataChannel(): RTCDataChannel | undefined; + protected _dataChannel: RTCDataChannel | undefined; // Warning: (ae-forgotten-export) The symbol "SessionDescriptionHandlerModifier" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "BodyAndContentType" needs to be exported by the entry point index.d.ts getDescription(options?: SessionDescriptionHandlerOptions, modifiers?: Array): Promise; @@ -45,39 +48,31 @@ export class SessionDescriptionHandler implements SessionDescriptionHandler_2 { protected getLocalSessionDescription(): Promise; hasDescription(contentType: string): boolean; holdModifier(sessionDescription: RTCSessionDescriptionInit): Promise; + protected iceGatheringComplete(): void; get localMediaStream(): MediaStream; - // (undocumented) protected _localMediaStream: MediaStream; // Warning: (ae-forgotten-export) The symbol "Logger" needs to be exported by the entry point index.d.ts - // - // (undocumented) protected logger: Logger; - // (undocumented) protected mediaStreamFactory: MediaStreamFactory; get peerConnection(): RTCPeerConnection | undefined; - // (undocumented) protected _peerConnection: RTCPeerConnection | undefined; - // (undocumented) - protected _peerConnectionConfiguration: RTCConfiguration | undefined; get peerConnectionDelegate(): PeerConnectionDelegate | undefined; set peerConnectionDelegate(delegate: PeerConnectionDelegate | undefined); - // (undocumented) protected _peerConnectionDelegate: PeerConnectionDelegate | undefined; get remoteMediaStream(): MediaStream; - // (undocumented) protected _remoteMediaStream: MediaStream; sendDtmf(tones: string, options?: { duration: number; interToneGap: number; }): boolean; - // (undocumented) - protected sessionDescriptionHandlerConfiguration?: SessionDescriptionHandlerConfiguration | undefined; + protected sessionDescriptionHandlerConfiguration?: SessionDescriptionHandlerConfiguration; setDescription(sdp: string, options?: SessionDescriptionHandlerOptions, modifiers?: Array): Promise; - protected setLocalMediaStream(stream: MediaStream): void; + protected setLocalMediaStream(stream: MediaStream): Promise; protected setLocalSessionDescription(sessionDescription: RTCSessionDescriptionInit): Promise; protected setRemoteSessionDescription(sessionDescription: RTCSessionDescriptionInit): Promise; protected setRemoteTrack(track: MediaStreamTrack): void; - } + protected waitForIceGatheringComplete(restart?: boolean, timeout?: number): Promise; +} // @public export interface SessionDescriptionHandlerConfiguration { @@ -102,8 +97,12 @@ export type SessionDescriptionHandlerFactoryOptions = SessionDescriptionHandlerC export interface SessionDescriptionHandlerOptions extends SessionDescriptionHandlerOptions_2 { answerOptions?: RTCAnswerOptions; constraints?: MediaStreamConstraints; + dataChannel?: boolean; + dataChannelLabel?: string; + dataChannelOptions?: RTCDataChannelInit; iceGatheringTimeout?: number; offerOptions?: RTCOfferOptions; + onDataChannel?: (dataChannel: RTCDataChannel) => void; }