XPMobileSDK.js

/**
 * @namespace
 * @property {object}  XPMobileSDKSettings										- The default values for settings.
 * @property {string}  XPMobileSDKSettings.fileName								- Name of the main file
 * @property {string}  XPMobileSDKSettings.clientType							- Client type
 * @property {string}  XPMobileSDKSettings.communicationChanel					- URL path of communication channel
 * @property {string}  XPMobileSDKSettings.videoChanel							- URL path of video channel
 * @property {string}  XPMobileSDKSettings.audioChannel							- URL path of audio channel
 * @property {string}  XPMobileSDKSettings.MobileServerURL						- URL of Mobile Server
 * @property {string}  XPMobileSDKSettings.defaultEncryptionPadding				- default Encryption Padding
 * @property {number}  XPMobileSDKSettings.primeLength							- prime length
 * @property {number}  XPMobileSDKSettings.videoConnectionTimeout				- video connection timeout
 * @property {number}  XPMobileSDKSettings.resamplingFactor						- resampling factor
 * @property {number}  XPMobileSDKSettings.liveMessageMinimumInterval			- live message minimum interval
 * @property {number}  XPMobileSDKSettings.socketRestartMinimumInterval			- socket restart minimum interval
 * @property {number}  XPMobileSDKSettings.videoStreamRestartMinimumInterval	- video stream restart minimum interval
 * @property {boolean}  XPMobileSDKSettings.supportsMultiThreaded				- Flag indicating whether Multi thread is enabled
 * @property {boolean}  XPMobileSDKSettings.supportsCarousels					- Flag indicating whether Carousels is enabled
 * @property {boolean}  XPMobileSDKSettings.supportsCHAP						- Flag indicating whether CHAP is enabled
 * @property {boolean}  XPMobileSDKSettings.DirectStreaming						- Flag indicating whether Direct streaming is enabled
 * @property {boolean}  XPMobileSDKSettings.SupportsAudioIn						- Flag indicating whether Audio In is enabled
 * @property {boolean}  XPMobileSDKSettings.SupportsAudioOut					- Flag indicating whether Audio Out is enabled
 * @property {number}  XPMobileSDKSettings.AudioCompressionLevel				- Audio Compression Level when using browsers build in audio player
 * @property {number}  XPMobileSDKSettings.AudioCompressionLevelAudioAPI		- Audio Compression Level when using Web Audio API
 * @property {number}  XPMobileSDKSettings.NoVideoTimeout						- No Video Timeout
 * @property {boolean|string}  XPMobileSDKSettings.EnableConsoleLog				- possible values: true, false, "error", "warn", "info", "log". "log", "info" and true are basically the same. All other values will be interpreted as true.
 * @property {boolean}  XPMobileSDKSettings.SupportsAdaptiveStreaming			- Flag indicating whether Adaptive Streaming is enabled
 */
var XPMobileSDKSettings = {
  fileName: "XPMobileSDK.js",
  clientType: "WebClient",
  communicationChanel: "/XProtectMobile/Communication",
  videoChanel: "/XProtectMobile/Video",
  audioChannel: "/XProtectMobile/Audio",
  MobileServerURL: "",
  defaultEncryptionPadding: "Iso10126",
  primeLength: 2048,
  videoConnectionTimeout: 20000,
  resamplingFactor: 1 / 1000000,
  liveMessageMinimumInterval: 1000,
  socketRestartMinimumInterval: 1000,
  videoStreamRestartMinimumInterval: 20000,

  supportsMultiThreaded: false,
  supportsCarousels: false,
  supportsCHAP: true,
  DirectStreaming: true,
  DiagnosticsLayout: true,

  SupportsAudioIn: true,
  SupportsAudioOut: true,
  AudioCompressionLevel: 99,
  AudioCompressionLevelAudioAPI: 41,
  NoVideoTimeout: 5000,
  EnableConsoleLog: true,
  SupportsAdaptiveStreaming: true,
  enablePlaybackAudioSourceSelection: true,

  includes: [
    /* [MINIFY_JS] */
    "Lib/tools/logger.js",
    "Lib/tools/polyfills.js",
    "Lib/tools/webStorage.js",

    "Lib/security/BigInt.js",
    "Lib/security/Base64.js",
    "Lib/security/AES.js",
    "Lib/security/SHA256.js",
    "Lib/security/SHA512.js",
    "Lib/security/SecureString.js",
    "Lib/security/CHAP.js",
    "Lib/security/Challenge.js",
    "Lib/security/DiffieHellman.js",
    "Lib/security/ISO10126.js",
    "Lib/security/PKCECode.js",

    "Lib/communication/Ajax.js",
    "Lib/communication/Bytes.js",
    "Lib/communication/NetworkConfig.js",
    "Lib/communication/CommunicationStability.js",

    "Lib/Connection.js",
    "Lib/ConnectionRequest.js",
    "Lib/ConnectionResponse.js",
    "Lib/PullConnection.js",
    "Lib/PushConnection.js",
    "Lib/VideoConnection.js",
    "Lib/VideoStream.js",
    "Lib/ItemHeaderParser.js",
    "Lib/VideoHeaderParser.js",
    "Lib/AudioHeaderParser.js",
    "Lib/VideoConnectionPool.js",
    "Lib/VideoPushConnection.js",
    "Lib/AudioPushConnection.js",
    "Lib/AudioAvailability.js",
    /* [/MINIFY_JS] */
  ],
};

