From c778de246a27f5f902487477a5d448743bbe6ec4 Mon Sep 17 00:00:00 2001 From: Haythem Farhat Date: Wed, 16 Oct 2024 16:15:21 +0200 Subject: [PATCH] chore: update doc generator links (#384) * chore: update doc generator links * chore: removed empty links --- packages/js/docs/ts/README.md | 12 +- packages/js/docs/ts/classes/Call.md | 102 +++++++------- packages/js/docs/ts/classes/TelnyxRTC.md | 130 +++++++++--------- .../js/docs/ts/interfaces/ICallOptions.md | 102 +++++++------- .../js/docs/ts/interfaces/IClientOptions.md | 22 ++- .../js/docs/ts/interfaces/INotification.md | 14 +- packages/js/typedoc.json | 4 +- 7 files changed, 188 insertions(+), 198 deletions(-) diff --git a/packages/js/docs/ts/README.md b/packages/js/docs/ts/README.md index c0d7ee5b..1dc4f2eb 100644 --- a/packages/js/docs/ts/README.md +++ b/packages/js/docs/ts/README.md @@ -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) diff --git a/packages/js/docs/ts/classes/Call.md b/packages/js/docs/ts/classes/Call.md index 40ffd720..c63011f7 100644 --- a/packages/js/docs/ts/classes/Call.md +++ b/packages/js/docs/ts/classes/Call.md @@ -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 @@ -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 -### direction +### direction • **direction**: `Direction` @@ -101,7 +99,7 @@ BaseCall.direction ___ -### id +### id • **id**: `string` = `''` @@ -113,7 +111,7 @@ BaseCall.id ___ -### prevState +### prevState • **prevState**: `string` = `''` @@ -126,7 +124,7 @@ BaseCall.prevState ___ -### state +### state • **state**: `string` @@ -153,7 +151,7 @@ BaseCall.state ## Accessors -### localStream +### localStream • `get` **localStream**(): `MediaStream` @@ -178,7 +176,7 @@ BaseCall.localStream ___ -### remoteStream +### remoteStream • `get` **remoteStream**(): `MediaStream` @@ -203,7 +201,7 @@ BaseCall.remoteStream ___ -### telnyxIDs +### telnyxIDs • `get` **telnyxIDs**(): `Object` @@ -232,7 +230,7 @@ BaseCall.telnyxIDs ## Methods -### answer +### answer ▸ **answer**(`params?`): `Promise`\<`void`\> @@ -260,7 +258,7 @@ BaseCall.answer ___ -### deaf +### deaf ▸ **deaf**(): `void` @@ -282,7 +280,7 @@ BaseCall.deaf ___ -### dtmf +### dtmf ▸ **dtmf**(`dtmf`): `void` @@ -313,7 +311,7 @@ BaseCall.dtmf ___ -### getStats +### getStats ▸ **getStats**(`callback`, `constraints`): `void` @@ -336,7 +334,7 @@ BaseCall.getStats ___ -### hold +### hold ▸ **hold**(): `Promise`\<`any`\> @@ -371,7 +369,7 @@ BaseCall.hold ___ -### muteAudio +### muteAudio ▸ **muteAudio**(): `void` @@ -394,7 +392,7 @@ BaseCall.muteAudio ___ -### muteVideo +### muteVideo ▸ **muteVideo**(): `void` @@ -417,7 +415,7 @@ BaseCall.muteVideo ___ -### setAudioInDevice +### setAudioInDevice ▸ **setAudioInDevice**(`deviceId`): `Promise`\<`void`\> @@ -467,7 +465,7 @@ BaseCall.setAudioInDevice ___ -### setAudioOutDevice +### setAudioOutDevice ▸ **setAudioOutDevice**(`deviceId`): `Promise`\<`boolean`\> @@ -513,7 +511,7 @@ if (result.length) { ___ -### setVideoDevice +### setVideoDevice ▸ **setVideoDevice**(`deviceId`): `Promise`\<`void`\> @@ -563,7 +561,7 @@ BaseCall.setVideoDevice ___ -### toggleAudioMute +### toggleAudioMute ▸ **toggleAudioMute**(): `void` @@ -585,7 +583,7 @@ BaseCall.toggleAudioMute ___ -### toggleDeaf +### toggleDeaf ▸ **toggleDeaf**(): `void` @@ -607,7 +605,7 @@ BaseCall.toggleDeaf ___ -### toggleHold +### toggleHold ▸ **toggleHold**(): `Promise`\<`any`\> @@ -637,7 +635,7 @@ BaseCall.toggleHold ___ -### toggleVideoMute +### toggleVideoMute ▸ **toggleVideoMute**(): `void` @@ -659,7 +657,7 @@ BaseCall.toggleVideoMute ___ -### undeaf +### undeaf ▸ **undeaf**(): `void` @@ -681,7 +679,7 @@ BaseCall.undeaf ___ -### unhold +### unhold ▸ **unhold**(): `Promise`\<`any`\> @@ -716,7 +714,7 @@ BaseCall.unhold ___ -### unmuteAudio +### unmuteAudio ▸ **unmuteAudio**(): `void` @@ -739,7 +737,7 @@ BaseCall.unmuteAudio ___ -### unmuteVideo +### unmuteVideo ▸ **unmuteVideo**(): `void` diff --git a/packages/js/docs/ts/classes/TelnyxRTC.md b/packages/js/docs/ts/classes/TelnyxRTC.md index bc325970..e55c4028 100644 --- a/packages/js/docs/ts/classes/TelnyxRTC.md +++ b/packages/js/docs/ts/classes/TelnyxRTC.md @@ -1,5 +1,3 @@ -# Class: TelnyxRTC - The `TelnyxRTC` client connects your application to the Telnyx backend, enabling you to make outgoing calls and handle incoming calls. @@ -44,44 +42,44 @@ client.off('telnyx.notification'); ### Constructors -- [constructor](TelnyxRTC.md#constructor) +- [constructor](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#constructor) ### Accessors -- [connected](TelnyxRTC.md#connected) -- [localElement](TelnyxRTC.md#localelement) -- [mediaConstraints](TelnyxRTC.md#mediaconstraints) -- [remoteElement](TelnyxRTC.md#remoteelement) -- [speaker](TelnyxRTC.md#speaker) +- [connected](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#connected) +- [localElement](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#localelement) +- [mediaConstraints](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#mediaconstraints) +- [remoteElement](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#remoteelement) +- [speaker](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#speaker) ### Methods -- [checkPermissions](TelnyxRTC.md#checkpermissions) -- [connect](TelnyxRTC.md#connect) -- [disableMicrophone](TelnyxRTC.md#disablemicrophone) -- [disableWebcam](TelnyxRTC.md#disablewebcam) -- [disconnect](TelnyxRTC.md#disconnect) -- [enableMicrophone](TelnyxRTC.md#enablemicrophone) -- [enableWebcam](TelnyxRTC.md#enablewebcam) -- [getAudioInDevices](TelnyxRTC.md#getaudioindevices) -- [getAudioOutDevices](TelnyxRTC.md#getaudiooutdevices) -- [getDeviceResolutions](TelnyxRTC.md#getdeviceresolutions) -- [getDevices](TelnyxRTC.md#getdevices) -- [getIsRegistered](TelnyxRTC.md#getisregistered) -- [getVideoDevices](TelnyxRTC.md#getvideodevices) -- [logout](TelnyxRTC.md#logout) -- [newCall](TelnyxRTC.md#newcall) -- [off](TelnyxRTC.md#off) -- [on](TelnyxRTC.md#on) -- [onNetworkClose](TelnyxRTC.md#onnetworkclose) -- [setAudioSettings](TelnyxRTC.md#setaudiosettings) -- [setVideoSettings](TelnyxRTC.md#setvideosettings) -- [webRTCInfo](TelnyxRTC.md#webrtcinfo) -- [webRTCSupportedBrowserList](TelnyxRTC.md#webrtcsupportedbrowserlist) +- [checkPermissions](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#checkpermissions) +- [connect](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#connect) +- [disableMicrophone](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#disablemicrophone) +- [disableWebcam](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#disablewebcam) +- [disconnect](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#disconnect) +- [enableMicrophone](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#enablemicrophone) +- [enableWebcam](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#enablewebcam) +- [getAudioInDevices](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#getaudioindevices) +- [getAudioOutDevices](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#getaudiooutdevices) +- [getDeviceResolutions](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#getdeviceresolutions) +- [getDevices](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#getdevices) +- [getIsRegistered](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#getisregistered) +- [getVideoDevices](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#getvideodevices) +- [logout](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#logout) +- [newCall](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#newcall) +- [off](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#off) +- [on](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#on) +- [onNetworkClose](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#onnetworkclose) +- [setAudioSettings](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#setaudiosettings) +- [setVideoSettings](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#setvideosettings) +- [webRTCInfo](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#webrtcinfo) +- [webRTCSupportedBrowserList](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md#webrtcsupportedbrowserlist) ## Constructors -### constructor +### constructor • **new TelnyxRTC**(`options`) @@ -91,7 +89,7 @@ Creates a new `TelnyxRTC` instance with the provided options. | Name | Type | Description | | :------ | :------ | :------ | -| `options` | [`IClientOptions`](../interfaces/IClientOptions.md) | Options for initializing a client | +| `options` | [`IClientOptions`](/docs/voice/webrtc/js-sdk/interfaces/IClientOptions.md) | Options for initializing a client | **`Examples`** @@ -149,7 +147,7 @@ TelnyxRTCClient.constructor ## Accessors -### connected +### connected • `get` **connected**(): `boolean` @@ -172,7 +170,7 @@ TelnyxRTCClient.connected ___ -### localElement +### localElement • `get` **localElement**(): `string` \| `Function` \| `HTMLMediaElement` @@ -222,7 +220,7 @@ TelnyxRTCClient.localElement ___ -### mediaConstraints +### mediaConstraints • `get` **mediaConstraints**(): `Object` @@ -252,7 +250,7 @@ TelnyxRTCClient.mediaConstraints ___ -### remoteElement +### remoteElement • `get` **remoteElement**(): `string` \| `Function` \| `HTMLMediaElement` @@ -302,7 +300,7 @@ TelnyxRTCClient.remoteElement ___ -### speaker +### speaker • `get` **speaker**(): `string` @@ -355,7 +353,7 @@ TelnyxRTCClient.speaker ## Methods -### checkPermissions +### checkPermissions ▸ **checkPermissions**(`audio?`, `video?`): `Promise`\<`boolean`\> @@ -404,7 +402,7 @@ TelnyxRTCClient.checkPermissions ___ -### connect +### connect ▸ **connect**(): `Promise`\<`void`\> @@ -428,7 +426,7 @@ TelnyxRTCClient.connect ___ -### disableMicrophone +### disableMicrophone ▸ **disableMicrophone**(): `void` @@ -469,7 +467,7 @@ TelnyxRTCClient.disableMicrophone ___ -### disableWebcam +### disableWebcam ▸ **disableWebcam**(): `void` @@ -504,7 +502,7 @@ TelnyxRTCClient.disableWebcam ___ -### disconnect +### disconnect ▸ **disconnect**(): `Promise`\<`void`\> @@ -528,7 +526,7 @@ TelnyxRTCClient.disconnect ___ -### enableMicrophone +### enableMicrophone ▸ **enableMicrophone**(): `void` @@ -555,7 +553,7 @@ TelnyxRTCClient.enableMicrophone ___ -### enableWebcam +### enableWebcam ▸ **enableWebcam**(): `void` @@ -582,7 +580,7 @@ TelnyxRTCClient.enableWebcam ___ -### getAudioInDevices +### getAudioInDevices ▸ **getAudioInDevices**(): `Promise`\<`MediaDeviceInfo`[]\> @@ -622,7 +620,7 @@ TelnyxRTCClient.getAudioInDevices ___ -### getAudioOutDevices +### getAudioOutDevices ▸ **getAudioOutDevices**(): `Promise`\<`MediaDeviceInfo`[]\> @@ -667,7 +665,7 @@ TelnyxRTCClient.getAudioOutDevices ___ -### getDeviceResolutions +### getDeviceResolutions ▸ **getDeviceResolutions**(`deviceId`): `Promise`\<`any`[]\> @@ -739,7 +737,7 @@ TelnyxRTCClient.getDeviceResolutions ___ -### getDevices +### getDevices ▸ **getDevices**(): `Promise`\<`MediaDeviceInfo`[]\> @@ -775,7 +773,7 @@ TelnyxRTCClient.getDevices ___ -### getIsRegistered +### getIsRegistered ▸ **getIsRegistered**(): `Promise`\<`boolean`\> @@ -793,7 +791,7 @@ TelnyxRTCClient.getIsRegistered ___ -### getVideoDevices +### getVideoDevices ▸ **getVideoDevices**(): `Promise`\<`MediaDeviceInfo`[]\> @@ -831,7 +829,7 @@ TelnyxRTCClient.getVideoDevices ___ -### logout +### logout ▸ **logout**(): `void` @@ -849,9 +847,9 @@ TelnyxRTCClient.logout ___ -### newCall +### newCall -▸ **newCall**(`options`): [`Call`](Call.md) +▸ **newCall**(`options`): [`Call`](/docs/voice/webrtc/js-sdk/classes/Call.md) Makes a new outbound call. @@ -859,11 +857,11 @@ Makes a new outbound call. | Name | Type | Description | | :------ | :------ | :------ | -| `options` | [`ICallOptions`](../interfaces/ICallOptions.md) | Options object for a new call. | +| `options` | [`ICallOptions`](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md) | Options object for a new call. | #### Returns -[`Call`](Call.md) +[`Call`](/docs/voice/webrtc/js-sdk/classes/Call.md) The new outbound `Call` object. @@ -939,9 +937,9 @@ TelnyxRTCClient.newCall ___ -### off +### off -▸ **off**(`eventName`, `callback?`): [`TelnyxRTC`](TelnyxRTC.md) +▸ **off**(`eventName`, `callback?`): [`TelnyxRTC`](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md) Removes an event handler that were attached with .on(). If no handler parameter is passed, all listeners for that event will be removed. @@ -955,7 +953,7 @@ If no handler parameter is passed, all listeners for that event will be removed. #### Returns -[`TelnyxRTC`](TelnyxRTC.md) +[`TelnyxRTC`](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md) The client object itself. @@ -985,9 +983,9 @@ TelnyxRTCClient.off ___ -### on +### on -▸ **on**(`eventName`, `callback`): [`TelnyxRTC`](TelnyxRTC.md) +▸ **on**(`eventName`, `callback`): [`TelnyxRTC`](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md) Attaches an event handler for a specific type of event. @@ -1011,7 +1009,7 @@ Attaches an event handler for a specific type of event. #### Returns -[`TelnyxRTC`](TelnyxRTC.md) +[`TelnyxRTC`](/docs/voice/webrtc/js-sdk/classes/TelnyxRTC.md) The client object itself. @@ -1035,7 +1033,7 @@ TelnyxRTCClient.on ___ -### onNetworkClose +### onNetworkClose ▸ **onNetworkClose**(): `void` @@ -1053,7 +1051,7 @@ TelnyxRTCClient.onNetworkClose ___ -### setAudioSettings +### setAudioSettings ▸ **setAudioSettings**(`settings`): `Promise`\<`MediaTrackConstraints`\> @@ -1098,7 +1096,7 @@ TelnyxRTCClient.setAudioSettings ___ -### setVideoSettings +### setVideoSettings ▸ **setVideoSettings**(`settings`): `Promise`\<`MediaTrackConstraints`\> @@ -1144,7 +1142,7 @@ TelnyxRTCClient.setVideoSettings ___ -### webRTCInfo +### webRTCInfo ▸ `Static` **webRTCInfo**(): `string` \| `IWebRTCInfo` @@ -1179,7 +1177,7 @@ if (!info.supportWebRTC) { ___ -### webRTCSupportedBrowserList +### webRTCSupportedBrowserList ▸ `Static` **webRTCSupportedBrowserList**(): `IWebRTCSupportedBrowser`[] diff --git a/packages/js/docs/ts/interfaces/ICallOptions.md b/packages/js/docs/ts/interfaces/ICallOptions.md index 91cd0c21..05039078 100644 --- a/packages/js/docs/ts/interfaces/ICallOptions.md +++ b/packages/js/docs/ts/interfaces/ICallOptions.md @@ -1,5 +1,3 @@ -# Interface: ICallOptions - ICallOptions ICallOptions @@ -7,35 +5,35 @@ ICallOptions ### Properties -- [audio](ICallOptions.md#audio) -- [callerName](ICallOptions.md#callername) -- [callerNumber](ICallOptions.md#callernumber) -- [camId](ICallOptions.md#camid) -- [clientState](ICallOptions.md#clientstate) -- [customHeaders](ICallOptions.md#customheaders) -- [debug](ICallOptions.md#debug) -- [debugOutput](ICallOptions.md#debugoutput) -- [destinationNumber](ICallOptions.md#destinationnumber) -- [iceServers](ICallOptions.md#iceservers) -- [id](ICallOptions.md#id) -- [localElement](ICallOptions.md#localelement) -- [localStream](ICallOptions.md#localstream) -- [mediaSettings](ICallOptions.md#mediasettings) -- [micId](ICallOptions.md#micid) -- [onNotification](ICallOptions.md#onnotification) -- [preferred\_codecs](ICallOptions.md#preferred_codecs) -- [remoteElement](ICallOptions.md#remoteelement) -- [remoteStream](ICallOptions.md#remotestream) -- [speakerId](ICallOptions.md#speakerid) -- [telnyxCallControlId](ICallOptions.md#telnyxcallcontrolid) -- [telnyxLegId](ICallOptions.md#telnyxlegid) -- [telnyxSessionId](ICallOptions.md#telnyxsessionid) -- [useStereo](ICallOptions.md#usestereo) -- [video](ICallOptions.md#video) +- [audio](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#audio) +- [callerName](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#callername) +- [callerNumber](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#callernumber) +- [camId](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#camid) +- [clientState](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#clientstate) +- [customHeaders](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#customheaders) +- [debug](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#debug) +- [debugOutput](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#debugoutput) +- [destinationNumber](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#destinationnumber) +- [iceServers](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#iceservers) +- [id](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#id) +- [localElement](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#localelement) +- [localStream](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#localstream) +- [mediaSettings](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#mediasettings) +- [micId](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#micid) +- [onNotification](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#onnotification) +- [preferred\_codecs](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#preferred_codecs) +- [remoteElement](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#remoteelement) +- [remoteStream](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#remotestream) +- [speakerId](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#speakerid) +- [telnyxCallControlId](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#telnyxcallcontrolid) +- [telnyxLegId](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#telnyxlegid) +- [telnyxSessionId](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#telnyxsessionid) +- [useStereo](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#usestereo) +- [video](/docs/voice/webrtc/js-sdk/interfaces/ICallOptions.md#video) ## Properties -### audio +### audio • `Optional` **audio**: `boolean` @@ -43,7 +41,7 @@ Overrides client's default audio constraints. Defaults to `true` ___ -### callerName +### callerName • `Optional` **callerName**: `string` @@ -51,7 +49,7 @@ Name to use as the caller ID name when dialing out to a destination. ___ -### callerNumber +### callerNumber • `Optional` **callerNumber**: `string` @@ -59,7 +57,7 @@ Number to use as the caller ID when dialing out to a destination. A valid phone ___ -### camId +### camId • `Optional` **camId**: `string` @@ -67,7 +65,7 @@ ___ ___ -### clientState +### clientState • `Optional` **clientState**: `string` @@ -76,7 +74,7 @@ Telnyx's Call Control client_state. Can be used with Connections with Advanced - ___ -### customHeaders +### customHeaders • `Optional` **customHeaders**: \{ `name`: `string` ; `value`: `string` }[] @@ -84,7 +82,7 @@ Add custom headers to the INVITE and ANSWER request. ___ -### debug +### debug • `Optional` **debug**: `boolean` @@ -92,7 +90,7 @@ Enable debug mode for this call. ___ -### debugOutput +### debugOutput • `Optional` **debugOutput**: ``"file"`` \| ``"socket"`` @@ -100,7 +98,7 @@ Output debug logs to a file. ___ -### destinationNumber +### destinationNumber • **destinationNumber**: `string` @@ -108,7 +106,7 @@ Phone number or SIP URI to dial. ___ -### iceServers +### iceServers • `Optional` **iceServers**: `RTCIceServer`[] @@ -116,7 +114,7 @@ Overrides client's default `iceServers`. ___ -### id +### id • `Optional` **id**: `string` @@ -124,7 +122,7 @@ Custom ID to identify the call. This will be used as the `callID` in place of th ___ -### localElement +### localElement • `Optional` **localElement**: `string` \| `HTMLMediaElement` @@ -132,7 +130,7 @@ Overrides client's default `localElement`. ___ -### localStream +### localStream • `Optional` **localStream**: `MediaStream` @@ -140,7 +138,7 @@ If set, the call will use this stream instead of retrieving a new one. ___ -### mediaSettings +### mediaSettings • `Optional` **mediaSettings**: `Object` @@ -155,7 +153,7 @@ Configures media (audio/video) in a call. ___ -### micId +### micId • `Optional` **micId**: `string` @@ -163,7 +161,7 @@ ___ ___ -### onNotification +### onNotification • `Optional` **onNotification**: `Function` @@ -171,7 +169,7 @@ Overrides client's default `telnyx.notification` handler for this call. ___ -### preferred\_codecs +### preferred\_codecs • `Optional` **preferred\_codecs**: `RTCRtpCodecCapability`[] @@ -179,7 +177,7 @@ Preferred codecs for the call. ___ -### remoteElement +### remoteElement • `Optional` **remoteElement**: `string` \| `HTMLMediaElement` @@ -187,7 +185,7 @@ Overrides client's default `remoteElement`. ___ -### remoteStream +### remoteStream • `Optional` **remoteStream**: `MediaStream` @@ -195,7 +193,7 @@ If set, the call will use this stream instead of retrieving a new one. ___ -### speakerId +### speakerId • `Optional` **speakerId**: `string` @@ -203,7 +201,7 @@ ___ ___ -### telnyxCallControlId +### telnyxCallControlId • `Optional` **telnyxCallControlId**: `string` @@ -211,7 +209,7 @@ Telnyx Call Control ID, if using Call Control services. ___ -### telnyxLegId +### telnyxLegId • `Optional` **telnyxLegId**: `string` @@ -219,7 +217,7 @@ Telnyx call leg ID, if using Call Control services. ___ -### telnyxSessionId +### telnyxSessionId • `Optional` **telnyxSessionId**: `string` @@ -227,7 +225,7 @@ Telnyx call session ID, if using Call Control services. ___ -### useStereo +### useStereo • `Optional` **useStereo**: `boolean` @@ -235,7 +233,7 @@ Uses stereo audio instead of mono. ___ -### video +### video • `Optional` **video**: `boolean` diff --git a/packages/js/docs/ts/interfaces/IClientOptions.md b/packages/js/docs/ts/interfaces/IClientOptions.md index 0e73f389..fcd6ca50 100644 --- a/packages/js/docs/ts/interfaces/IClientOptions.md +++ b/packages/js/docs/ts/interfaces/IClientOptions.md @@ -1,5 +1,3 @@ -# Interface: IClientOptions - IClientOptions IClientOptions @@ -7,15 +5,15 @@ IClientOptions ### Properties -- [login](IClientOptions.md#login) -- [login\_token](IClientOptions.md#login_token) -- [password](IClientOptions.md#password) -- [ringbackFile](IClientOptions.md#ringbackfile) -- [ringtoneFile](IClientOptions.md#ringtonefile) +- [login](/docs/voice/webrtc/js-sdk/interfaces/IClientOptions.md#login) +- [login\_token](/docs/voice/webrtc/js-sdk/interfaces/IClientOptions.md#login_token) +- [password](/docs/voice/webrtc/js-sdk/interfaces/IClientOptions.md#password) +- [ringbackFile](/docs/voice/webrtc/js-sdk/interfaces/IClientOptions.md#ringbackfile) +- [ringtoneFile](/docs/voice/webrtc/js-sdk/interfaces/IClientOptions.md#ringtonefile) ## Properties -### login +### login • `Optional` **login**: `string` @@ -25,7 +23,7 @@ The `username` to authenticate with your SIP Connection. ___ -### login\_token +### login\_token • `Optional` **login\_token**: `string` @@ -34,7 +32,7 @@ This is the recommended authentication strategy. [See how to create one](https:/ ___ -### password +### password • `Optional` **password**: `string` @@ -42,7 +40,7 @@ The `password` to authenticate with your SIP Connection. ___ -### ringbackFile +### ringbackFile • `Optional` **ringbackFile**: `string` @@ -51,7 +49,7 @@ A URL to a wav/mp3 ringback file that will be used when you disable ___ -### ringtoneFile +### ringtoneFile • `Optional` **ringtoneFile**: `string` diff --git a/packages/js/docs/ts/interfaces/INotification.md b/packages/js/docs/ts/interfaces/INotification.md index 81fcc55f..b8d3b3e9 100644 --- a/packages/js/docs/ts/interfaces/INotification.md +++ b/packages/js/docs/ts/interfaces/INotification.md @@ -1,5 +1,3 @@ -# Interface: INotification - An event dispatched by Telnyx to notify the client of changes to the session or call. The conditions of the event can be identified by the `type` property. @@ -62,13 +60,13 @@ Notification ### Properties -- [call](INotification.md#call) -- [error](INotification.md#error) -- [type](INotification.md#type) +- [call](/docs/voice/webrtc/js-sdk/interfaces/INotification.md#call) +- [error](/docs/voice/webrtc/js-sdk/interfaces/INotification.md#error) +- [type](/docs/voice/webrtc/js-sdk/interfaces/INotification.md#type) ## Properties -### call +### call • `Optional` **call**: `ICall` @@ -77,7 +75,7 @@ See `Call` documentation. ___ -### error +### error • `Optional` **error**: `Error` @@ -90,7 +88,7 @@ Omit.error ___ -### type +### type • **type**: `string` diff --git a/packages/js/typedoc.json b/packages/js/typedoc.json index b6b2368d..0b145037 100644 --- a/packages/js/typedoc.json +++ b/packages/js/typedoc.json @@ -13,11 +13,13 @@ "excludePrivate": true, "excludeProtected": true, "excludeNotDocumented": true, + "cleanOutputDir": true, "excludeTags": ["@internalnote", "@internal"], "hideGenerator": true, "readme": "none", "gitRevision": "main", "disableSources": true, "hideBreadcrumbs": true, - "namedAnchors": true + "hidePageTitle": true, + "publicPath": "/docs/voice/webrtc/js-sdk/" }