Call.js

  1. /**
  2.  * This class describes the information and current status of a call.
  3.  */
  4. export default class Call {
  6.     constructor({
  7.             id, callId, accountId,
  8.             localContact, localUri, remoteContact, remoteUri,
  9.             state, stateText, held, muted, speaker,
  10.             connectDuration, totalDuration,
  11.             remoteOfferer, remoteAudioCount, remoteVideoCount, audioCount, videoCount,
  12.             lastStatusCode, lastReason, media, provisionalMedia
  13.         }) {
  14.         let remoteNumber = null;
  15.         let remoteName = null;
  17.         if (remoteUri) {
  18.             let match = remoteUri.match(/"([^"]+)" <sip:([^@]+)@/);
  20.             if (match) {
  21.                 remoteName = match[1];
  22.                 remoteNumber = match[2];
  23.             } else {
  24.                 match = remoteUri.match(/sip:([^@]+)@/);
  26.                 if (match) {
  27.                     remoteNumber = match[1];
  28.                 }
  29.             }
  30.         }
  32.         this._id = id;
  33.         this._callId = callId;
  34.         this._accountId = accountId;
  35.         this._localContact = localContact;
  36.         this._localUri = localUri;
  37.         this._remoteContact = remoteContact;
  38.         this._remoteUri = remoteUri;
  39.         this._state = state;
  40.         this._stateText = stateText;
  41.         this._held = held;
  42.         this._muted = muted;
  43.         this._speaker = speaker;
  44.         this._connectDuration = connectDuration;
  45.         this._totalDuration = totalDuration;
  46.         this._remoteOfferer = remoteOfferer;
  47.         this._remoteAudioCount = remoteAudioCount;
  48.         this._remoteVideoCount = remoteVideoCount;
  49.         this._remoteNumber = remoteNumber;
  50.         this._remoteName = remoteName;
  51.         this._audioCount = audioCount;
  52.         this._videoCount = videoCount;
  53.         this._lastStatusCode = lastStatusCode;
  54.         this._lastReason = lastReason;
  56.         this._media = media;
  57.         this._provisionalMedia = provisionalMedia;
  59.         this._constructionTime = Math.round(new Date().getTime() / 1000);
  60.     }
  62.     /**
  63.      * Call identification.
  64.      * @returns {int}
  65.      */
  66.     getId() {
  67.         return this._id;
  68.     }
  70.     /**
  71.      * The account ID where this call belongs.
  72.      * @returns {int}
  73.      */
  74.     getAccountId() {
  75.         return this._accountId;
  76.     }
  78.     /**
  79.      * Dialog Call-ID string.
  80.      *
  81.      * @returns {String}
  82.      */
  83.     getCallId() {
  84.         return this._callId;
  85.     }
  88.     /**
  89.      * Up-to-date call duration in seconds.
  90.      * Use local time to calculate actual call duration.
  91.      *
  92.      * @public
  93.      * @returns {int}
  94.      */
  95.     getTotalDuration() {
  96.         let time = Math.round(new Date().getTime() / 1000);
  97.         let offset = time - this._constructionTime;
  99.         return this._totalDuration + offset;
  100.     };
  102.     /**
  103.      * Up-to-date call connected duration (zero when call is not established)
  104.      *
  105.      * @returns {int}
  106.      */
  107.     getConnectDuration() {
  108.         if (this._connectDuration < 0 || this._state == "PJSIP_INV_STATE_DISCONNECTED") {
  109.             return this._connectDuration;
  110.         }
  112.         let time = Math.round(new Date().getTime() / 1000);
  113.         let offset = time - this._constructionTime;
  115.         return this._connectDuration + offset;
  116.     }
  118.     /**
  119.      * Call duration in "MM:SS" format.
  120.      *
  121.      * @public
  122.      * @returns {string}
  123.      */
  124.     getFormattedTotalDuration() {
  125.         return this._formatTime(this.getTotalDuration());
  126.     };
  128.     /**
  129.      * Call duration in "MM:SS" format.
  130.      *
  131.      * @public
  132.      * @returns {string}
  133.      */
  134.     getFormattedConnectDuration() {
  135.         return this._formatTime(this.getConnectDuration());
  136.     };
  138.     /**
  139.      * Local Contact.
  140.      * TODO: Provide example
  141.      * @returns {String}
  142.      */
  143.     getLocalContact() {
  144.         return this._localContact;
  145.     }
  147.     /**
  148.      * Local URI.
  149.      * TODO: Provide example
  150.      * @returns {String}
  151.      */
  152.     getLocalUri() {
  153.         return this._localUri;
  154.     }
  156.     /**
  157.      * Remote contact.
  158.      * TODO: Provide example
  159.      * @returns {String}
  160.      */
  161.     getRemoteContact() {
  162.         return this._remoteContact;
  163.     }
  165.     /**
  166.      * Remote URI.
  167.      * TODO: Provide example
  168.      * @returns {String}
  169.      */
  170.     getRemoteUri() {
  171.         return this._remoteUri;
  172.     }
  174.     /**
  175.      * Callee name. Could be null if no name specified in URI.
  176.      * @returns {String}
  177.      */
  178.     getRemoteName() {
  179.         return this._remoteName;
  180.     }
  182.     /**
  183.      * Callee number
  184.      * @returns {String}
  185.      */
  186.     getRemoteNumber() {
  187.         return this._remoteNumber;
  188.     }
  190.     /**
  191.      * @returns {String}
  192.      */
  193.     getRemoteFormattedNumber() {
  194.         if (this._remoteName && this._remoteNumber) {
  195.             return `${this._remoteName} <${this._remoteNumber}>`;
  196.         } else if (this._remoteNumber) {
  197.             return this._remoteNumber;
  198.         } else {
  199.             return this._remoteUri
  200.         }
  201.     }
  203.     /**
  204.      * Invite session state.
  205.      *
  206.      * PJSIP_INV_STATE_NULL           Before INVITE is sent or received
  207.      * PJSIP_INV_STATE_CALLING        After INVITE is sent
  208.      * PJSIP_INV_STATE_INCOMING       After INVITE is received.
  209.      * PJSIP_INV_STATE_EARLY          After response with To tag.
  210.      * PJSIP_INV_STATE_CONNECTING     After 2xx is sent/received.
  211.      * PJSIP_INV_STATE_CONFIRMED      After ACK is sent/received.
  212.      * PJSIP_INV_STATE_DISCONNECTED   Session is terminated.
  213.      *
  214.      * @returns {String}
  215.      */
  216.     getState() {
  217.         return this._state;
  218.     }
  220.     /**
  221.      * Text describing the state.
  222.      *
  223.      * @returns {String}
  224.      */
  225.     getStateText() {
  226.         return this._stateText;
  227.     }
  229.     isHeld() {
  230.         return this._held;
  231.     }
  233.     isMuted() {
  234.         return this._muted;
  235.     }
  237.     isSpeaker() {
  238.         return this._speaker;
  239.     }
  241.     isTerminated() {
  242.         return this._state === 'PJSIP_INV_STATE_DISCONNECTED';
  243.     }
  245.     /**
  246.      * Flag if remote was SDP offerer
  247.      * @returns {boolean}
  248.      */
  249.     getRemoteOfferer() {
  250.         // TODO Verify whether boolean value
  251.         return this._remoteOfferer;
  252.     }
  254.     /**
  255.      * Number of audio streams offered by remote.
  256.      * @returns {int}
  257.      */
  258.     getRemoteAudioCount() {
  259.         return this._remoteAudioCount;
  260.     }
  262.     /**
  263.      * Number of video streams offered by remote.
  264.      * @returns {int}
  265.      */
  266.     getRemoteVideoCount() {
  267.         return this._remoteVideoCount;
  268.     }
  270.     /**
  271.      * Number of simultaneous active audio streams for this call. If zero - audio is disabled in this call.
  272.      * @returns {int}
  273.      */
  274.     getAudioCount() {
  275.         return this._audioCount;
  276.     }
  278.     /**
  279.      * Number of simultaneous active video streams for this call. If zero - video is disabled in this call.
  280.      * @returns {*}
  281.      */
  282.     getVideoCount() {
  283.         return this._videoCount;
  284.     }
  286.     /**
  287.      * Last status code heard, which can be used as cause code.
  288.      * Possible values:
  289.      * - PJSIP_SC_TRYING / 100
  290.      * - PJSIP_SC_RINGING / 180
  291.      * - PJSIP_SC_CALL_BEING_FORWARDED / 181
  292.      * - PJSIP_SC_QUEUED / 182
  293.      * - PJSIP_SC_PROGRESS / 183
  294.      * - PJSIP_SC_OK / 200
  295.      * - PJSIP_SC_ACCEPTED / 202
  296.      * - PJSIP_SC_MULTIPLE_CHOICES / 300
  297.      * - PJSIP_SC_MOVED_PERMANENTLY / 301
  298.      * - PJSIP_SC_MOVED_TEMPORARILY / 302
  299.      * - PJSIP_SC_USE_PROXY / 305
  300.      * - PJSIP_SC_ALTERNATIVE_SERVICE / 380
  301.      * - PJSIP_SC_BAD_REQUEST / 400
  302.      * - PJSIP_SC_UNAUTHORIZED / 401
  303.      * - PJSIP_SC_PAYMENT_REQUIRED / 402
  304.      * - PJSIP_SC_FORBIDDEN / 403
  305.      * - PJSIP_SC_NOT_FOUND / 404
  306.      * - PJSIP_SC_METHOD_NOT_ALLOWED / 405
  307.      * - PJSIP_SC_NOT_ACCEPTABLE / 406
  308.      * - PJSIP_SC_PROXY_AUTHENTICATION_REQUIRED / 407
  309.      * - PJSIP_SC_REQUEST_TIMEOUT / 408
  310.      * - PJSIP_SC_GONE / 410
  311.      * - PJSIP_SC_REQUEST_ENTITY_TOO_LARGE / 413
  312.      * - PJSIP_SC_REQUEST_URI_TOO_LONG / 414
  313.      * - PJSIP_SC_UNSUPPORTED_MEDIA_TYPE / 415
  314.      * - PJSIP_SC_UNSUPPORTED_URI_SCHEME / 416
  315.      * - PJSIP_SC_BAD_EXTENSION / 420
  316.      * - PJSIP_SC_EXTENSION_REQUIRED / 421
  317.      * - PJSIP_SC_SESSION_TIMER_TOO_SMALL / 422
  318.      * - PJSIP_SC_INTERVAL_TOO_BRIEF / 423
  319.      * - PJSIP_SC_TEMPORARILY_UNAVAILABLE / 480
  320.      * - PJSIP_SC_CALL_TSX_DOES_NOT_EXIST / 481
  321.      * - PJSIP_SC_LOOP_DETECTED / 482
  322.      * - PJSIP_SC_TOO_MANY_HOPS / 483
  323.      * - PJSIP_SC_ADDRESS_INCOMPLETE / 484
  324.      * - PJSIP_AC_AMBIGUOUS / 485
  325.      * - PJSIP_SC_BUSY_HERE / 486
  326.      * - PJSIP_SC_REQUEST_TERMINATED / 487
  327.      * - PJSIP_SC_NOT_ACCEPTABLE_HERE / 488
  328.      * - PJSIP_SC_BAD_EVENT / 489
  329.      * - PJSIP_SC_REQUEST_UPDATED / 490
  330.      * - PJSIP_SC_REQUEST_PENDING / 491
  331.      * - PJSIP_SC_UNDECIPHERABLE / 493
  332.      * - PJSIP_SC_INTERNAL_SERVER_ERROR / 500
  333.      * - PJSIP_SC_NOT_IMPLEMENTED / 501
  334.      * - PJSIP_SC_BAD_GATEWAY / 502
  335.      * - PJSIP_SC_SERVICE_UNAVAILABLE / 503
  336.      * - PJSIP_SC_SERVER_TIMEOUT / 504
  337.      * - PJSIP_SC_VERSION_NOT_SUPPORTED / 505
  338.      * - PJSIP_SC_MESSAGE_TOO_LARGE / 513
  339.      * - PJSIP_SC_PRECONDITION_FAILURE / 580
  340.      * - PJSIP_SC_BUSY_EVERYWHERE / 600
  341.      * - PJSIP_SC_DECLINE / 603
  342.      * - PJSIP_SC_DOES_NOT_EXIST_ANYWHERE / 604
  343.      * - PJSIP_SC_NOT_ACCEPTABLE_ANYWHERE / 606
  344.      * - PJSIP_SC_TSX_TIMEOUT / PJSIP_SC_REQUEST_TIMEOUT
  345.      * - PJSIP_SC_TSX_TRANSPORT_ERROR / PJSIP_SC_SERVICE_UNAVAILABLE
  346.      *
  347.      * @returns {string}
  348.      */
  349.     getLastStatusCode() {
  350.         return this._lastStatusCode;
  351.     }
  353.     /**
  354.      * The reason phrase describing the last status.
  355.      *
  356.      * @returns {string}
  357.      */
  358.     getLastReason() {
  359.         return this._lastReason;
  360.     }
  362.     getMedia() {
  363.         return this._media;
  364.     }
  366.     getProvisionalMedia() {
  367.         return this._provisionalMedia;
  368.     }
  370.     /**
  371.      * Format seconds to "MM:SS" format.
  372.      *
  373.      * @public
  374.      * @returns {string}
  375.      */
  376.     _formatTime(seconds) {
  377.         if (isNaN(seconds) || seconds < 0) {
  378.             return "00:00";
  379.         }
  380.         var hours = parseInt( seconds / 3600 ) % 24;
  381.         var minutes = parseInt( seconds / 60 ) % 60;
  382.         var result = "";
  383.         seconds = seconds % 60;
  385.         if (hours > 0) {
  386.             result += (hours < 10 ? "0" + hours : hours) + ":";
  387.         }
  389.         result += (minutes < 10 ? "0" + minutes : minutes) + ":" + (seconds  < 10 ? "0" + seconds : seconds);
  390.         return result;
  391.     };
  392. }