ue-softphone-sdk-beta 3.0.23 → 3.0.24

package/src/lib/sip.js/platform/web/session-description-handler/api-extractor.json

@@ -0,0 +1,350 @@
+/**
+ * Config file for API Extractor.  For more info, please visit: https://api-extractor.com
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/ue/api-extractor.schema.json",
+
+  /**
+   * Optionally specifies another JSON config file that this file extends from.  This provides a way for
+   * standard settings to be shared across multiple projects.
+   *
+   * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains
+   * the "extends" field.  Otherwise, the first path segment is interpreted as an NPM package name, and will be
+   * resolved using NodeJS require().
+   *
+   * SUPPORTED TOKENS: none
+   * DEFAULT VALUE: ""
+   */
+  // "extends": "./shared/api-extractor-base.json"
+  // "extends": "my-package/include/api-extractor-base.json"
+
+  /**
+   * Determines the "<projectFolder>" token that can be used with other config file settings.  The project folder
+   * typically contains the tsconfig.json and package.json config files, but the path is user-defined.
+   *
+   * The path is resolved relative to the folder of the config file that contains the setting.
+   *
+   * The default value for "projectFolder" is the token "<lookup>", which means the folder is determined by traversing
+   * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder
+   * that contains a tsconfig.json file.  If a tsconfig.json file cannot be found in this way, then an error
+   * will be reported.
+   *
+   * SUPPORTED TOKENS: <lookup>
+   * DEFAULT VALUE: "<lookup>"
+   */
+  // "projectFolder": "..",
+  "projectFolder": "../../../..",
+
+  /**
+   * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis.  API Extractor
+   * analyzes the symbols exported by this module.
+   *
+   * The file extension must be ".d.ts" and not ".ts".
+   *
+   * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+   * prepend a folder token such as "<projectFolder>".
+   *
+   * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+   */
+  "mainEntryPointFilePath": "<projectFolder>/lib/platform/web/session-description-handler/index.d.ts",
+
+  /**
+   * Determines how the TypeScript compiler engine will be invoked by API Extractor.
+   */
+  "compiler": {
+    /**
+     * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * Note: This setting will be ignored if "overrideTsconfig" is used.
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/tsconfig.json"
+     */
+    // "tsconfigFilePath": "<projectFolder>/tsconfig.json",
+
+    /**
+     * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk.
+     * The object must conform to the TypeScript tsconfig schema:
+     *
+     * http://json.schemastore.org/tsconfig
+     *
+     * If omitted, then the tsconfig.json file will be read from the "projectFolder".
+     *
+     * DEFAULT VALUE: no overrideTsconfig section
+     */
+    "overrideTsconfig": {
+      "compilerOptions": {
+        "declaration": true,
+        "declarationMap": true,
+        "outDir": "../lib",
+        "strict": true,
+        "target": "es5",
+        "lib": ["es2017", "dom"]
+      },
+      "include": ["**/*.ts"]
+    }
+    /**
+     * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended
+     * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when
+     * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses
+     * for its analysis.  Where possible, the underlying issue should be fixed rather than relying on skipLibCheck.
+     *
+     * DEFAULT VALUE: false
+     */
+    // "skipLibCheck": true,
+  },
+
+  /**
+   * Configures how the API report file (*.api.md) will be generated.
+   */
+  "apiReport": {
+    /**
+     * (REQUIRED) Whether to generate an API report.
+     */
+    "enabled": true,
+
+    /**
+     * The filename for the API report files.  It will be combined with "reportFolder" or "reportTempFolder" to produce
+     * a full file path.
+     *
+     * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/".
+     *
+     * SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<unscopedPackageName>.api.md"
+     */
+    // "reportFileName": "<unscopedPackageName>.api.md",
+
+    /**
+     * Specifies the folder where the API report file is written.  The file name portion is determined by
+     * the "reportFileName" setting.
+     *
+     * The API report file is normally tracked by Git.  Changes to it can be used to trigger a branch policy,
+     * e.g. for an API review.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/etc/"
+     */
+    "reportFolder": "<projectFolder>/etc/session-description-handler",
+
+    /**
+     * Specifies the folder where the temporary report file is written.  The file name portion is determined by
+     * the "reportFileName" setting.
+     *
+     * After the temporary file is written to disk, it is compared with the file in the "reportFolder".
+     * If they are different, a production build will fail.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/temp/"
+     */
+    "reportTempFolder": "<projectFolder>/temp/session-description-handler"
+  },
+
+  /**
+   * Configures how the doc model file (*.api.json) will be generated.
+   */
+  "docModel": {
+    /**
+     * (REQUIRED) Whether to generate a doc model file.
+     */
+    "enabled": true,
+
+    /**
+     * The output path for the doc model file.  The file extension should be ".api.json".
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
+     */
+    "apiJsonFilePath": "<projectFolder>/temp/session-description-handler/<unscopedPackageName>.api.json"
+  },
+
+  /**
+   * Configures how the .d.ts rollup file will be generated.
+   */
+  "dtsRollup": {
+    /**
+     * (REQUIRED) Whether to generate the .d.ts rollup file.
+     */
+    "enabled": false
+
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated without any trimming.
+     * This file will include all declarations that are exported by the main entry point.
+     *
+     * If the path is an empty string, then this file will not be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts"
+     */
+    // "untrimmedFilePath": "<projectFolder>/dist/sip-platform-web.d.ts",
+
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.
+     * This file will include only declarations that are marked as "@public" or "@beta".
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: ""
+     */
+    // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",
+
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release.
+     * This file will include only declarations that are marked as "@public".
+     *
+     * If the path is an empty string, then this file will not be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: ""
+     */
+    // "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts",
+
+    /**
+     * When a declaration is trimmed, by default it will be replaced by a code comment such as
+     * "Excluded from this release type: exampleMember".  Set "omitTrimmingComments" to true to remove the
+     * declaration completely.
+     *
+     * DEFAULT VALUE: false
+     */
+    // "omitTrimmingComments": true
+  },
+
+  /**
+   * Configures how the tsdoc-metadata.json file will be generated.
+   */
+  "tsdocMetadata": {
+    /**
+     * Whether to generate the tsdoc-metadata.json file.
+     *
+     * DEFAULT VALUE: true
+     */
+    // "enabled": true,
+    /**
+     * Specifies where the TSDoc metadata file should be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * The default value is "<lookup>", which causes the path to be automatically inferred from the "tsdocMetadata",
+     * "typings" or "main" fields of the project's package.json.  If none of these fields are set, the lookup
+     * falls back to "tsdoc-metadata.json" in the package folder.
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<lookup>"
+     */
+    // "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"
+  },
+
+  /**
+   * Configures how API Extractor reports error and warning messages produced during analysis.
+   *
+   * There are three sources of messages:  compiler messages, API Extractor messages, and TSDoc messages.
+   */
+  "messages": {
+    /**
+     * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing
+     * the input .d.ts files.
+     *
+     * TypeScript message identifiers start with "TS" followed by an integer.  For example: "TS2551"
+     *
+     * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
+     */
+    "compilerMessageReporting": {
+      /**
+       * Configures the default routing for messages that don't match an explicit rule in this table.
+       */
+      "default": {
+        /**
+         * Specifies whether the message should be written to the the tool's output log.  Note that
+         * the "addToApiReportFile" property may supersede this option.
+         *
+         * Possible values: "error", "warning", "none"
+         *
+         * Errors cause the build to fail and return a nonzero exit code.  Warnings cause a production build fail
+         * and return a nonzero exit code.  For a non-production build (e.g. when "api-extractor run" includes
+         * the "--local" option), the warning is displayed but the build will not fail.
+         *
+         * DEFAULT VALUE: "warning"
+         */
+        "logLevel": "warning"
+
+        /**
+         * When addToApiReportFile is true:  If API Extractor is configured to write an API report file (.api.md),
+         * then the message will be written inside that file; otherwise, the message is instead logged according to
+         * the "logLevel" option.
+         *
+         * DEFAULT VALUE: false
+         */
+        // "addToApiReportFile": false
+      }
+
+      // "TS2551": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    },
+
+    /**
+     * Configures handling of messages reported by API Extractor during its analysis.
+     *
+     * API Extractor message identifiers start with "ae-".  For example: "ae-extra-release-tag"
+     *
+     * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings
+     */
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+        // "addToApiReportFile": false
+      }
+
+      // "ae-extra-release-tag": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    },
+
+    /**
+     * Configures handling of messages reported by the TSDoc parser when analyzing code comments.
+     *
+     * TSDoc message identifiers start with "tsdoc-".  For example: "tsdoc-link-tag-unescaped-text"
+     *
+     * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
+     */
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+        // "addToApiReportFile": false
+      }
+
+      // "tsdoc-link-tag-unescaped-text": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    }
+  }
+}