var XPMobileSDK = new (function () {
  this.onLoad = function () {};

  this.library = {};
  this.interfaces = {};
  this.features = {};

  this.initialize = initializeConnection;
  this.isLoaded = isLoaded;
  this.addObserver = addObserver;
  this.removeObserver = removeObserver;
  this.cancelRequest = cancelRequest;
  this.connect = connect;
  this.Connect = Connect;
  this.connectWithId = connectWithId;
  this.login = login;
  this.Login = Login;
  this.externalLogin = externalLogin;
  this.ExternalLogin = ExternalLogin;
  this.requestCode = requestCode;
  this.verifyCode = verifyCode;
  this.disconnect = disconnect;
  this.Disconnect = Disconnect;
  this.LiveMessage = LiveMessage;
  this.getAllViews = getAllViews;
  this.getAllCameras = getAllCameras;
  this.getViews = getViews;
  this.requestStream = requestStream;
  this.RequestStream = RequestStream;
  this.RequestAudioStream = RequestAudioStream;
  this.requestAudioStream = requestAudioStream;
  this.requestPushStream = requestPushStream;
  this.RequestAudioStreamIn = RequestAudioStreamIn;
  this.requestAudioStreamIn = requestAudioStreamIn;
  this.changeStream = changeStream;
  this.ChangeStream = ChangeStream;
  this.closeStream = closeStream;
  this.closeAudioStream = closeAudioStream;
  this.CloseStream = CloseStream;
  this.createVideoPushConnection = createVideoPushConnection;
  this.createAudioPushConnection = createAudioPushConnection;
  this.motionDetection = motionDetection;
  this.getPtzPresets = getPtzPresets;
  this.ptzPreset = ptzPreset;
  this.ptzMove = ptzMove;
  this.ptzTapAndHold = ptzTapAndHold;
  this.ptzSwipe = ptzSwipe;
  this.playbackSpeed = playbackSpeed;
  this.playbackSeek = playbackSeek;
  this.playbackGoTo = playbackGoTo;
  this.getThumbnail = getThumbnail;
  this.getThumbnailByTime = getThumbnailByTime;
  this.getDBStartTime = getDBStartTime;
  this.getNextSequence = getNextSequence;
  this.getPrevSequence = getPrevSequence;
  this.getSequencesInInterval = getSequencesInInterval;
  this.getSequencesForView = getSequencesForView;
  this.getUserExports = getUserExports;
  this.getAllExports = getAllExports;
  this.getExport = getExport;
  this.createExportDownloadLink = createExportDownloadLink;
  this.getOutputsAndEvents = getOutputsAndEvents;
  this.getServerStatus = getServerStatus;
  this.triggerOutputOrEvent = triggerOutputOrEvent;
  this.getCameraCapabilities = getCameraCapabilities;
  this.requestChallenges = requestChallenges;
  this.createPlaybackController = createPlaybackController;
  this.changeMultipleStreams = changeMultipleStreams;
  this.getAllInvestigations = getAllInvestigations;
  this.getUserInvestigations = getUserInvestigations;
  this.getInvestigation = getInvestigation;
  this.createInvestigation = createInvestigation;
  this.updateInvestigation = updateInvestigation;
  this.updateInvestigationData = updateInvestigationData;
  this.deleteInvestigation = deleteInvestigation;
  this.cancelInvestigation = cancelInvestigation;
  this.startInvestigationExport = startInvestigationExport;
  this.deleteInvestigationExport = deleteInvestigationExport;
  this.getAlarmList = getAlarmList;
  this.getAlarm = getAlarm;
  this.updateAlarm = updateAlarm;
  this.getAlarmDataSettings = getAlarmDataSettings;
  this.getAlarmUsers = getAlarmUsers;
  this.acknowledgeAlarm = acknowledgeAlarm;
  this.GetBookmarks = GetBookmarks;
  this.getBookmarks = getBookmarks;
  this.deleteBookmark = deleteBookmark;
  this.prevCarouselCamera = prevCarouselCamera;
  this.nextCarouselCamera = nextCarouselCamera;
  this.pauseCarousel = pauseCarousel;
  this.resumeCarousel = resumeCarousel;
  this.registerForNotifications = registerForNotifications;
  this.RegisterForNotifications = RegisterForNotifications;
  this.CreateBookmark = CreateBookmark;
  this.UpdateBookmark = UpdateBookmark;
  this.RequestBookmarkCreation = RequestBookmarkCreation;
  this.getResamplingFactor = getResamplingFactor;
  this.toggleDirectStreaming = toggleDirectStreaming;
  this.toggleDiagnosticsOverlay = toggleDiagnosticsOverlay;
  this.toggleAnalytics = toggleAnalytics;
  this.sendCommand = sendCommand;
  this.destroy = destroy;

  var onLoad = function () {
    this.onLoad();
  }.bind(this);

  var loaded = false;
  var head, path;

  initialize();

  function initialize() {
    var script = document.querySelector(
      'script[src$="' + XPMobileSDKSettings.fileName + '"]',
    );

    path = script.src.replace(RegExp(XPMobileSDKSettings.fileName + ".*$"), "");
    head = document.querySelector("head");

    load(XPMobileSDKSettings.includes.slice());
  }

  /**
   * Loads all scripts from a queue
   *
   * @method load
   * @param {Array} queue - Array containing all script for loading
   */
  function load(queue) {
    var url = path + queue.shift();
    var script = document.createElement("script");

    script.addEventListener("load", function () {
      if (queue.length) {
        load(queue);
      } else {
        loadComplete();
      }
    });
    script.addEventListener("error", function () {
      console.error("Script load error!");
    });
    script.src = url;

    head.appendChild(script);
  }

  /**
   * Called when all scripts are loaded
   *
   * @method loadComplete
   */
  function loadComplete() {
    XPMobileSDK.library.Connection = new Connection();
    XPMobileSDK.library.CHAP.initialize();
    XPMobileSDK.library.Connection.initialize(XPMobileSDK.localStorage);

    loaded = true;
    onLoad();
  }

  /**
   * Initializes the Connection singleton. Must be called before using any of the other methods.
   *
   * @method initializeConnection
   * @param {Object} [storage] - (optional) the storage used to store server features in,
   *                  and to initialize them from
   *                  (for example XPMobileSDK.localStorage, XPMobileSDK.sessionStorage,
   *                  or any object implementing their methods).
   * 				    The server features are retrieved on login.
   *                  The idea is to keep the connection state if you want to connectWithId,
   *                  but it may be cleared on some cases (browser refresh for example).
   */
  function initializeConnection(storage) {
    XPMobileSDK.library.Connection.initialize(storage);
  }

  function isLoaded() {
    return loaded;
  }

  /**
   * Adds an observer to the Connection singleton.
   *
   * @method addObserver
   * @param {Object} observer - an arbitrary object implementing the ConnectionObserverInterface interface
   * @see ConnectionObserverInterface
   */
  function addObserver(observer) {
    XPMobileSDK.library.Connection.addObserver(observer);
  }

  /**
   * Removes an existing observer from the Connection singleton.
   *
   * @method removeObserver
   * @param {Object} observer - an arbitrary object implementing the ConnectionObserverInterface interface
   * @see ConnectionObserverInterface
   */
  function removeObserver(observer) {
    XPMobileSDK.library.Connection.removeObserver(observer);
  }

  /**
   * Cancels a request.
   *
   * @method cancelRequest
   * @param {ConnectionRequest} request - the ConnectionRequest object, returned by the method used to create it
   */
  function cancelRequest(request) {
    XPMobileSDK.library.Connection.cancelRequest(request);
  }

  /**
   * Sends a Connect connection command to establish a new connection with a server.
   * The changes of the connect status are propagated to all listeners through the ConnectionObserver interface methods.
   * Listeners implementing the ConnectionObserver interface methods are added with the addObserver method.
   *
   * @method connect
   * @param {String} server - server name or IP address
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function connect(server) {
    if (server) {
      XPMobileSDK.library.Connection.server = server;
    }

    return new Connect(null);
  }

  /**
   * Initiates connection to the Mobile Server. Two limitations are introduced:
   * MaximumConnectionAllowed and ConnectionTimeout between Connect and Login.
   * They are set from the GeneralSetting section in config file
   *
   * @method Connect
   * @param {Object} params - Parameters to sent to the server. May contain:
   * <pre>
   * - {String} EncryptionPadding - (optional) Padding scheme that will be used
   *                                when encrypting/decrypting shared key.
   *                                Default is PKCS7. Currently supported values are PKCS7 and ISO10126.
   * - {Number} PrimeLength - (optional) The length of the prime module in bits.
   *                          Default is 1024. Currently supported values are 1024 and 2048
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing messages
   *                                should be sent from server while processing the request. Default is Yes.
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} failCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function Connect(params, successCallback, failCallback) {
    params = params || {};
    params.PublicKey = XPMobileSDK.library.Connection.dh.createPublicKey();
    if (XPMobileSDKSettings.primeLength) {
      params.PrimeLength = XPMobileSDKSettings.primeLength;
    }
    if (XPMobileSDKSettings.defaultEncryptionPadding) {
      params.EncryptionPadding =
        XPMobileSDKSettings.defaultEncryptionPadding.toUpperCase();
    }

    var connectionRequest = XPMobileSDK.library.Connection.Connect(
      params,
      successCallback,
      failCallback,
    );
    return connectionRequest || XPMobileSDK.interfaces.ConnectionRequest;
  }

  /**
   * Tries to reestablish an existing connection with a server by using an existing connection id.
   * The changes of the connect status are propagated to all listeners through the ConnectionObserver interface methods.
   * Listeners implementing the ConnectionObserver interface methods are added with the addObserver method.
   *
   * @method connectWithId
   * @param {String} server - server name or IP address
   * @param {String} connectionId - connection id
   * @param {String} serverId - server id
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function connectWithId(server, connectionId, serverId) {
    XPMobileSDK.library.Connection.connectWithId(
      server,
      connectionId,
      serverId,
    );
  }

  /**
   * Sends a LogIn connection command to log a user with valid usernam and password.
   * The changes of the login status are propagated to all listeners through the ConnectionObserver interface methods.
   * Listeners implementing the ConnectionObserver interface methods are added with the addObserver method.
   *
   * @method login
   * @param {String} username - username
   * @param {String} password - password
   * @param {String} loginType - loginType
   * @param {Object} parameters - other parameters. May contain:
   * <pre>
   *
   * - {Number} NumChallenges - Number of challenges the MoS should return.
   *                           Up to 100 can be requested at once.
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing messages
   *                                should be sent from server while processing the request. Default is Yes.
   * - {String} SupportsResampling - (optional) [Yes/No] When present and equal to
   *                                 "Yes", indicates that the client can handle
   *                                 downsized images. This instructs Quality of
   *                                 Service to reduce the size of the sent images
   *                                 as additional measure in cases of low bandwidth.
   * - {String} SupportsExtendedResamplingFactor - (optional) [Yes/No] When present and equal to
   *                                               "Yes", indicates that client supports working
   *                                               with decimal resampling factor. Influence on
   *                                               the type of ResamplingTag received in Header
   *                                               Extension Flags of Video frame
   *
   * </pre>
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function login(username, password, loginType, parameters) {
    parameters = parameters || {};
    parameters.Username = username;
    parameters.Password = password;
    if (loginType) {
      parameters.LoginType = loginType;
    }

    return new Login(parameters);
  }

  /**
   * Sends a low level Login command to the server.
   *
   * @method Login
   * @param {Object} params - Parameters to sent to the server.  May contain:
   * <pre>
   * - {String} Username - Name of the connection user.
   * - {String} Password - Password for the certain user.
   * - {String} LoginType - Authentication login type.
   * - {Number} NumChallenges - Number of challenges the MoS should return.
   *                           Up to 100 can be requested at once.
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing messages
   *                                should be sent from server while processing the request. Default is Yes.
   * - {String} SupportsResampling - (optional) [Yes/No] When present and equal to
   *                                 "Yes", indicates that the client can handle
   *                                 downsized images. This instructs Quality of
   *                                 Service to reduce the size of the sent images
   *                                 as additional measure in cases of low bandwidth.
   * - {String} SupportsExtendedResamplingFactor - (optional) [Yes/No] When present and equal to
   *                                               "Yes", indicates that client supports working
   *                                               with decimal resampling factor. Influence on
   *                                               the type of ResamplingTag received in Header
   *                                               Extension Flags of Video frame
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} failCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function Login(params, successCallback, failCallback) {
    params = params || {};

    if (XPMobileSDK.library.Connection.PublicKey) {
      params.Username = XPMobileSDK.library.Connection.dh.encodeString(
        params.Username,
      );
      params.Password = XPMobileSDK.library.Connection.dh.encodeString(
        params.Password,
      );
    }

    if (
      XPMobileSDKSettings.supportsCHAP &&
      XPMobileSDK.library.Connection.CHAPSupported === "Yes"
    ) {
      // Take 100 challenges to start with
      params.NumChallenges = params.NumChallenges || 100;
    }

    params.SupportsResampling = params.SupportsResampling || "Yes";
    params.SupportsExtendedResamplingFactor =
      params.SupportsExtendedResamplingFactor || "Yes";

    if (XPMobileSDKSettings.supportsCarousels) {
      params.SupportsCarousel = params.SupportsCarousel || "Yes";
    }
    if (XPMobileSDKSettings.clientType) {
      params.ClientType = params.ClientType || XPMobileSDKSettings.clientType;
    }

    var connectionRequest = XPMobileSDK.library.Connection.Login(
      params,
      successCallback,
      failCallback,
    );
    return connectionRequest || XPMobileSDK.interfaces.ConnectionRequest;
  }

  /**
   * Sends a LogIn connection command to log a user with valid idpClientId, identityToken, accessToken and RefreshToken.
   * The changes of the login status are propagated to all listeners through the ConnectionObserver interface methods.
   * Listeners implementing the ConnectionObserver interface methods are added with the addObserver method.
   *
   * @method login
   * @param {String} idpClientId  - idpClientId
   * @param {String} identityToken  - identityToken
   * @param {String} accessToken  - accessToken
   * @param {String} RefreshToken  - RefreshToken
   * @param {String} loginType - loginType
   * @param {Object} parameters - other parameters. May contain:
   * <pre>
   *
   * - {Number} NumChallenges - Number of challenges the MoS should return.
   *                           Up to 100 can be requested at once.
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing messages
   *                                should be sent from server while processing the request. Default is Yes.
   * - {String} SupportsResampling - (optional) [Yes/No] When present and equal to
   *                                 "Yes", indicates that the client can handle
   *                                 downsized images. This instructs Quality of
   *                                 Service to reduce the size of the sent images
   *                                 as additional measure in cases of low bandwidth.
   * - {String} SupportsExtendedResamplingFactor - (optional) [Yes/No] When present and equal to
   *                                               "Yes", indicates that client supports working
   *                                               with decimal resampling factor. Influence on
   *                                               the type of ResamplingTag received in Header
   *                                               Extension Flags of Video frame
   *
   * </pre>
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function externalLogin(
    idpClientId,
    identityToken,
    accessToken,
    refreshToken,
    loginType,
    parameters,
  ) {
    parameters = parameters || {};
    parameters.IdpClientId = idpClientId;
    parameters.IdentityToken = identityToken;
    parameters.AccessToken = accessToken;
    parameters.RefreshToken = refreshToken;
    parameters.LoginType = loginType;

    return new ExternalLogin(parameters);
  }

  /**
   * Sends a low level Login command to the server.
   *
   * @method ExternalLogin
   * @param {Object} params - Parameters to sent to the server.  May contain:
   * <pre>
   * - {String} IdpClientId  - Name of the client IDP
   * - {String} IdentityToken  - Identity toke  provider from 3rd party login
   * - {String} AccessToken   - Access token  provider from 3rd party login
   * - {String} RefreshToken   - Refresh token provider from 3rd party login
   * - {String} LoginType - Authentication login type.
   * - {Number} NumChallenges - Number of challenges the MoS should return.
   *                           Up to 100 can be requested at once.
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing messages
   *                                should be sent from server while processing the request. Default is Yes.
   * - {String} SupportsResampling - (optional) [Yes/No] When present and equal to
   *                                 "Yes", indicates that the client can handle
   *                                 downsized images. This instructs Quality of
   *                                 Service to reduce the size of the sent images
   *                                 as additional measure in cases of low bandwidth.
   * - {String} SupportsExtendedResamplingFactor - (optional) [Yes/No] When present and equal to
   *                                               "Yes", indicates that client supports working
   *                                               with decimal resampling factor. Influence on
   *                                               the type of ResamplingTag received in Header
   *                                               Extension Flags of Video frame
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} failCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function ExternalLogin(params, successCallback, failCallback) {
    if (
      XPMobileSDKSettings.supportsCHAP &&
      XPMobileSDK.library.Connection.CHAPSupported === "Yes"
    ) {
      // Take 100 challenges to start with
      params.NumChallenges = params.NumChallenges || 100;
    }

    params.SupportsResampling = params.SupportsResampling || "Yes";
    params.SupportsExtendedResamplingFactor =
      params.SupportsExtendedResamplingFactor || "Yes";

    if (XPMobileSDKSettings.supportsCarousels) {
      params.SupportsCarousel = params.SupportsCarousel || "Yes";
    }
    if (XPMobileSDKSettings.clientType) {
      params.ClientType = params.ClientType || XPMobileSDKSettings.clientType;
    }
    var connectionRequest = XPMobileSDK.library.Connection.Login(
      params,
      successCallback,
      failCallback,
    );
    return connectionRequest || XPMobileSDK.interfaces.ConnectionRequest;
  }

  /**
   * Sends a RequestSecondStepAuthenticationPin connection command after successful login with a valid username and password.
   * This method is used only if the server has called the connectionRequiresCode method of the ConnectionObserver interface.
   *
   * @method requestCode
   * @param {Function} successCallback - function that is called when the command execution was successful.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function requestCode(successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.requestCode(
      successCallback,
      errorCallback,
    );
  }

  /**
   * Sends a RequestSecondStepAuthenticationPin connection command after successful login with a valid username and password.
   * This method is used only if the server has called the connectionRequiresCode method of the ConnectionObserver interface.
   *
   * @method verifyCode
   * @param {String} code - second step authentication pin code
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function verifyCode(code) {
    return XPMobileSDK.library.Connection.verifyCode(code);
  }

  /**
   * Sends a Disconnect connection command and logs out the current user.
   *
   * @method disconnect
   */
  function disconnect() {
    logger.error("disconnect");
    XPMobileSDK.library.Connection.Disconnect();
  }

  /**
   * Sends a Disconnect connection command and logs out the current user.
   * (Stops all the open video communication channels, removes ConnectionId from the internal resolving mechanism)
   *
   * @method Disconnect
   * @param {Object} params - Parameters to sent to the server. May contain:
   * <pre>
   * - {String} ConnectionId - Connection ID retrieved from Connect command
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing
   *                                messages should be sent from server while
   *                                processing the request. Default depends on the
   *                                value in connect command.
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} failCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function Disconnect(params, successCallback, failCallback) {
    logger.error("Disconnect");
    XPMobileSDK.library.Connection.Disconnect(
      params,
      successCallback,
      failCallback,
    );
  }

  /**
   * Sends a LiveMessage command to the server indicating that the client is up and running. Client needs to send that command at least once in the watch dog interval which is 30 seconds by default.
   * Recomented interval is 80% of whach dog  = 80*30/100 = 24
   *
   * @example setInterval(function(){XPMobileSDK.LiveMessage()}, 24000);
   *
   * @method LiveMessage
   * @param {Object} params - Parameters to sent to the server.  May contain:
   * <pre>
   * - {String} ConnectionId - Connection ID retrieved from Connect command
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing
   *                                messages should be sent from server while
   *                                processing the request. Default depends on the
   *                                value in connect command.
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} failCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function LiveMessage(params, successCallback, failCallback) {
    XPMobileSDK.library.Connection.LiveMessage(
      params,
      successCallback,
      failCallback,
    );
  }

  /**
   * Sends a GetAllViewsAndCameras connection command to get the full tree of views starting from the root.
   *
   * @method getAllViews
   * @param {Function} successCallback - function that is called when the command execution was successful and a views object is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getAllViews(successCallback, errorCallback) {
    var connectionRequest = XPMobileSDK.library.Connection.getAllViews(
      successCallback,
      errorCallback,
    );
    return connectionRequest || XPMobileSDK.interfaces.ConnectionRequest;
  }

  /**
   *
   * @method getAllCameras
   * @param {Function} successCallback - function that is called when the command execution was successful and a camera object is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getAllCameras(successCallback, errorCallback) {
    var connectionRequest = XPMobileSDK.library.Connection.getAllCameras(
      successCallback,
      errorCallback,
    );
    return connectionRequest || XPMobileSDK.interfaces.ConnectionRequest;
  }

  /**
   * Sends a GetViews connection command to get the sub-views of any view using its id.
   *
   * @method getViews
   * @param {String} viewId - view id
   * @param {Function} successCallback - function that is called when the command execution was successful and a view object is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getViews(viewId, successCallback, errorCallback) {
    var connectionRequest = XPMobileSDK.library.Connection.getViews(
      viewId,
      successCallback,
      errorCallback,
    );
    return connectionRequest || XPMobileSDK.interfaces.ConnectionRequest;
  }

  /**
   * Sends a RequestStream connection command to get the live/playback video stream of a camera as a VideoConnection object from the server.
   *
   * @method requestStream
   * @param {String} cameraId - unique GUID of the camera that should be started
   * @param {VideoConnectionSize} size - output stream size
   * @param {VideoConnectionOptions} options - optional, optional configuration. May contain:
   * <pre>
   * - {String} signal - Type of the requested signal - Live, Playback or Upload.
   * - {String} streamType - Shows if this is a transcoded or a direct stream.
   *                         Possible values - Native and Transcoded.
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and a VideoConnection object is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function requestStream(
    cameraId,
    size,
    options,
    successCallback,
    errorCallback,
  ) {
    var connectionRequest = XPMobileSDK.library.Connection.requestStream(
      cameraId,
      size,
      options,
      successCallback,
      errorCallback,
    );
    return connectionRequest || XPMobileSDK.interfaces.ConnectionRequest;
  }

  /**
   * Starts live, payback or push video session for a particular device.
   *
   * @method RequestStream
   * @param {Object} params - Parameters to sent to the server. May contain:
   * <pre>
   * - {String} ConnectionId - Connection ID retrieved from Connect command
   * - {String} StreamType - Shows if this is a transcoded or a direct stream.
   *                         Possible values - Native and Transcoded. Missing
   *                         of this will be interpreted as Transcoded. (backward compatibility)
   * - {String} ByteOrder - LittleEndian/Network. Missing of this will be
   *                        interpreted as LittleEndian for Transcoded,
   *                        StreamType and Network for Native StreamType.
   * - {String} CameraId - ID of the camera, which stream is requested (GUID)
   * - {Number} DestWidth - Width of the requested video (in pixels)
   * - {Number} DestHeight - Height of the requested video (in pixels)
   * - {Number} Fps - Frame-rate of the requested video (frames per second)
   * - {Number} ComprLevel - Compression level of the received JPEG images (1 - 100)
   * - {String} SignalType - Type of the requested signal - Live, Playback or Upload.
   * - {String} MethodType - Type of the method for retrieving video data - Push or Pull
   * - {String} KeyFramesOnly - Yes/No (everything different than Yes is interpreted as No)
   *                            - reduces stream quality by transcoding only Key (I) frames,
   *                            if option is enabled in the Management Plug-in.
   * - {String} TImeRestrictionStart - (optional) Start time stamp of restriction period given as milliseconds since Unix EPOCH
   * - {String} TimeRestrictionEnd - (optional) End time stamp of restriction period given as milliseconds since Unix EPOCH
   * - {String} MotionOverlay - (reserved) No/Yes
   * - {String} RequestSize - (optional) [Yes/No] - If value of the field is Yes, Size header extension
   *                          is sent with every frame. Otherwise it is sent only on size change.
   *                           Missing of paramter is interpreted as No.
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing
   *                                messages should be sent from server while
   *                                processing the request. Default is Yes.
   * - {String} SeekType - (optional) Makes seek of specific type: DbStart,
   *                       DbEnd, PrevSeq, NextSeq, PrevFrame, NextFrame, Time, TimeOrBefore,
   *                       TimeOrAfter, TimeAfter, TimeBefore.
   * - {String} Time - (optional) Time of playback speed (in milliseconds
   *                   since Unix epoch). Valid if SeekType == Time.
   * - {String} UserInitiatedDownsampling - (optional) [Yes/No] When present and equal to
   *                                        "Yes", indicates that the client requires all sent images to
   *                                        be downsized at least by two (half the
   *                                        requested width and height). SupportsResampling
   *                                        must be set explicitly to "Yes".
   * - {String} PlaybackControllerId - (optional) Id of the playback controller used for common playback control.
   *                                   Received from "CreatePlaybackController" command.
   *                                   When present and not equal to empty string, indicates
   *                                   that the client requires playback controller to be used,
   *                                   shared between few playback streams. Valid only if "SignalType" is set to Playback.
   *                                   If does not present - single playback stream is created. If set to
   *                                   id of the existing in the server controller - this playback stream is attached to it.
   *                                   If set to invalid id - error is returned (unknown item id - 21).
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} failCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function RequestStream(params, successCallback, failCallback) {
    XPMobileSDK.library.Connection.RequestStream(
      params,
      successCallback,
      failCallback,
    );
  }

  /**
   * Starts live, playback audio session for a particular device.
   *
   * @method RequestAudioStream
   * @param {Object} params - Parameters to sent to the server. May contain:
   * <pre>
   * - {String} ConnectionId - Connection ID retrieved from Connect command
   * - {String} StreamType - Shows if this is a transcoded or a direct stream.
   *                         Possible values - Transcoded. Missing
   *                         of this will be interpreted as Transcoded. (backward compatibility)
   * - {String} ItemId - ID of the microphone, which stream is requested (GUID)
   * - {Number} ComprLevel - Compression level of the received Audio (1 - 100)
   * - {String} SignalType - Type of the requested signal - Live, Playback or Upload.
   * - {String} MethodType - Type of the method for retrieving video data - Push or Pull
   * - {String} StreamDataType - "Audio"
   * - {String} AudioEncoding - Shows the encoding of the output. Possible values - Pcm, Mp3.
   * - {String} CloseConnectionOnError - (optional) Yes/No - decide what to do with the connection channel on error.
   * - {String} PlaybackControllerId - (optional) Id of the playback controller used for common playback control.
   *                                      Use an ID of a video stream with which the audio source is associated.
   *                                      When present and not equal to empty string, indicates that the client requires playback
   *                                      controller to be used, shared between the audio and video playback streams.
   *                                      Valid only if "SignalType" is set to Playback. If not present - no playback audio stream is created.
   *                                      If set to invalid id - error is returned (unknown item id - 21).
   * - {String} ByteOrder - LittleEndian/Network. Missing of this will be interpreted as LittleEndian for Transcoded StreamType and Network for Native StreamType.
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} failCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function RequestAudioStream(params, successCallback, failCallback) {
    XPMobileSDK.library.Connection.RequestAudioStream(
      params,
      successCallback,
      failCallback,
    );
  }

  /**
   * Sends a RequestAudioStream connection command to get the live/playback video stream of a camera as a VideoConnection object from the server.
   *
   * @method requestAudioStream
   * @param {String} cameraId - unique GUID of the microphone that should be started
   * @param {AudioConnectionOptions} options - optional, optional configuration. May contain:
   * <pre>
   * - {String} signal - Type of the requested signal - Live, Playback.
   * - {int} compressionLevel
   * - {boolean} reuseConnection - if true, the API will reuse existing connections for the same microphone
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and a VideoConnection object is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function requestAudioStream(
    microphoneId,
    options,
    successCallback,
    errorCallback,
  ) {
    var connectionRequest = XPMobileSDK.library.Connection.requestAudioStream(
      microphoneId,
      options,
      successCallback,
      errorCallback,
    );
    return connectionRequest || XPMobileSDK.interfaces.ConnectionRequest;
  }

  /**
   * Sends a RequestStream connection command to get an upstream for video push to the server.
   *
   * @method requestPushStream
   * @param {Function} successCallback - function that is called when the command execution was successful and a stream parameters object is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function requestPushStream(successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.requestPushStream(
      successCallback,
      errorCallback,
    );
  }

  /**
     * Sends a RequestAudioStreamIn connection command to get an upstream for audio push to the server.
     * 
     * @method RequestAudioStreamIn
     * @param {AudioConnectionOptions} params - Configuration. Should contain:
     * <pre>
     * - {String} itemId - Id of the item (speaker), which stream is requested (GUID)
     * - {String} AudioEncoding - Shows the encoding of the output. Possible values - Pcm, Mp3.
     * - {Number} AudioSamplingRate - The audio sampling rate in Hz value
     * - {Number} AudioBitsPerSample - 8/16  - Audio bits per sample
     * - {Number} AudioChannelsNumber - 1/2 - Number of audio channels (mon or stereo)
     * - {String} StreamDataType - Shows if this is video, audio or metadata. Possible values - Video, Audio, MetaData.
     * - {String} SignalType - Type of the requested signal - Live, Playback
     * - {String} MethodType - Type of the method for retrieving video data - Push or Pull
     * - {String} StreamHeaders - Shows available stream headers. Possible values - AllPresent, NoHeaders.
     * - {String} Challenge - (only if CHAPSupproted is true) GUID previously given by the server
     * - {String} ChalAnswer - (only if CHAPSupproted is true) Challenge itself plus a SHA512 hash encoded as base64

     * </pre>
     * @param {Function} successCallback - function that is called when the command execution was successful and a stream parameters object is passed as a parameter.
     * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
     * 
     * @return {ConnectionRequest} - the ConnectionRequest object
     */
  function RequestAudioStreamIn(params, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.RequestAudioStreamIn(
      params,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Sends a RequestAudioStreamIn connection command to get an upstream for audio push to the server.
   *
   * @method requestAudioStreamIn
   * @param {String} itemId - Id of the item (speaker), which stream is requested (GUID)
   * @param {AudioConnectionOptions} options - optional, optional configuration. May contain:
   * <pre>
   * - {Number} AudioSamplingRate - The audio sampling rate in Hz value
   * - {Number} AudioBitsPerSample - 8/16  - Audio bits per sample
   * - {Number} AudioChannelsNumber - 1/2 - Number of audio channels (mon or stereo)
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and a stream parameters object is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function requestAudioStreamIn(
    itemId,
    options,
    successCallback,
    errorCallback,
  ) {
    return XPMobileSDK.library.Connection.requestAudioStreamIn(
      itemId,
      options,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Sends a ChangeStream connection command to change the parameters of an existing VideoConnection.
   *
   * @method changeStream
   * @param {VideoConnection} videoConnection - existing VideoConnection object representing a camera stream
   * @param {VideoConnectionCropping} cropping - rectangle to crop from the native camera video stream
   * @param {VideoConnectionSize} size - output stream size for the resulting cropped native camera video stream
   * @param {Function} successCallback - function that is called when the command execution was successful.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function changeStream(
    videoConnection,
    cropping,
    size,
    successCallback,
    errorCallback,
  ) {
    var connectionRequest = XPMobileSDK.library.Connection.changeStream(
      videoConnection,
      cropping,
      size,
      successCallback,
      errorCallback,
    );
    return connectionRequest || XPMobileSDK.interfaces.ConnectionRequest;
  }

  /**
   * Sends a ChangeStream connection command and logs out the current user.
   *
   * @method ChangeStream
   * @param {Object} params - Parameters to sent to the server.  May contain:
   * <pre>
   * - {String} ConnectionId - Connection ID retrieved from Connect command
   * - {String} VideoId - ID of the video connection (GUID)
   * - {Number} DestWidth - (optional) Width of the requested video (in pixels)
   * - {Number} DestHeight - (optional) Height of the requested video (in pixels)
   * - {Number} Fps - (optional) Frame-rate of the requested video (frames per second)
   * - {Number} ComprLevel - (optional) Compression level of the received JPEG images (1 - 100)
   * - {String} MethodType - Type of the method for retrieving video data - Push or Pull
   * - {String} SeekType - (optional) Makes seek of specific type: DbStart,
   *                       DbEnd, PrevSeq, NextSeq, PrevFrame, NextFrame, Time, TimeOrBefore,
   *                       TimeOrAfter, TimeAfter, TimeBefore.
   * - {String} Time - (optional) Time of playback speed (in milliseconds
   *                   since Unix epoch). Valid if SeekType == Time.
   *
   * - {String} SignalType - Type of the requested signal - Live, Playback or Upload.
   * - {Number} SrcLeft - (optional) Left coordinate (X) of the cropping rectangle.
   * - {Number} SrcTop - (optional) Top coordinate (Y) of the cropping rectangle.
   * - {Number} SrcRight - (optional) Right coordinate (X) of the cropping rectangle.
   * - {Number} SrcBottom - (optional) Bottom coordinate (Y) of the cropping rectangle.
   * - {Number} Speed - (optional) Speed of the playback (floating point). Sign determines the direction.
   * - {Number} PtzPreset - (optional) Makes move of the PTZ to a user defined preset.
   * - {String} RegionGrid - (reserved)
   * - {String} MotionOverlayEnabled - (reserved) No/Yes
   * - {Number} MotionAmount - (reserved ) 1-100
   * - {Number} SensitivityAmount - (reserved) 1-100
   * - {Number} CPUImpactAmont - (reserved) 1-4
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing messages should
   *                                be sent from server while processing the request.
   *                                Default depends on the value in connect command
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} failCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function ChangeStream(params, successCallback, failCallback) {
    XPMobileSDK.library.Connection.ChangeStream(
      params,
      successCallback,
      failCallback,
    );
  }

  /**
   * Sends a CloseStream connection command to close an existing VideoConnection by id.
   *
   * @method closeStream
   * @param {String} videoId - id of an existing VideoConnection
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function closeStream(videoId) {
    return XPMobileSDK.library.Connection.closeStream(videoId);
  }

  /**
   * Sends a CloseStream connection command to close an existing Audio stream by Id.
   *
   * @method closeAudioStream
   * @param {String} streamId - id of an existing stream
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function closeAudioStream(streamId) {
    return XPMobileSDK.library.Connection.closeAudioStream(streamId);
  }

  /**
   * Sends a CloseStream connection command and logs out the current user.
   *
   * @method CloseStream
   * @param {Object} params - Parameters to sent to the server. Should contain:
   * <pre>
   * - {String} ConnectionId - Connection ID retrieved from Connect command
   * - {String} VideoId - ID of the video connection (GUID)
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing messages should
   *                                be sent from server while processing the request.
   *                                Default depends on the value in connect command
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} failCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function CloseStream(params, successCallback, failCallback) {
    XPMobileSDK.library.Connection.CloseStream(
      params,
      successCallback,
      failCallback,
    );
  }

  /**
   * Establishes a connection to an available web camera and requests a video push stream for that camera with requestPushStream.
   *
   * @method createVideoPushConnection
   * @param {Function} successCallback - function that is called when the command execution was successful and a VideoPushConnection object is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   * @param {Boolean} skipUserMedia - do not restrict usage to user media, but allow alternative ways for streaming.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function createVideoPushConnection(
    successCallback,
    errorCallback,
    skipUserMedia,
  ) {
    var videoPushConnection = new XPMobileSDK.library.VideoPushConnection(
      successCallback,
      errorCallback,
      skipUserMedia,
    );
    return videoPushConnection || XPMobileSDK.interfaces.VideoPushConnection;
  }

  /**
   * Establishes a connection to an available web camera speaker and requests an audio push stream for that speaker with RequestAudioStreamIn.
   *
   * @method createAudioPushConnection
   * @param {Array} itemIds - array of items we will push audio to.
   * @param {Number} sampleRate - the sample rate at which we send the audio to the server.
   * @param {Function} successCallback - function that is called when the command execution was successful and a AudioPushConnection object is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function createAudioPushConnection(
    itemIds,
    sampleRate,
    successCallback,
    errorCallback,
  ) {
    var audioPushConnection = new XPMobileSDK.library.AudioPushConnection(
      itemIds,
      sampleRate,
      successCallback,
      errorCallback,
    );
    return audioPushConnection || XPMobileSDK.interfaces.VideoPushConnection;
  }

  /**
   * Sends a ChangeStream command to the server.
   * Changes the motion detection settings of the stream that the given videoConnection represents.
   *
   * @method motionDetection
   * @param {VideoConnection} videoConnection - existing VideoConnection object representing a camera stream
   * @param {Object} options - contains any or all of the motion, sensitivity, grid and cpu parameters.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function motionDetection(videoConnection, options) {
    return XPMobileSDK.library.Connection.motionDetection(
      videoConnection,
      options,
    );
  }

  /**
   * Sends a GetPtzPresets command to the server.
   *
   * @method getPtzPresets
   * @param {GUID} cameraId - the current camera related to the presets this request will return
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getPtzPresets(cameraId, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getPtzPresets(
      cameraId,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Sends a ControlPTZ command to the server. Controls PTZ Preset.
   * The parameter needs to be a valid preset name, otherwise nothing will happen.
   *
   * @method ptzPreset
   * @param {VideoConnection} videoConnection - existing VideoConnection object representing a camera stream
   * @param {String} presetName - the name of the preset to be activated
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function ptzPreset(videoConnection, presetName) {
    return XPMobileSDK.library.Connection.ptzPreset(
      videoConnection,
      presetName,
    );
  }

  /**
   * It is used to change the camera orientation by moving it in the direction of the tap.
   * The reference point of the movement is the center of the screen.
   * The tap and the reference points are used to calculate the direction and the speed of the camera movement.
   *
   * @method ptzTapAndHold
   * @param {Object} parameters - Object containing the following properties:
   * <pre>
   * - {String} CameraId - unique GUID of the camera
   * - {Number} GestureXPercent - the percentage of distance between start and finish [-100:100]
   * - {Number} GestureYPercent - the percentage of distance between start and finish [-100:100]
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and an error object is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function ptzTapAndHold(parameters, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.ptzTapAndHold(
      parameters,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Sends a ControlPTZ command to the server. Controls PTZMove.
   * Directions are: 'Up', 'Down', 'Left', 'Right', 'UpLeft', 'UpRight', 'DownLeft',
   * 'DownRight', 'ZoomIn', 'ZoomOut', 'Home'.
   * The camera needs to support PTZ, otherwise nothing will happen.
   *
   * @method ptzMove
   * @param {VideoConnection} videoConnection - existing VideoConnection object representing a PTZ camera stream
   * @param {String} direction - 'Up', 'Down', 'Left', 'Right', 'UpLeft', 'UpRight', 'DownLeft',
   *                              'DownRight', 'ZoomIn', 'ZoomOut', 'Home'
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function ptzMove(videoConnection, direction) {
    return XPMobileSDK.library.Connection.ptzMove(videoConnection, direction);
  }

  /**
   * It is used to change the camera orientation by moving it in the direction of the swipe.
   * The swipe direction and length are calculated based on the start and end points of the gesture.
   * The swipe speed is calculated based on the time it took to perform the gesture
   * from the start point to the end point.
   * The calculated direction defines the direction of the PTZ movement,
   * whereas the length and the speed are used to determine the amount of the PTZ movement.
   *
   * @method ptzSwipe
   * @param {Object} parameters - Object containing the following properties:
   * <pre>
   * - {String} CameraId - unique GUID of the camera
   * - {Number} GestureXPercent - the percentage of distance between start and finish [-100:100]
   * - {Number} GestureYPercent - the percentage of distance between start and finish [-100:100]
   * </pre>
   * @param {Number} gestureDuration - number of milliseconds
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function ptzSwipe(parameters, gestureDuration) {
    return XPMobileSDK.library.Connection.ptzSwipe(parameters, gestureDuration);
  }

  /**
   * Sends a ChangeStream command to the server.
   * Controls playback speed as a float. Negative number means backwards. 1.0 means normal speed.
   *
   * @method playbackSpeed
   * @param {VideoConnection} videoConnection - existing VideoConnection object representing a camera stream
   * @param {Number} speed - Speed of the playback (floating point). Sign determines the direction
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function playbackSpeed(videoConnection, speed) {
    return XPMobileSDK.library.Connection.playbackSpeed(videoConnection, speed);
  }

  /**
   * Sends a ChangeStream command to the server.
   * Seeks to either of: 'DbStart', 'DbEnd', 'PrevSeq', 'NextSeq', 'PrevFrame' or 'NextFrame'.
   *
   * @method playbackSeek
   * @param {VideoConnection} videoConnection - existing VideoConnection object representing a camera stream
   * @param {String} seekType - 'DbStart', 'DbEnd', 'PrevSeq', 'NextSeq', 'PrevFrame' or 'NextFrame'
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function playbackSeek(videoConnection, seekType) {
    return XPMobileSDK.library.Connection.playbackSeek(
      videoConnection,
      seekType,
    );
  }

  /**
   * Sends a ChangeStream command to the server. Goes to the closest possible match of specific time.
   *
   * @method playbackGoTo
   * @param {VideoConnection} videoConnection - existing VideoConnection object representing a camera stream
   * @param {Number} millisecondsSinceUnixEpoch - Time of playback speed (in milliseconds since Unix epoch). Valid if SeekType == Time
   * @param {String} seekType - optional, 'Time' (default), 'TimeOrBefore', 'TimeOrAfter'
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function playbackGoTo(
    videoConnection,
    millisecondsSinceUnixEpoch,
    seekType,
    successCallback,
    errorCallback,
  ) {
    return XPMobileSDK.library.Connection.playbackGoTo(
      videoConnection,
      millisecondsSinceUnixEpoch,
      seekType,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Sends a GetThumbnail command to the server in order to obtain an image representation for a given camera.
   *
   * @method getThumbnail
   * @param {String} cameraId - the unique GUID of the camera
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getThumbnail(cameraId, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getThumbnail(
      cameraId,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets thumbnail by the given camera id and time.
   *
   * @method getThumbnailByTime
   * @param {Object} params - Object containing the following properties:
   * <pre>
   * - {String} cameraId - Id of the requested camera thumbnail
   * - {Number} time - Miliseconds since start of UNIX epoch, in UTC.
   * - {Number} width - Max width of the requested camera thumbnail
   * - {Number} height - Max height of the requested camera thumbnail
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getThumbnailByTime(params, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getThumbnailByTime(
      params,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets the start time of the recordings for a particular camera.
   *
   * @method getDBStartTime
   * @param {String} cameraId - ID of the camera, which recordings database time is requested
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getDBStartTime(cameraId, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getDBStartTime(
      cameraId,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets the next sequence by given time for the given cameraId.
   *
   * @method getNextSequence
   * @param {String} cameraId - ID of the camera (GUID) for which Sequences are retrieved.
   * @param {Number} timestamp - milliseconds in UTC, a sequence after this moment will be returned
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getNextSequence(
    cameraId,
    timestamp,
    successCallback,
    errorCallback,
  ) {
    return XPMobileSDK.library.Connection.getNextSequence(
      cameraId,
      timestamp,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets the previous sequence by given time.
   *
   * @method getPrevSequence
   * @param {String} cameraId - ID of the camera (GUID) for which Sequences are retrieved.
   * @param {Number} timestamp - milliseconds in UTC, a sequence before this moment will be returned
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getPrevSequence(
    cameraId,
    timestamp,
    successCallback,
    errorCallback,
  ) {
    return XPMobileSDK.library.Connection.getPrevSequence(
      cameraId,
      timestamp,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets all the sequences in a given interval of time.
   *
   * @method getSequencesInInterval
   * @param {String} cameraId - ID of the camera (GUID) for which Sequences are retrieved.
   * @param {Number} startTime - milliseconds in UTC, the start time of the interval
   * @param {Number} endTime - milliseconds in UTC, the end time of the interval
   * @param {String} investigationId - The id of the investigation (export) to be used for extracting the sequences.
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getSequencesInInterval(
    cameraId,
    startTime,
    endTime,
    investigationId,
    successCallback,
    errorCallback,
  ) {
    return XPMobileSDK.library.Connection.getSequencesInInterval(
      cameraId,
      startTime,
      endTime,
      investigationId,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets all the sequences the sequences for the view.
   *
   * @method getSequencesForView
   * @param {Array} ItemId - (Multiple items possible) ID of the item (camera) (GUID) for which are retrieved Sequences.
   * @param {Number} startTime: milliseconds in UTC, the start time of the interval
   * @param {Number} endTime: milliseconds in UTC, the end time of the interval
   * @param {Number} minTimeBetweenSequences: (optional) If sequences have time gap lower than this value (in seconds), they will be merged in one big sequence. Default value is 0
   * @param {Function} successCallback: function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} failCallback: function that is called when the command execution has failed and the error is passed as a parameter.
   * @param {SeqType} SeqType - Type of the sequences requests � enumeration (Motion, Recording, RecordingWithTrigger).
   * @param {String} ItemKind - The kind of item for which the sequences are being requested (Camera, Microphone).
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getSequencesForView(
    cameraId,
    startTime,
    endTime,
    minTimeBetweenSequences,
    successCallback,
    errorCallback,
    SeqType,
    ItemKind,
  ) {
    return XPMobileSDK.library.Connection.getSequencesForView(
      cameraId,
      startTime,
      endTime,
      minTimeBetweenSequences,
      successCallback,
      errorCallback,
      SeqType,
      ItemKind,
    );
  }

  /**
   * Gets the exports for the currently logged user.
   *
   * @method getUserExports
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getUserExports(successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getUserExports(
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets all exports.
   *
   * @method getAllExports
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getAllExports(successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getAllExports(
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets an export by id.
   *
   * @method getExport
   * @param {String} id - ID of the export to retrieve (GUID).
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getExport(id, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getExport(
      id,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets a disposable export download link by ExportId
   *
   * @method createExportDownloadLink
   * @param {String} exportId - ID of the export(GUID).
   * @param {String} investigationId - ID of the investigation(GUID).
   * @param {String} exportType - Type of the export. Possible values: DB, AVI, MKV (the same as for triggering normal exports)
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function createExportDownloadLink(
    exportId,
    investigationId,
    exportType,
    successCallback,
    errorCallback,
  ) {
    return XPMobileSDK.library.Connection.createExportDownloadLink(
      exportId,
      investigationId,
      exportType,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Sends a GetOutputsAndEvents command to the server, gets configuration entry from the server.
   *
   * @method getOutputsAndEvents
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getOutputsAndEvents(successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getOutputsAndEvents(
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets server statistic (CPU load, network trafic etc.)
   *
   * @method getServerStatus
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getServerStatus(successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getServerStatus(
      successCallback,
      errorCallback,
    );
  }

  /**
   * Triggers an output or event.
   *
   * @method triggerOutputOrEvent
   * @param {String} objectId - the Id of the item
   * @param {String} triggerType - 'TriggerOutput' or 'TriggerEvent'
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function triggerOutputOrEvent(
    objectId,
    triggerType,
    successCallback,
    errorCallback,
  ) {
    return XPMobileSDK.library.Connection.triggerOutputOrEvent(
      objectId,
      triggerType,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets the camera capabilities - export, live, playback, ptz, presets.
   *
   * @method getCameraCapabilities
   * @param {String} cameraId - GUID of the camera
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getCameraCapabilities(cameraId, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getCameraCapabilities(
      cameraId,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Get new challenges from server
   *
   * @method requestChallenges
   * @param {Object} parameters - Object containing the following properties:
   * <pre>
   * - {Number} NumChallenges - Number of challenges that will be returned as a response.
   *                            Up to 100 can be requested at once.
   *                            There is limitation of the total challenges in the queue.
   *                            If exceeded error code is returned.
   * - {String} Reset - Whether to reset the list of challenges with a fresh one.('Yes', 'No')
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function requestChallenges(parameters, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.requestChallenges(
      parameters,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Create playback controller
   *
   * @method createPlaybackController
   * @param {Object} parameters - Object containing the following properties:
   * <pre>
   * - {String} SeekType - (optional) Makes seek of specific type: DbStart, DbEnd, PrevSeq, NextSeq,
   *                       PrevFrame, NextFrame, Time, TimeOrBefore, TimeOrAfter, TimeAfter, TimeBefore.
   * - {Number} Time - (optional) Time in miliseconds
   * - {Number} InvestigationId - (optional) The id of the investigation
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function createPlaybackController(
    parameters,
    successCallback,
    errorCallback,
  ) {
    return XPMobileSDK.library.Connection.createPlaybackController(
      parameters,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Change several streams at a time
   *
   * @method changeMultipleStreams
   * @param {Object} parameters - Object containing the following properties:
   * <pre>
   * - {String} PlaybackControllerId - Id of the video connection
   * - {Number} Speed - (optional) Speed of the playback (floating point). Sign determines the direction.
   * - {String} SeekType - (optional) Makes seek of specific type: Time.
   * - {Number} Time - (optional) Time of playback speed (in milliseconds since Unix epoch). Valid if "SeekType == Time"
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function changeMultipleStreams(parameters, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.changeMultipleStreams(
      parameters,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Get all investigations from server
   *
   * @method getAllInvestigations
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getAllInvestigations(successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getAllInvestigations(
      successCallback,
      errorCallback,
    );
  }

  /**
   * Get user investigations from server
   *
   * @method getUserInvestigations
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getUserInvestigations(successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getUserInvestigations(
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets a specific investigation by its id
   *
   * @method getInvestigation
   * @param {String} id - the investigation id
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getInvestigation(id, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getInvestigation(
      id,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Creates new investigation entry in the server.
   *
   * @method createInvestigation
   * @param {Object} parameters - Object containing the following properties:
   * <pre>
   * - {Number} StartTime - Start time of the investigation (milliseconds since Unix epoch)
   * - {Number} EndTime - End Time of the investigation (milliseconds since Unix epoch)
   * - {String} Name - Name of the investigation.
   * - {String} State - (optional) State of the investigation.
   * - {String} CameraId - (Multiple items possible) Id of the camera part of this investigation (Guid)
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing messages should
   *                                be sent from server while processing the request.
   *                                Default depends on the value in connect command.
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function createInvestigation(parameters, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.createInvestigation(
      parameters,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Updates/saves new parameters of already created investigation
   *
   * @method updateInvestigation
   * @param {Object} parameters - Object containing the following properties:
   * <pre>
   * - {Number} ItemId - Id of the already saved investigation.
   * - {Number} StartTime - Start time of the investigation (milliseconds since Unix epoch)
   * - {Number} EndTime - End Time of the investigation (milliseconds since Unix epoch)
   * - {String} Name - Name of the investigation.
   * - {String} State - (optional) State of the investigation.
   * - {String} CameraId - (Multiple items possible) Id of the camera part of this investigation (Guid)
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing messages should
   *                                be sent from server while processing the request.
   *                                Default depends on the value in connect command.
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function updateInvestigation(parameters, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.updateInvestigation(
      parameters,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Updates mata-data of the alredy created investigation
   *
   * @method updateInvestigationData
   * @param {Object} parameters - Object containing the following properties:
   * <pre>
   * - {Number} ItemId - Id of the already saved investigation.
   * - {String} Name - (optional) Name of the investigation.
   * - {String} State - (optional) State of the investigation.
   * - {String} ProcessingMessage - (optional) [Yes/No] Indicates whether processing messages should
   *                                be sent from server while processing the request.
   *                                Default depends on the value in connect command.
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function updateInvestigationData(parameters, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.updateInvestigationData(
      parameters,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Deletes investigation.
   *
   * @method deleteInvestigation
   * @param {Number} investigationId - Id of the investigation. Tricky values:
   * <pre>
   * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX - Single (concrete) investigation.
   * 00000000-0000-0000-0000-0000000000 - All investigation (My)
   * C6B4940C-A1E9-4BBF-9CFC-6E9CBF53FFE1 - All investigations (All users)
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function deleteInvestigation(
    investigationId,
    successCallback,
    errorCallback,
  ) {
    return XPMobileSDK.library.Connection.deleteInvestigation(
      investigationId,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Cancels investigation creation when in progress.
   *
   * @method cancelInvestigation
   * @param {Number} investigationId - Id of the investigation to delete.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function cancelInvestigation(investigationId) {
    return XPMobileSDK.library.Connection.cancelInvestigation(investigationId);
  }

  /**
   * Triggers new investigation export in the server.
   *
   * @method startInvestigationExport
   * @param {String} investigationId - Guid. Id of the investigation for which an export will be created.
   * @param {String} exportType - Type of the export to be triggered. Possible values: DB, AVI, MKV (the same as for triggering normal exports)
   * @param {String} includeAudio - YES/NO - flag whether to include audio in the investigation export
   * @param {String} password - password used to encrypt exported video
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function startInvestigationExport(
    investigationId,
    exportType,
    includeAudio,
    password,
    successCallback,
    errorCallback,
  ) {
    if (password) {
      password = XPMobileSDK.library.Connection.dh.encodeString(password);
    }
    return XPMobileSDK.library.Connection.startInvestigationExport(
      investigationId,
      exportType,
      includeAudio,
      password,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Deletes an investigation export on the server.
   *
   * @method deleteInvestigationExport
   * @param {String} investigationId - Guid. Id of the investigation for which an export will be created.
   * @param {String} exportType - Type of the export to be triggered. Possible values: DB, AVI, MKV (the same as for triggering normal exports)
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function deleteInvestigationExport(
    investigationId,
    exportType,
    successCallback,
    errorCallback,
  ) {
    return XPMobileSDK.library.Connection.deleteInvestigationExport(
      investigationId,
      exportType,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets a list of alarms
   *
   * @method getAlarmList
   * @param {Object} parameters - Object containing the following properties:
   * <pre>
   * - {String} MyAlarms - YES/NO - flag whether to send only my Alarms
   * - {Number} Timestamp - Target time
   * - {Number} Count - Max alarms count to return
   * - {String} Priority - Priority of the alarm (id of the priority type)
   * - {String} State - State of the alarm (id of the state type)
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getAlarmList(parameters, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getAlarmList(
      parameters,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets a single alarm.
   *
   * @method getAlarm
   * @param {String} alarmId - GUID of the alarm to be retrieved
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getAlarm(alarmId, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getAlarm(
      alarmId,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Update alarm details
   *
   * @method updateAlarm
   * @param {Object} parameters - Object containing the following properties:
   * <pre>
   * - {String} Id - Id of the Alarm to update
   * - {String} Comment - Updated comment
   * - {String} AssignedTo - Updated alarm assignee
   * - {String} Priority - Updated priority of the alarm (id of the priority type)
   * - {String} State - Updated state of the alarm (id of the state type)
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function updateAlarm(parameters, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.updateAlarm(
      parameters,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets settings for alarms (Priority, State).
   *
   * @method getAlarmDataSettings
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getAlarmDataSettings(successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getAlarmDataSettings(
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets list of users for a specified alarm. The alarm can be assigned to any one of these users.
   *
   * @method getAlarmUsers
   * @param {String} alarmId - GUID of the alarm for which users will be retrieved
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getAlarmUsers(alarmId, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getAlarmUsers(
      alarmId,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Acknowledges a given alarm.
   *
   * @method acknowledgeAlarm
   * @param {String} alarmId - Id of the Alarm to acknowlegde
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function acknowledgeAlarm(alarmId, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.acknowledgeAlarm(
      alarmId,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets a list of bookmarks
   *
   * @method getBookmarks
   * @param {Object} parameters - Object containing the following properties:
   * <pre>
   * - {String} MyBookmarks - YES/NO - flag whether to send only my Bookmarks
   * - {Number} Count - Maximum number of bookmarks to be returned in the result. If you want to retrieve a specific bookmark you should not specify the count, but provide the BookmarkId only.
   * - {String} StartTime - (Optional) Start time of the search interval. It specifies from where the search of bookmark will begin. If not specified current time will be considered as a start time.
   * - {String} EndTime - (Optional) End time of the search interval. If the EndTime is set before the StartTime than the bookmarks will be returned in reversed order again starting to search from StartTime to EndTime.
   * - {String} MyBookmarks - (Optional)YES/NO - flag whether to send only my Bookmarks
   * - {String} Keyword - (Optional)Search string to appear in either of the fields 'Reference', 'Header', 'Description'
   * - {String} SearchCameraIds - (Optional) Included cameras GUIDs in a comma separated string
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function getBookmarks(parameters, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.getBookmarks(
      parameters,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Gets a list of bookmarks. There are 3 valid usages of the command.
   * The first one is to provide Count in order to retrieve only the latest bookmarks.
   * The second one is to provide BookmarkId in order to retrieve a single bookmark.
   * And the last one is to get a list of bookmarks searching from specified bookmark - than BookmarkId and Count should be provided.
   *
   * @method GetBookmarks
   * @param {Object} params - Parameters to sent to the server.  May contain:
   * <pre>
   * - {String} BookmarkId - GUID of the Bookmark.
   *						   If specified along with Count, StartTime will be ignored and the Bookmark will be considered as a start time of the search interval.
   *						   If only BookmarkId is specified than single bookmark will be returned as a result
   * - {Number} Count - Maximum number of bookmarks to be returned in the result. If you want to retrieve a specific bookmark you should not specify the count, but provide the BookmarkId only.
   * - {String} StartTime - (Optional) Start time of the search interval. It specifies from where the search of bookmark will begin. If not specified current time will be considered as a start time.
   * - {String} EndTime - (Optional) End time of the search interval. If the EndTime is set before the StartTime than the bookmarks will be returned in reversed order again starting to search from StartTime to EndTime.
   * - {String} MyBookmarks - (Optional)YES/NO - flag whether to send only my Bookmarks
   * - {String} Keyword - (Optional)Search string to appear in either of the fields 'Reference', 'Header', 'Description'
   * - {String} SearchCameraIds - (Optional) Included cameras GUIDs in a comma separated string
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} failCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function GetBookmarks(parameters, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.GetBookmarks(
      parameters,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Delete a bookmark by given ID (GUID)
   *
   * @method deleteBookmark
   * @param {String} id - Id of a bookmark (GUID)
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function deleteBookmark(id, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.deleteBookmark(
      id,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Request the prev camera for the given carousel.
   *
   * @method prevCarouselCamera
   * @param {String} videoId - ID of the carousel stream
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function prevCarouselCamera(videoId) {
    return XPMobileSDK.library.Connection.prevCarouselCamera(videoId);
  }

  /**
   * Request the next camera for the given carousel.
   *
   * @method nextCarouselCamera
   * @param {String} videoId - ID of the carousel stream
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function nextCarouselCamera(videoId) {
    return XPMobileSDK.library.Connection.nextCarouselCamera(videoId);
  }

  /**
   * Pauses a carousel.
   *
   * @method pauseCarousel
   * @param {String} videoId - ID of the carousel stream
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function pauseCarousel(videoId) {
    return XPMobileSDK.library.Connection.pauseCarousel(videoId);
  }

  /**
   * Resumes a carousel.
   *
   * @method resumeCarousel
   * @param {String} videoId - ID of the carousel stream
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function resumeCarousel(videoId) {
    return XPMobileSDK.library.Connection.resumeCarousel(videoId);
  }

  /**
   * Gets the resampling factor
   *
   * @method getResamplingFactor
   *
   * @return {Number} - the resampling factor
   */
  function getResamplingFactor() {
    return (
      (XPMobileSDK.features.SupportsExtendedResamplingFactor &&
        XPMobileSDKSettings.resamplingFactor) ||
      1
    );
  }

  /**
   * Toggles the Diagnostics overlay setting
   *
   * @method toggleDiagnosticsOverlay
   *
   * @param {Boolean} enabled - Enable or not the overlay
   */
  function toggleDiagnosticsOverlay(enabled) {
    XPMobileSDK.library.Connection.toggleDiagnosticsOverlay(enabled);
  }

  /**
   * Toggles the Analytic Data setting
   *
   * @method toggleAnalytics
   *
   * @param {Boolean} enabled - Enable or not analytics
   */
  function toggleAnalytics(enabled) {
    XPMobileSDK.library.Connection.toggleAnalytics(enabled);
  }

  /**
   * Toggles the Direct streaming setting
   *
   * @method toggleDirectStreaming
   *
   * @param {Boolean} enabled - Enable or not direct streaming
   */
  function toggleDirectStreaming(enabled) {
    XPMobileSDK.library.Connection.toggleDirectStreaming(enabled);
  }

  /**
   * Register or update client notifications subscription with specified settings
   *
   * @method RegisterForNotifications
   * @param {Number} settings - Settings mask indicating whether the subscriber should recieve notification and what type of notifications will be send.
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   *
   * @return {ConnectionRequest} - the ConnectionRequest object
   */
  function registerForNotifications(setting, successCallback, errorCallback) {
    return XPMobileSDK.library.Connection.registerForNotifications(
      setting,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Register or update client notifications subscription with specified settings
   *
   * @method RegisterForNotifications
   * @param {Object} params - Parameters for the server. Can contain:
   * <pre>
   * - {String} DeviceId - The ID of the notifications subscriber.
   * - {String} DeviceName - Humanly readable device identifier. Expected to be encrypted
   * - {Number} Settings - Settings mask indicating whether the subscriber should recieve notification and what type of notifications will be send.
   * - {String} OptionalParamX - Humanly readable device identifier
   * - {String} OptionalParamY - Humanly readable device identifier
   * - {String} OptionalParamZ - Humanly readable device identifier
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function RegisterForNotifications(params, successCallback, errorCallback) {
    XPMobileSDK.library.Connection.RegisterForNotifications(
      params,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Create a bookmark for the specific device
   *
   * @method CreateBookmark
   * @param {Object} params - Parameters for the server. Can contain:
   * <pre>
   * - {String} VideoID (optional) - Id of the stream to bookmark (Guid), If it's not provided, CameraId, Name and Time are considered mandatory.
   * - {String} CameraId (mandatory) - Id of the camera to bookmark (Guid).
   * - {String} Name (mandatory) - Name of the bookmark
   * - {String} Description (optional) - Bookmark description. "Mobile bookmark" will be used if input param is empty.
   * - {String} Time (mandatory) - Exact time of the bookmark (milliseconds since Unix epoch).
   * - {String} StartTime (optional) - Start time of the bookmark (milliseconds since Unix epoch).
   * - {String} EndTime (optional) - End time of the bookmark (milliseconds since Unix epoch).
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function CreateBookmark(params, successCallback, errorCallback) {
    XPMobileSDK.library.Connection.CreateBookmark(
      params,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Update a bookmark for the specific device
   *
   * @method UpdateBookmark
   * @param {Object} params - Parameters for the server. Can contain:
   * <pre>
   * - {String} BookmarkId (mandatory) - Id of an existing bookmark which is to be modified (Guid).
   * - {String} Name (optional) - Name of the bookmark
   * - {String} Description (optional) - Bookmark description. "Mobile bookmark" will be used if input param is empty.
   * - {String} Time (optional) - Exact time of the bookmark (milliseconds since Unix epoch).
   * - {String} StartTime (optional) - Start time of the bookmark (milliseconds since Unix epoch).
   * - {String} EndTime (optional) - End time of the bookmark (milliseconds since Unix epoch).
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function UpdateBookmark(params, successCallback, errorCallback) {
    XPMobileSDK.library.Connection.UpdateBookmark(
      params,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Get information about bookmark like pre/post time and reserve reference for its creation which can be used after that
   *
   * @method RequestBookmarkCreation
   * @param {Object} params - Parameters for the server. Can contain:
   * <pre>
   * - {String} CameraId - Id of the camera to bookmark (Guid).
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function RequestBookmarkCreation(params, successCallback, errorCallback) {
    XPMobileSDK.library.Connection.RequestBookmarkCreation(
      params,
      successCallback,
      errorCallback,
    );
  }

  /**
   * Sends requests to the server. Creates ConnectionRequest instances.
   *
   * @method sendCommand
   * @param {String} commandName - the name of the command
   * @param {Object} requestParams - the parameters of the command
   * @param {Object} [options] - (optional) May contain:
   * <pre>
   * 	- {Number} timeout - time interval in milliseconds after which the request will be aborted
   * 	- {Boolean} reuseConnection - flag to reuse connection or not
   * 	- {String} viewId - the unique GUID of the view that we will work on
   * 	- {String} cameraId - the unique GUID of the camera that should be started
   * 	- {Function} successCallback - callback that is provided by the client code of the Network API which will be called during the execution of the callback parameter.
   * </pre>
   * @param {Function} successCallback - function that is called when the command execution was successful and the result is passed as a parameter.
   * @param {Function} errorCallback - function that is called when the command execution has failed and the error is passed as a parameter.
   */
  function sendCommand(
    commandName,
    requestParams,
    options,
    successCallback,
    failCallback,
  ) {
    XPMobileSDK.library.Connection.sendCommand(
      commandName,
      requestParams,
      options,
      successCallback,
      failCallback,
    );
  }

  /**
   * Destroys the connection
   *
   * @method destroy
   */
  function destroy() {
    XPMobileSDK.library.Connection.destroy();
  }
})();

/**
 * @class ConnectionObserver
 * @type {Object}
 * @property {Function} connectionStateChanged - Sent to observers when the connection state changes in any way
 * @property {Function} connectionDidConnect - Sent to observers when connection has connected to the server and is about to send credentials
 * @property {Function} connectionFailedToConnect - Sent to observers when connection attempted to connect to the server but failed.
 * @property {Function} connectionFailedToConnectWithId - Sent to observers when connecting with external connection ID has failed.
 * @property {Function} connectionRequiresCode - Sent to observers when connection is in the process of logging in, but requires additional verification code.
 * @property {Function} connectionCodeError - Sent to observers when connection is in the process of logging in, a code has been sent to the server for verification, but this code is wrong.
 * @property {Function} connectionDidLogIn - Sent to observers when connection has logged in.
 * @property {Function} connectionFailedToLogIn - Sent to observers when connection has failed to log in.
 * @property {Function} connectionLostConnection - Sent to observers when connection to the server was lost.
 * @property {Function} connectionProcessingDisconnect - Sent to observers when the disconnect command is sent.
 * @property {Function} connectionDidDisconnect - Sent to observers when connection to the server was closed on request via disconnect method.
 * @property {Function} connectionRequestSucceeded - Sent to observers every time a request to the server has been received properly and without timeout or other terminal errors.
 */
XPMobileSDK.interfaces.ConnectionObserver = {
  /**
   * Sent to observers when the connection state changes in any way
   *
   * @method connectionStateChanged
   */
  connectionStateChanged: function () {},

  /**
   * Sent to observers when connection has connected to the server and is about to send credentials
   *
   * @method connectionDidConnect
   * @param {Object} parameters - the object containing the response parameters.
   */
  connectionDidConnect: function (parameters) {},

  /**
   * Sent to observers when connection attempted to connect to the server but failed.
   * Note that error may be a null object if we have failed to even parse the response from the server.
   *
   * @method connectionFailedToConnect
   */
  connectionFailedToConnect: function (error) {},

  connectionDidConnectWithId: function () {},

  /**
   * Sent to observers when connecting with external connection ID has failed.
   *
   * @method connectionFailedToConnectWithId
   */
  connectionFailedToConnectWithId: function (error) {},

  /**
   * Sent to observers when connection is in the process of logging in, but requires additional verification code.
   *
   * @method connectionRequiresCode
   * @param {String} provider - the provider used to send a verification code.
   */
  connectionRequiresCode: function (provider) {},

  /**
   * Sent to observers when connection is in the process of logging in, a code has been sent to the server for verification, but this code is wrong.
   *
   * @method connectionCodeError
   */
  connectionCodeError: function () {},

  /**
   * Sent to observers when connection has logged in.
   *
   * @method connectionDidLogIn
   */
  connectionDidLogIn: function () {},

  /**
   * Sent to observers when connection has failed to log in. Check the error to determine if it was due to incorrect credentials!
   * Note that error may be a null object if we have failed to even parse the response from the server.
   *
   * @method connectionFailedToLogIn
   */
  connectionFailedToLogIn: function (error) {},

  /**
   * Sent to observers when connection to the server was lost.
   *
   * @method connectionLostConnection
   */
  connectionLostConnection: function () {},

  /**
   * Sent to observers when the disconnect command is sent.
   *
   * @method connectionProcessingDisconnect
   */
  connectionProcessingDisconnect: function () {},

  /**
   * Sent to observers when connection to the server was closed on request via disconnect method.
   *
   * @method connectionDidDisconnect
   */
  connectionDidDisconnect: function () {},

  /**
   * Sent to observers every time a request to the server has been received properly and without timeout or other terminal errors.
   * You can use that to keep track of the connection and monitor it is properly working.
   *
   * @method connectionRequestSucceeded
   */
  connectionRequestSucceeded: function (request, response) {},
};

/**
 * @class VideoConnectionObserver
 * @type {Object}
 * @property {Function} videoConnectionReceivedFrame - Called when new frame has arrived over the video connection
 * @property {Function} videoConnectionFailed - Called when an error has occurred during video streaming or in one of the internal control commands which has
 *                                               resulted in closing the connection completely.
 * @property {Function} videoConnectionTemporaryDown - Called when a HTTP error occurred
 * @property {Function} videoConnectionRecovered - Called after the connection is no longer down due to an HTTP error.
 * @property {Function} videoConnectionChangedState - Called if the state property of the connection has changed value.
 * @property {Function} videoConnectionStreamingError - Called when the streaming technology is no longer available.
 */
XPMobileSDK.interfaces.VideoConnectionObserver = {
  /**
   * Called when new frame has arrived over the video connection
   *
   * @method videoConnectionReceivedFrame
   * @param {ItemHeaderParser} frame - HeaderParser object representing the frame
   */
  videoConnectionReceivedFrame: function (frame) {},

  /**
   * Called when an error has occurred during video streaming or in one of the internal control commands which has
   * resulted in closing the connection completely.
   *
   * @method videoConnectionFailed
   */
  videoConnectionFailed: function () {},

  /**
   * Called when a HTTP error occurred
   *
   * @method videoConnectionTemporaryDown
   * @param {Number} errorCode - the HTTP error code returned from the server, or -1 if exception was thrown, or -2 if the request was aborted due to a missing response (happens more often on wireless networks)
   */
  videoConnectionTemporaryDown: function (errorCode) {},

  /**
   * Called after the connection is no longer down due to an HTTP error.
   *
   * @method videoConnectionRecovered
   */
  videoConnectionRecovered: function () {},

  /**
   * Called if the state property of the connection has changed value.
   *
   * @method videoConnectionChangedState
   */
  videoConnectionChangedState: function () {},

  /**
   * Called when the streaming technology is no longer available.
   *
   * @method videoConnectionStreamingError
   */
  videoConnectionStreamingError: function () {},
};

/**
 * @class ConnectionRequest
 * @type {Object}
 * @property {Object} params - All the params that need to be sent to the server
 * @property {Object} options - Options needed for custom logic before sending the connection request
 * @property {Object} response - Response of the connection request
 * @property {Object} cancel - Cancel the connection request
 */
XPMobileSDK.interfaces.ConnectionRequest = {
  params: Object(),
  options: Object(),
  response: Object(),

  cancel: function () {},
};

/**
 * @enum VideoConnectionSignal
 * @var {Number} live
 * @var {Number} playback
 */
XPMobileSDK.interfaces.VideoConnectionSignal = {
  live: 1,
  playback: 2,
};

/**
 * @class VideoConnectionSize
 * @type {Object}
 * @property {Number} width - width of the video stream in pixels
 * @property {Number} height - height of the video stream in pixels
 */
XPMobileSDK.interfaces.VideoConnectionSize = {
  width: Number(),
  height: Number(),
};

/**
 * @class VideoConnectionOptions
 * @type {Object}
 * @property {VideoConnectionSignal} signal - optional, live or playback stream
 * @property {Number} time - optional, timestamp for the playback stream
 * @property {Number} jpegCompressionLevel - optional, from 1 (best compression, worst quality) to 100 (worst compression, best quality)
 * @property {String} playbackControllerId - optional, for playback in multi-camera playback mode
 * @property {Boolean} keyFramesOnly - optional, receive only the key frames of the video stream
 * @property {Boolean} reuseConnection - optional, reuse existing connections for the same cameras
 */
XPMobileSDK.interfaces.VideoConnectionOptions = {
  signal: XPMobileSDK.interfaces.VideoConnectionSignal.live,
  time: Number(),
  jpegCompressionLevel: Number(),
  playbackControllerId: String(),
  keyFramesOnly: Boolean(),
  reuseConnection: Boolean(),
};

/**
 * @class VideoConnectionCropping
 * @type {Object}
 * @property {Number} left - left offset of the cropping frame in pixels
 * @property {Number} top - top offset of the cropping frame in pixels
 * @property {Number} right - right offset of the cropping frame in pixels, overrides width
 * @property {Number} bottom - bottom offset of the cropping frame in pixels, overrides height
 * @property {Number} width - width of the cropping frame in pixels
 * @property {Number} height - height of the cropping frame in pixels
 */
XPMobileSDK.interfaces.VideoConnectionCropping = {
  left: Number(),
  top: Number(),
  right: Number(),
  bottom: Number(),
  width: Number(),
  height: Number(),
};

/**
 * @class VideoConnection
 * @type {Object}
 * @property {String} videoId - GUID of the VideoConnection
 * @property {String} cameraId - GUID of the camera
 * @property {String} signalType - Type of the signal - Live, Playback or Upload.
 * @property {Boolean} isReusable - Flag indicating whether the connection reusable or not
 * @property {Boolean} isPush - Flag indicating whether it is a push connection
 * @property {Boolean} supportsPTZ -  Flag indicating whether PTZ is supported
 * @property {Boolean} supportsPTZPresets - Flag indicating whether it PTZ Presets are supported
 * @property {Boolean} supportsPlayback - Flag indicating whether Playback is supported
 * @property {Boolean} supportsExport - Flag indicating whether Exports are supported
 * @property {Object} request - VideoConnection request data
 * @property {Object} response - VideoConnection response data
 * @property {Function} open - Opens the connection to start receiving frames.
 * @property {Function} restart -Restarts the connection.
 * @property {Function} close - Closes the connection.
 * @property {Function} addObserver - Adds an observer for the video connection.
 * @property {Function} removeObserver - Removes an observer for the video connection.
 * @property {Function} resetCommunication - Resets communication
 * @property {Function} destroy - Class destructor.
 */
XPMobileSDK.interfaces.VideoConnection = {
  /**
   * @property {String} videoId - GUID of the VideoConnection
   */
  videoId: String(),

  /**
   * @property {String} cameraId - GUID of the camera
   */
  cameraId: String(),

  /**
   * @property {String} signalType - Type of the signal - Live, Playback or Upload.
   */
  signalType: String(),

  /**
   * @property {Boolean} isReusable - Flag indicating whether the connection reusable or not
   */
  isReusable: Boolean(),

  /**
   * @property {Boolean} isPush - Flag indicating whether it is a push connection
   */
  isPush: Boolean(),

  /**
   * @property {Boolean} supportsPTZ -  Flag indicating whether PTZ is supported
   */
  supportsPTZ: Boolean(),

  /**
   * @property {Boolean} supportsPTZPresets - Flag indicating whether it PTZ Presets are supported
   */
  supportsPTZPresets: Boolean(),

  /**
   * @property {Boolean} supportsPlayback - Flag indicating whether Playback is supported
   */
  supportsPlayback: Boolean(),

  /**
   * @property {Boolean} supportsExport - Flag indicating whether Exports are supported
   */
  supportsExport: Boolean(),

  /**
   * @property {Object} request - VideoConnection request data
   */
  request: { parameters: Object(), options: Object() },

  /**
   * @property {Object} response - VideoConnection response data
   */
  response: { parameters: Object() },

  /**
   * Opens the connection to start receiving frames.
   *
   * @method open
   */
  open: function () {},

  /**
   * Restarts the connection.
   *
   * @method restart
   */
  restart: function () {},

  /**
   * Closes the connection.
   *
   * @method close
   */
  close: function () {},

  /**
   * Adds an observer for the video connection.
   *
   * @method addObserver
   * @param {Object} observer - Any object. Should implement methods from the VideoConnectionObserverInterface.
   */
  addObserver: function (observer) {},

  /**
   * Removes an observer for the video connection.
   *
   * @method removeObserver
   * @param {Object} observer - Any object implementing VideoConnectionObserverInterface that should not receive further notifications
   */
  removeObserver: function (observer) {},

  /**
   * Resets communication
   *
   * @method resetCommunication
   */
  resetCommunication: function () {},

  /**
   * Class destructor.
   *
   * @method destroy
   */
  destroy: function () {},
};

/**
 * @class VideoPushConnection
 * @type {Object}
 * @property {Function} open - Opens the video push connection
 * @property {Function} close - Closes the video push connection
 * @property {Function} send - Sends video frame to server
 * @property {Function} destroy - Class destructor
 * @property {Function} isOpen - Checks if the connection is open
 * @property {Function} getMediaStream - Retrieves a media stream
 */
XPMobileSDK.interfaces.VideoPushConnection = {
  /**
   * Opens the video push connection
   *
   * @method open
   */
  open: function (successCallback, errorCallback) {},

  /**
   * Closes the video push connection
   *
   * @method close
   */
  close: function () {},

  /**
   * Sends video frame to server
   *
   * @method send
   */
  send: function (base64EncodedImage) {},

  /**
   * Class destructor
   *
   * @method destroy
   */
  destroy: function () {},

  /**
   * Checks if the connection is open
   *
   * @method isOpen
   *
   * @return Boolean - Returns the stream object if the connection is opened
   */
  isOpen: function () {
    return Boolean();
  },

  /**
   *   Retrieves a media stream
   *
   * @method getMediaStream
   */
  getMediaStream: function () {
    return new MediaStream();
  },
};