Skip to content

Commit

Permalink
chore: update doc generator links (#384)
Browse files Browse the repository at this point in the history
* chore: update doc generator links

* chore: removed empty links
  • Loading branch information
farhat-ha authored Oct 16, 2024
1 parent e0299f9 commit c778de2
Show file tree
Hide file tree
Showing 7 changed files with 188 additions and 198 deletions.
12 changes: 5 additions & 7 deletions packages/js/docs/ts/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# @telnyx/webrtc

## Table of contents

### Call Classes

- [Call](classes/Call.md)
- [Call](/docs/voice/webrtc/js-sdk/classes/Call.md)

### Client Classes

- [TelnyxRTC](classes/TelnyxRTC.md)
- [TelnyxRTC](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md)

### Notification Interfaces

- [INotification](interfaces/INotification.md)
- [INotification](/docs/voice/webrtc/js-sdk/interfaces/INotification.md)

### Other Interfaces

- [ICallOptions](interfaces/ICallOptions.md)
- [IClientOptions](interfaces/IClientOptions.md)
- [ICallOptions](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md)
- [IClientOptions](/docs/voice/webrtc/js-sdk/interfaces/IClientOptions.md)
102 changes: 50 additions & 52 deletions packages/js/docs/ts/classes/Call.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Class: Call

A `Call` is the representation of an audio or video call between
two browsers, SIP clients or phone numbers. The `call` object is
created whenever a new call is initiated, either by you or the
Expand Down Expand Up @@ -54,41 +52,41 @@ call.muteAudio();

### Properties

- [direction](Call.md#direction)
- [id](Call.md#id)
- [prevState](Call.md#prevstate)
- [state](Call.md#state)
- [direction](/docs/voice/webrtc/js-sdk/classes/Call.md#direction)
- [id](/docs/voice/webrtc/js-sdk/classes/Call.md#id)
- [prevState](/docs/voice/webrtc/js-sdk/classes/Call.md#prevstate)
- [state](/docs/voice/webrtc/js-sdk/classes/Call.md#state)

### Accessors

- [localStream](Call.md#localstream)
- [remoteStream](Call.md#remotestream)
- [telnyxIDs](Call.md#telnyxids)
- [localStream](/docs/voice/webrtc/js-sdk/classes/Call.md#localstream)
- [remoteStream](/docs/voice/webrtc/js-sdk/classes/Call.md#remotestream)
- [telnyxIDs](/docs/voice/webrtc/js-sdk/classes/Call.md#telnyxids)

### Methods

- [answer](Call.md#answer)
- [deaf](Call.md#deaf)
- [dtmf](Call.md#dtmf)
- [getStats](Call.md#getstats)
- [hold](Call.md#hold)
- [muteAudio](Call.md#muteaudio)
- [muteVideo](Call.md#mutevideo)
- [setAudioInDevice](Call.md#setaudioindevice)
- [setAudioOutDevice](Call.md#setaudiooutdevice)
- [setVideoDevice](Call.md#setvideodevice)
- [toggleAudioMute](Call.md#toggleaudiomute)
- [toggleDeaf](Call.md#toggledeaf)
- [toggleHold](Call.md#togglehold)
- [toggleVideoMute](Call.md#togglevideomute)
- [undeaf](Call.md#undeaf)
- [unhold](Call.md#unhold)
- [unmuteAudio](Call.md#unmuteaudio)
- [unmuteVideo](Call.md#unmutevideo)
- [answer](/docs/voice/webrtc/js-sdk/classes/Call.md#answer)
- [deaf](/docs/voice/webrtc/js-sdk/classes/Call.md#deaf)
- [dtmf](/docs/voice/webrtc/js-sdk/classes/Call.md#dtmf)
- [getStats](/docs/voice/webrtc/js-sdk/classes/Call.md#getstats)
- [hold](/docs/voice/webrtc/js-sdk/classes/Call.md#hold)
- [muteAudio](/docs/voice/webrtc/js-sdk/classes/Call.md#muteaudio)
- [muteVideo](/docs/voice/webrtc/js-sdk/classes/Call.md#mutevideo)
- [setAudioInDevice](/docs/voice/webrtc/js-sdk/classes/Call.md#setaudioindevice)
- [setAudioOutDevice](/docs/voice/webrtc/js-sdk/classes/Call.md#setaudiooutdevice)
- [setVideoDevice](/docs/voice/webrtc/js-sdk/classes/Call.md#setvideodevice)
- [toggleAudioMute](/docs/voice/webrtc/js-sdk/classes/Call.md#toggleaudiomute)
- [toggleDeaf](/docs/voice/webrtc/js-sdk/classes/Call.md#toggledeaf)
- [toggleHold](/docs/voice/webrtc/js-sdk/classes/Call.md#togglehold)
- [toggleVideoMute](/docs/voice/webrtc/js-sdk/classes/Call.md#togglevideomute)
- [undeaf](/docs/voice/webrtc/js-sdk/classes/Call.md#undeaf)
- [unhold](/docs/voice/webrtc/js-sdk/classes/Call.md#unhold)
- [unmuteAudio](/docs/voice/webrtc/js-sdk/classes/Call.md#unmuteaudio)
- [unmuteVideo](/docs/voice/webrtc/js-sdk/classes/Call.md#unmutevideo)

## Properties

### <a id="direction" name="direction"></a> direction
### direction

**direction**: `Direction`

Expand All @@ -101,7 +99,7 @@ BaseCall.direction

___

### <a id="id" name="id"></a> id
### id

**id**: `string` = `''`

Expand All @@ -113,7 +111,7 @@ BaseCall.id

___

### <a id="prevstate" name="prevstate"></a> prevState
### prevState

**prevState**: `string` = `''`

Expand All @@ -126,7 +124,7 @@ BaseCall.prevState

___

### <a id="state" name="state"></a> state
### state

**state**: `string`

Expand All @@ -153,7 +151,7 @@ BaseCall.state

## Accessors

### <a id="localstream" name="localstream"></a> localStream
### localStream

`get` **localStream**(): `MediaStream`

Expand All @@ -178,7 +176,7 @@ BaseCall.localStream

___

### <a id="remotestream" name="remotestream"></a> remoteStream
### remoteStream

`get` **remoteStream**(): `MediaStream`

Expand All @@ -203,7 +201,7 @@ BaseCall.remoteStream

___

### <a id="telnyxids" name="telnyxids"></a> telnyxIDs
### telnyxIDs

`get` **telnyxIDs**(): `Object`

Expand Down Expand Up @@ -232,7 +230,7 @@ BaseCall.telnyxIDs

## Methods

### <a id="answer" name="answer"></a> answer
### answer

**answer**(`params?`): `Promise`\<`void`\>

Expand Down Expand Up @@ -260,7 +258,7 @@ BaseCall.answer

___

### <a id="deaf" name="deaf"></a> deaf
### deaf

**deaf**(): `void`

Expand All @@ -282,7 +280,7 @@ BaseCall.deaf

___

### <a id="dtmf" name="dtmf"></a> dtmf
### dtmf

**dtmf**(`dtmf`): `void`

Expand Down Expand Up @@ -313,7 +311,7 @@ BaseCall.dtmf

___

### <a id="getstats" name="getstats"></a> getStats
### getStats

**getStats**(`callback`, `constraints`): `void`

Expand All @@ -336,7 +334,7 @@ BaseCall.getStats

___

### <a id="hold" name="hold"></a> hold
### hold

**hold**(): `Promise`\<`any`\>

Expand Down Expand Up @@ -371,7 +369,7 @@ BaseCall.hold

___

### <a id="muteaudio" name="muteaudio"></a> muteAudio
### muteAudio

**muteAudio**(): `void`

Expand All @@ -394,7 +392,7 @@ BaseCall.muteAudio

___

### <a id="mutevideo" name="mutevideo"></a> muteVideo
### muteVideo

**muteVideo**(): `void`

Expand All @@ -417,7 +415,7 @@ BaseCall.muteVideo

___

### <a id="setaudioindevice" name="setaudioindevice"></a> setAudioInDevice
### setAudioInDevice

**setAudioInDevice**(`deviceId`): `Promise`\<`void`\>

Expand Down Expand Up @@ -467,7 +465,7 @@ BaseCall.setAudioInDevice

___

### <a id="setaudiooutdevice" name="setaudiooutdevice"></a> setAudioOutDevice
### setAudioOutDevice

**setAudioOutDevice**(`deviceId`): `Promise`\<`boolean`\>

Expand Down Expand Up @@ -513,7 +511,7 @@ if (result.length) {

___

### <a id="setvideodevice" name="setvideodevice"></a> setVideoDevice
### setVideoDevice

**setVideoDevice**(`deviceId`): `Promise`\<`void`\>

Expand Down Expand Up @@ -563,7 +561,7 @@ BaseCall.setVideoDevice

___

### <a id="toggleaudiomute" name="toggleaudiomute"></a> toggleAudioMute
### toggleAudioMute

**toggleAudioMute**(): `void`

Expand All @@ -585,7 +583,7 @@ BaseCall.toggleAudioMute

___

### <a id="toggledeaf" name="toggledeaf"></a> toggleDeaf
### toggleDeaf

**toggleDeaf**(): `void`

Expand All @@ -607,7 +605,7 @@ BaseCall.toggleDeaf

___

### <a id="togglehold" name="togglehold"></a> toggleHold
### toggleHold

**toggleHold**(): `Promise`\<`any`\>

Expand Down Expand Up @@ -637,7 +635,7 @@ BaseCall.toggleHold

___

### <a id="togglevideomute" name="togglevideomute"></a> toggleVideoMute
### toggleVideoMute

**toggleVideoMute**(): `void`

Expand All @@ -659,7 +657,7 @@ BaseCall.toggleVideoMute

___

### <a id="undeaf" name="undeaf"></a> undeaf
### undeaf

**undeaf**(): `void`

Expand All @@ -681,7 +679,7 @@ BaseCall.undeaf

___

### <a id="unhold" name="unhold"></a> unhold
### unhold

**unhold**(): `Promise`\<`any`\>

Expand Down Expand Up @@ -716,7 +714,7 @@ BaseCall.unhold

___

### <a id="unmuteaudio" name="unmuteaudio"></a> unmuteAudio
### unmuteAudio

**unmuteAudio**(): `void`

Expand All @@ -739,7 +737,7 @@ BaseCall.unmuteAudio

___

### <a id="unmutevideo" name="unmutevideo"></a> unmuteVideo
### unmuteVideo

**unmuteVideo**(): `void`

Expand Down
Loading

0 comments on commit c778de2

Please sign in to comment.