package/src/lib/sip.js/platform/web/session-description-handler/index.ts

@@ -0,0 +1,14 @@
+/**
+ * A SessionDescriptionHandler for web browsers.
+ * @packageDocumentation
+ */
+export * from "./media-stream-factory-default";
+export * from "./media-stream-factory";
+export * from "./peer-connection-configuration-default";
+export * from "./peer-connection-delegate";
+export * from "./session-description-handler-configuration";
+export * from "./session-description-handler-factory-default";
+export * from "./session-description-handler-factory-options";
+export * from "./session-description-handler-factory";
+export * from "./session-description-handler-options";
+export * from "./session-description-handler";

package/src/lib/sip.js/platform/web/session-description-handler/media-stream-factory-default.ts

@@ -0,0 +1,22 @@
+import { MediaStreamFactory } from "./media-stream-factory";
+
+/**
+ * Function which returns a MediaStreamFactory.
+ * @public
+ */
+export function defaultMediaStreamFactory(): MediaStreamFactory {
+  return (constraints: MediaStreamConstraints): Promise<MediaStream> => {
+    // if no audio or video, return a media stream without tracks
+    if (!constraints.audio && !constraints.video) {
+      return Promise.resolve(new MediaStream());
+    }
+    // getUserMedia() is a powerful feature which can only be used in secure contexts; in insecure contexts,
+    // navigator.mediaDevices is undefined, preventing access to getUserMedia(). A secure context is, in short,
+    // a page loaded using HTTPS or the file:/// URL scheme, or a page loaded from localhost.
+    // https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#Privacy_and_security
+    if (navigator.mediaDevices === undefined) {
+      return Promise.reject(new Error("Media devices not available in insecure contexts."));
+    }
+    return navigator.mediaDevices.getUserMedia.call(navigator.mediaDevices, constraints);
+  };
+}

