Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
John Riordan committed Jun 11, 2020
1 parent 1938930 commit 185d128
Show file tree
Hide file tree
Showing 55 changed files with 368 additions and 78 deletions.
4 changes: 2 additions & 2 deletions docs/api/sip.js.invitationacceptoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ export interface InvitationAcceptOptions

| Property | Type | Description |
| --- | --- | --- |
| [sessionDescriptionHandlerModifiers](./sip.js.invitationacceptoptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | Modifiers to pass to SessionDescriptionHandler's getDescription() and setDescription(). |
| [sessionDescriptionHandlerOptions](./sip.js.invitationacceptoptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | Options to pass to SessionDescriptionHandler's getDescription() and setDescription(). |
| [sessionDescriptionHandlerModifiers](./sip.js.invitationacceptoptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. |
| [sessionDescriptionHandlerOptions](./sip.js.invitationacceptoptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | Options to pass to SessionDescriptionHandler during the initial INVITE transaction. |

Original file line number Diff line number Diff line change
Expand Up @@ -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.

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<b>Signature:</b>

Expand Down
4 changes: 2 additions & 2 deletions docs/api/sip.js.invitationprogressoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export interface InvitationProgressOptions
| [extraHeaders](./sip.js.invitationprogressoptions.extraheaders.md) | <code>Array&lt;string&gt;</code> | Array of extra headers added to the response. |
| [reasonPhrase](./sip.js.invitationprogressoptions.reasonphrase.md) | <code>string</code> | Reason phrase for response. |
| [rel100](./sip.js.invitationprogressoptions.rel100.md) | <code>boolean</code> | Send reliable response. |
| [sessionDescriptionHandlerModifiers](./sip.js.invitationprogressoptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | Modifiers to pass to SessionDescriptionHandler's getDescription() and setDescription(). |
| [sessionDescriptionHandlerOptions](./sip.js.invitationprogressoptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | Options to pass to SessionDescriptionHandler's getDescription() and setDescription(). |
| [sessionDescriptionHandlerModifiers](./sip.js.invitationprogressoptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. |
| [sessionDescriptionHandlerOptions](./sip.js.invitationprogressoptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | Options to pass to SessionDescriptionHandler during the initial INVITE transaction. |
| [statusCode](./sip.js.invitationprogressoptions.statuscode.md) | <code>number</code> | Status code for response. |

Original file line number Diff line number Diff line change
Expand Up @@ -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.

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<b>Signature:</b>

Expand Down
4 changes: 2 additions & 2 deletions docs/api/sip.js.inviterinviteoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export interface InviterInviteOptions
| --- | --- | --- |
| [requestDelegate](./sip.js.inviterinviteoptions.requestdelegate.md) | <code>OutgoingRequestDelegate</code> | See <code>core</code> API. |
| [requestOptions](./sip.js.inviterinviteoptions.requestoptions.md) | <code>RequestOptions</code> | See <code>core</code> API. |
| [sessionDescriptionHandlerModifiers](./sip.js.inviterinviteoptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | |
| [sessionDescriptionHandlerOptions](./sip.js.inviterinviteoptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | |
| [sessionDescriptionHandlerModifiers](./sip.js.inviterinviteoptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. |
| [sessionDescriptionHandlerOptions](./sip.js.inviterinviteoptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | Options to pass to SessionDescriptionHandler during the initial INVITE transaction. |
| [withoutSdp](./sip.js.inviterinviteoptions.withoutsdp.md) | <code>boolean</code> | If true, send INVITE without SDP. Default is false. |

Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## InviterInviteOptions.sessionDescriptionHandlerModifiers property

Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction.

<b>Signature:</b>

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## InviterInviteOptions.sessionDescriptionHandlerOptions property

Options to pass to SessionDescriptionHandler during the initial INVITE transaction.

<b>Signature:</b>

```typescript
Expand Down
6 changes: 4 additions & 2 deletions docs/api/sip.js.inviteroptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ export interface InviterOptions extends SessionOptions
| [params](./sip.js.inviteroptions.params.md) | <code>{</code><br/><code> fromDisplayName?: string;</code><br/><code> fromTag?: string;</code><br/><code> fromUri?: string &#124; URI;</code><br/><code> toDisplayName?: string;</code><br/><code> toUri?: string &#124; URI;</code><br/><code> }</code> | |
| [renderbody](./sip.js.inviteroptions.renderbody.md) | <code>string</code> | |
| [rendertype](./sip.js.inviteroptions.rendertype.md) | <code>string</code> | |
| [sessionDescriptionHandlerModifiers](./sip.js.inviteroptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | Modifiers to pass to SessionDescriptionHandler's getDescription() and setDescription(). |
| [sessionDescriptionHandlerOptions](./sip.js.inviteroptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | Options to pass to SessionDescriptionHandler's getDescription() and setDescription(). |
| [sessionDescriptionHandlerModifiers](./sip.js.inviteroptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. |
| [sessionDescriptionHandlerModifiersReInvite](./sip.js.inviteroptions.sessiondescriptionhandlermodifiersreinvite.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | Modifiers to pass to SessionDescriptionHandler during re-INVITE transactions. |
| [sessionDescriptionHandlerOptions](./sip.js.inviteroptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | Options to pass to SessionDescriptionHandler during the initial INVITE transaction. |
| [sessionDescriptionHandlerOptionsReInvite](./sip.js.inviteroptions.sessiondescriptionhandleroptionsreinvite.md) | <code>SessionDescriptionHandlerOptions</code> | Options to pass to SessionDescriptionHandler during re-INVITE transactions. |
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<b>Signature:</b>

Expand Down
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) &gt; [sip.js](./sip.js.md) &gt; [InviterOptions](./sip.js.inviteroptions.md) &gt; [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>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<b>Signature:</b>

Expand Down
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) &gt; [sip.js](./sip.js.md) &gt; [InviterOptions](./sip.js.inviteroptions.md) &gt; [sessionDescriptionHandlerOptionsReInvite](./sip.js.inviteroptions.sessiondescriptionhandleroptionsreinvite.md)

## InviterOptions.sessionDescriptionHandlerOptionsReInvite property

Options to pass to SessionDescriptionHandler during re-INVITE transactions.

<b>Signature:</b>

```typescript
sessionDescriptionHandlerOptionsReInvite?: SessionDescriptionHandlerOptions;
```
4 changes: 4 additions & 0 deletions docs/api/sip.js.session.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ The constructor for this class is marked as internal. Third-party code should no
| [replacee](./sip.js.session.replacee.md) | | <code>Session &#124; undefined</code> | The session being replace by this one. |
| [sessionDescriptionHandler](./sip.js.session.sessiondescriptionhandler.md) | | <code>SessionDescriptionHandler &#124; undefined</code> | Session description handler. |
| [sessionDescriptionHandlerFactory](./sip.js.session.sessiondescriptionhandlerfactory.md) | | <code>SessionDescriptionHandlerFactory</code> | Session description handler factory. |
| [sessionDescriptionHandlerModifiers](./sip.js.session.sessiondescriptionhandlermodifiers.md) | | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | SDH modifiers for the initial INVITE transaction. |
| [sessionDescriptionHandlerModifiersReInvite](./sip.js.session.sessiondescriptionhandlermodifiersreinvite.md) | | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | SDH modifiers for re-INVITE transactions. |
| [sessionDescriptionHandlerOptions](./sip.js.session.sessiondescriptionhandleroptions.md) | | <code>SessionDescriptionHandlerOptions</code> | SDH options for the initial INVITE transaction. |
| [sessionDescriptionHandlerOptionsReInvite](./sip.js.session.sessiondescriptionhandleroptionsreinvite.md) | | <code>SessionDescriptionHandlerOptions</code> | SDH options for re-INVITE transactions. |
| [state](./sip.js.session.state.md) | | <code>SessionState</code> | Session state. |
| [stateChange](./sip.js.session.statechange.md) | | <code>Emitter&lt;SessionState&gt;</code> | Session state change emitter. |
| [userAgent](./sip.js.session.useragent.md) | | <code>UserAgent</code> | The user agent. |
Expand Down
20 changes: 20 additions & 0 deletions docs/api/sip.js.session.sessiondescriptionhandlermodifiers.md
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) &gt; [sip.js](./sip.js.md) &gt; [Session](./sip.js.session.md) &gt; [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().

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) &gt; [sip.js](./sip.js.md) &gt; [Session](./sip.js.session.md) &gt; [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 docs/api/sip.js.session.sessiondescriptionhandleroptions.md
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) &gt; [sip.js](./sip.js.md) &gt; [Session](./sip.js.session.md) &gt; [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().

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) &gt; [sip.js](./sip.js.md) &gt; [Session](./sip.js.session.md) &gt; [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().

4 changes: 2 additions & 2 deletions docs/api/sip.js.sessioninviteoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export interface SessionInviteOptions
| --- | --- | --- |
| [requestDelegate](./sip.js.sessioninviteoptions.requestdelegate.md) | <code>OutgoingRequestDelegate</code> | See <code>core</code> API. |
| [requestOptions](./sip.js.sessioninviteoptions.requestoptions.md) | <code>RequestOptions</code> | See <code>core</code> API. |
| [sessionDescriptionHandlerModifiers](./sip.js.sessioninviteoptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | |
| [sessionDescriptionHandlerOptions](./sip.js.sessioninviteoptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | |
| [sessionDescriptionHandlerModifiers](./sip.js.sessioninviteoptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | Modifiers to pass to SessionDescriptionHandler during re-INVITE transaction. |
| [sessionDescriptionHandlerOptions](./sip.js.sessioninviteoptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | Options to pass to SessionDescriptionHandler during re-INVITE transaction. |
| [withoutSdp](./sip.js.sessioninviteoptions.withoutsdp.md) | <code>boolean</code> | If true, send INVITE without SDP. Default is false. |

Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## SessionInviteOptions.sessionDescriptionHandlerModifiers property

Modifiers to pass to SessionDescriptionHandler during re-INVITE transaction.

<b>Signature:</b>

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## SessionInviteOptions.sessionDescriptionHandlerOptions property

Options to pass to SessionDescriptionHandler during re-INVITE transaction.

<b>Signature:</b>

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Constructor
<b>Signature:</b>

```typescript
constructor(logger: Logger, mediaStreamFactory: MediaStreamFactory, sessionDescriptionHandlerConfiguration?: SessionDescriptionHandlerConfiguration | undefined);
constructor(logger: Logger, mediaStreamFactory: MediaStreamFactory, sessionDescriptionHandlerConfiguration?: SessionDescriptionHandlerConfiguration);
```

## Parameters
Expand All @@ -18,5 +18,5 @@ constructor(logger: Logger, mediaStreamFactory: MediaStreamFactory, sessionDescr
| --- | --- | --- |
| logger | <code>Logger</code> | A logger |
| mediaStreamFactory | <code>MediaStreamFactory</code> | A factory to provide a MediaStream |
| sessionDescriptionHandlerConfiguration | <code>SessionDescriptionHandlerConfiguration &#124; undefined</code> | |
| sessionDescriptionHandlerConfiguration | <code>SessionDescriptionHandlerConfiguration</code> | |

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) &gt; [sip.js](./sip.js.md) &gt; [SessionDescriptionHandler](./sip.js.sessiondescriptionhandler.md) &gt; [\_dataChannel](./sip.js.sessiondescriptionhandler._datachannel.md)

## SessionDescriptionHandler.\_dataChannel property

The data channel. Undefined before created.

<b>Signature:</b>

```typescript
protected _dataChannel: RTCDataChannel | undefined;
```
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## SessionDescriptionHandler.\_localMediaStream property

The local media stream.

<b>Signature:</b>

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## SessionDescriptionHandler.\_peerConnection property

The peer conneciton. Undefined after SessionDesriptionHandler.close().

<b>Signature:</b>

```typescript
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## SessionDescriptionHandler.\_peerConnectionDelegate property

The peer conneciton delegate.

<b>Signature:</b>

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## SessionDescriptionHandler.\_remoteMediaStream property

The remote media stream.

<b>Signature:</b>

```typescript
Expand Down
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) &gt; [sip.js](./sip.js.md) &gt; [SessionDescriptionHandler](./sip.js.sessiondescriptionhandler.md) &gt; [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.

Loading

0 comments on commit 185d128

Please sign in to comment.