ue-softphone-sdk 2.2.3 → 2.2.4

package/src/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/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/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/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/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/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;
+}