package/src/lib/sip.js/platform/web/session-description-handler/media-stream-factory.ts

@@ -0,0 +1,10 @@
+import { SessionDescriptionHandler } from "./session-description-handler";
+
+/**
+ * Interface of factory function which produces a MediaStream.
+ * @public
+ */
+export type MediaStreamFactory = (
+  constraints: MediaStreamConstraints,
+  sessionDescriptionHandler: SessionDescriptionHandler
+) => Promise<MediaStream>;

package/src/lib/sip.js/platform/web/session-description-handler/peer-connection-configuration-default.ts

@@ -0,0 +1,17 @@
+// @ts-nocheck
+/**
+ * Function which returns an RTCConfiguration.
+ * @public
+ */
+export function defaultPeerConnectionConfiguration(): RTCConfiguration {
+  const configuration: RTCConfiguration = {
+    bundlePolicy: "balanced", // Note: max-bundle is not supported by the demo backend currently (5/15/17)
+    certificates: undefined,
+    iceCandidatePoolSize: 0,
+    iceServers: [{ urls: "stun:stun.l.google.com:19302" }], // TURN URL example: "turn:88.88.88.0:3478", "test", "test"
+    iceTransportPolicy: "all",
+    peerIdentity: undefined,
+    rtcpMuxPolicy: "require"
+  };
+  return configuration;
+}

package/src/lib/sip.js/platform/web/session-description-handler/peer-connection-delegate.ts

