forked from onsip/SIP.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
John Riordan
committed
Jun 11, 2020
1 parent
1938930
commit 185d128
Showing
55 changed files
with
368 additions
and
78 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
docs/api/sip.js.inviteroptions.sessiondescriptionhandlermodifiersreinvite.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
sessionDescriptionHandlerModifiersReInvite?: Array<SessionDescriptionHandlerModifier>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
docs/api/sip.js.inviteroptions.sessiondescriptionhandleroptionsreinvite.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
sessionDescriptionHandlerOptionsReInvite?: SessionDescriptionHandlerOptions; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
20 changes: 20 additions & 0 deletions
20
docs/api/sip.js.session.sessiondescriptionhandlermodifiers.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
get sessionDescriptionHandlerModifiers(): Array<SessionDescriptionHandlerModifier>; | ||
|
||
set sessionDescriptionHandlerModifiers(modifiers: Array<SessionDescriptionHandlerModifier>); | ||
``` | ||
|
||
## 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(). | ||
|
20 changes: 20 additions & 0 deletions
20
docs/api/sip.js.session.sessiondescriptionhandlermodifiersreinvite.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
get sessionDescriptionHandlerModifiersReInvite(): Array<SessionDescriptionHandlerModifier>; | ||
|
||
set sessionDescriptionHandlerModifiersReInvite(modifiers: Array<SessionDescriptionHandlerModifier>); | ||
``` | ||
|
||
## 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(). | ||
|
20 changes: 20 additions & 0 deletions
20
docs/api/sip.js.session.sessiondescriptionhandleroptions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```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(). | ||
|
20 changes: 20 additions & 0 deletions
20
docs/api/sip.js.session.sessiondescriptionhandleroptionsreinvite.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```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(). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
docs/session-description-handler/sip.js.sessiondescriptionhandler._datachannel.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
protected _dataChannel: RTCDataChannel | undefined; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 0 additions & 11 deletions
11
...iption-handler/sip.js.sessiondescriptionhandler._peerconnectionconfiguration.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 28 additions & 0 deletions
28
...ssion-description-handler/sip.js.sessiondescriptionhandler.createdatachannel.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
protected createDataChannel(options?: SessionDescriptionHandlerOptions): Promise<void>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| options | <code>SessionDescriptionHandlerOptions</code> | Session description handler options. | | ||
|
||
<b>Returns:</b> | ||
|
||
`Promise<void>` | ||
|
||
## 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. | ||
|
Oops, something went wrong.