chore: add docs for prefetchIceCandidates option

team-telnyx · Nov 14, 2024 · e68ad99 · e68ad99
1 parent aa9aac7
commit e68ad99
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/packages/js/src/TelnyxRTC.ts b/packages/js/src/TelnyxRTC.ts
@@ -182,6 +182,18 @@ export class TelnyxRTC extends TelnyxRTCClient {
    *  preferred_codecs: [PCMACodec],
    * });
    * ```
+   * 
+   * ### ICE Candidate Prefetching
+   * 
+   * ICE candidate prefetching can be enabled by passing `prefetchIceCandidates` to the `newCall` method.
+   * example:
+   * ```js
+   * client.newCall({
+   *  destinationNumber: 'xxx',
+   *  prefetchIceCandidates: true,
+   * });
+   * ```
+   * 
    */
   newCall(options: ICallOptions) {
     return super.newCall(options);

diff --git a/packages/js/src/utils/interfaces.ts b/packages/js/src/utils/interfaces.ts
@@ -219,7 +219,7 @@ export interface ICallOptions {
   preferred_codecs?: RTCRtpCodecCapability[];
 
   /**
-   * ICE Candidate Prefetching.
+   * Enable or disable ICE Candidate Prefetching.
    */
   prefetchIceCandidates?: boolean;
 }