@@ -0,0 +1,72 @@
+/**
+ * Delegate to handle PeerConnection state changes.
+ * @public
+ */
+export interface PeerConnectionDelegate {
+  /**
+   * This happens whenever the aggregate state of the connection changes.
+   * The aggregate state is a combination of the states of all of the
+   * individual network transports being used by the connection.
+   * @param event - Event.
+   */
+  onconnectionstatechange?(event: Event): void;
+
+  /**
+   * Triggered when an RTCDataChannel is added to the connection by the
+   * remote peer calling createDataChannel().
+   * @param event - RTCDataChannelEvent.
+   */
+  ondatachannel?(event: RTCDataChannelEvent): void;
+
+  /**
+   * Triggered when a new ICE candidate has been found.
+   * @param event - RTCPeerConnectionIceEvent.
+   */
+  onicecandidate?(event: RTCPeerConnectionIceEvent): void;
+
+  /**
+   * Triggered when an error occurred during ICE candidate gathering.
+   * @param event - RTCPeerConnectionIceErrorEvent.
+   */
+  onicecandidateerror?(event: RTCPeerConnectionIceErrorEvent): void;
+
+  /**
+   * This happens whenever the local ICE agent needs to deliver a message to
+   * the other peer through the signaling server. This lets the ICE agent
+   * perform negotiation with the remote peer without the browser itself
+   * needing to know any specifics about the technology being used for
+   * signalingTriggered when the IceConnectionState changes.
+   * @param event - Event.
+   */
+  oniceconnectionstatechange?(event: Event): void;
+
+  /**
+   * Triggered when the ICE gathering state changes.
+   * @param event - Event.
+   */
+  onicegatheringstatechange?(event: Event): void;
+
+  /**
+   * Triggered when renegotiation is necessary.
+   * @param event - Event.
+   */
+  onnegotiationneeded?(event: Event): void;
+
+  /**
+   * Triggered when the SignalingState changes.
+   * @param event - Event.
+   */
+  onsignalingstatechange?(event: Event): void;
+
+  /**
+   * Triggered when when a statistics object being monitored is deleted.
+   * @param event - Event.
+   */
+  onstatsended?(event: Event): void;
+
+  /**
+   * Triggered when a new track is signaled by the remote peer, as a result of setRemoteDescription.
+   * @param event - Event.
+   */
+  ontrack?(event: Event): void;
+}

package/src/lib/sip.js/platform/web/session-description-handler/session-description-handler-configuration.ts

@@ -0,0 +1,17 @@
+/**
+ * Configuration for SessionDescriptionHandler.
+ * @public
+ */
+export interface SessionDescriptionHandlerConfiguration {
+  /**
+   * The maximum duration to wait in ms for ICE gathering to complete.
+   * If undefined, implementation dependent.
+   * If zero, no timeout.
+   */
+  iceGatheringTimeout?: number;
+
+  /**
+   * Peer connection options.
+   */
+  peerConnectionConfiguration?: RTCConfiguration;
+}

package/src/lib/sip.js/platform/web/session-description-handler/session-description-handler-factory-default.ts

@@ -0,0 +1,45 @@
+import { Session } from "../../../api";
+import { defaultMediaStreamFactory } from "./media-stream-factory-default";
+import { defaultPeerConnectionConfiguration } from "./peer-connection-configuration-default";
+import { SessionDescriptionHandler } from "./session-description-handler";
+import { SessionDescriptionHandlerConfiguration } from "./session-description-handler-configuration";
+import { SessionDescriptionHandlerFactory } from "./session-description-handler-factory";
+import { SessionDescriptionHandlerFactoryOptions } from "./session-description-handler-factory-options";
+
+/**
+ * Function which returns a SessionDescriptionHandlerFactory.
+ * @remarks
+ * See {@link defaultPeerConnectionConfiguration} for the default peer connection configuration.
+ * The ICE gathering timeout defaults to 5000ms.
+ * @param mediaStreamFactory - MediaStream factory.
+ * @public
+ */
+export function defaultSessionDescriptionHandlerFactory(
+  mediaStreamFactory?: (
+    constraints: MediaStreamConstraints,
+    sessionDescriptionHandler: SessionDescriptionHandler
+  ) => Promise<MediaStream>
+): SessionDescriptionHandlerFactory {
+  return (session: Session, options?: SessionDescriptionHandlerFactoryOptions): SessionDescriptionHandler => {
+    // provide a default media stream factory if need be
+    if (mediaStreamFactory === undefined) {
+      mediaStreamFactory = defaultMediaStreamFactory();
+    }
+
+    // make sure we allow `0` to be passed in so timeout can be disabled
+    const iceGatheringTimeout = options?.iceGatheringTimeout !== undefined ? options?.iceGatheringTimeout : 5000;
+
+    // merge passed factory options into default session description configuration
+    const sessionDescriptionHandlerConfiguration: SessionDescriptionHandlerConfiguration = {
+      iceGatheringTimeout,
+      peerConnectionConfiguration: {
+        ...defaultPeerConnectionConfiguration(),
+        ...options?.peerConnectionConfiguration
+      }
+    };
+
+    const logger = session.userAgent.getLogger("sip.SessionDescriptionHandler");
+
+    return new SessionDescriptionHandler(logger, mediaStreamFactory, sessionDescriptionHandlerConfiguration);
+  };
+}

package/src/lib/sip.js/platform/web/session-description-handler/session-description-handler-factory-options.ts

@@ -0,0 +1,10 @@
+import { SessionDescriptionHandlerConfiguration } from "./session-description-handler-configuration";
+
+/**
+ * Options for SessionDescriptionHandlerFactory.
+ * @remarks
+ * The "options" are provided as part of the UserAgent configuration and passed through
+ * on every call to SessionDescriptionHandlerFactory's constructor.
+ * @public
+ */
+export type SessionDescriptionHandlerFactoryOptions = SessionDescriptionHandlerConfiguration;

package/src/lib/sip.js/platform/web/session-description-handler/session-description-handler-factory.ts

@@ -0,0 +1,17 @@
+import { Session, SessionDescriptionHandlerFactory as SessionDescriptionHandlerFactoryDefinition } from "../../../api";
+import { SessionDescriptionHandler } from "./session-description-handler";
+import { SessionDescriptionHandlerFactoryOptions } from "./session-description-handler-factory-options";
+
+/**
+ * Factory for {@link SessionDescriptionHandler}.
+ * @public
+ */
+export interface SessionDescriptionHandlerFactory extends SessionDescriptionHandlerFactoryDefinition {
+  /**
+   * SessionDescriptionHandler factory function.
+   * @remarks
+   * The `options` are provided as part of the UserAgent configuration
+   * and passed through on every call to SessionDescriptionHandlerFactory's constructor.
+   */
+  (session: Session, options?: SessionDescriptionHandlerFactoryOptions): SessionDescriptionHandler;
+}

package/src/lib/sip.js/platform/web/session-description-handler/session-description-handler-options.ts

@@ -0,0 +1,56 @@
+import { SessionDescriptionHandlerOptions as SessionDescriptionHandlerOptionsDefinition } from "../../../api";
+
+/**
+ * Options for {@link SessionDescriptionHandler}.
+ * @public
+ */
+export interface SessionDescriptionHandlerOptions extends SessionDescriptionHandlerOptionsDefinition {
+  /**
+   * Answer options to use when creating an answer.
+   */
+  answerOptions?: RTCAnswerOptions;
+
+  /**
+   * Constraints to use when creating local media stream.
+   * @remarks
+   * If undefined, defaults to audio true and video false.
+   * If audio and video are false, media stream will have no tracks.
+   */
+  constraints?: MediaStreamConstraints;
+
+  /**
+   * If true, create a data channel when making initial offer.
+   */
+  dataChannel?: boolean;
+
+  /**
+   * A human-readable name to use when creating the data channel.
+   */
+  dataChannelLabel?: string;
+
+  /**
+   * Configuration options for creating the data channel.
+   */
+  dataChannelOptions?: RTCDataChannelInit;
+
+  /**
+   * If true, offer and answer directions will be set to place peer on hold.
+   */
+  hold?: boolean;
+
+  /**
+   * The maximum duration to wait in ms for ICE gathering to complete.
+   * No timeout if undefined or zero.
+   */
+  iceGatheringTimeout?: number;
+
+  /**
+   * Offer options to use when creating an offer.
+   */
+  offerOptions?: RTCOfferOptions;
+
+  /**
+   * Called upon creating a data channel.
+   */
+  onDataChannel?: (dataChannel: RTCDataChannel) => void;
+}