Call this function to get an estimated time to get a session on Furioos.

data: | Property | Type | Description | DefaultValue | | --- | --- | --- | --- | | assignTime | Number | Estimated time (minutes) to be assigned to a server | 0 | | launchTime | Number | Estimated time (minutes) for your app to be ready (copied, extracted and launched) | 0 | | availableMachines | Number | Number of ready VM waiting for a session | 0 | | maximumMachines | Number | Maximum machines setted on your campaign | 0 | | usedMachines | Number | Number of current used machines in your pool | 0 | | creatingMachines | Number | Number of creating machines (creating machine in the cloud) | 0 | | installingMachines | Number | Number of installing machine (installing your application on it) | 0 |

*Those values are only available for an application running on a pre-allocated campaign.

Example:

    player.getServerAvailability(function(data) {
      console.log("Time to assign a server: ", data.assignTime);
      console.log("Time to copy, extract and launch your application: ", data.launchTime);
      console.log("Number of machines ready for a session: ", data.availableMachines);
      console.log("Total time to get session ready: ", data.assignTime + data.launchTime);
    }, function(error) {
      // Treat the error.
    });

Call this function to get unique VM informations. This function returns metadata only if a session is running.

metadata: | Property | Type | Description | DefaultValue | | --- | --- | --- | --- | | publicIP | String | The VM public IP. | "" | | name | String | A unique name to identify a VM. | "" |

Example:

    player.getServerMetadata(function(metadata) {
      console.log("Public VM IP: ", metadata.publicIP);
      console.log("VM unique name: ", metadata.name);
    }, function(error) {
      // Treat the error.
    });

Start a new session.

Example:

    player.start(Player.regions.EUW);

Set the quality of the stream.
Use the new quality values by importing FS_QUALITY_VALUES
:warning: You can access deprecated quality values by importing QUALITY_VALUES. However these value are no longer available.

Example:

    player.setQuality(FS_QUALITY_VALUES.HIGH);

Set the volume of the stream.

Example:

    player.setVolume(0.5);

Bind a callback that will be called when the player is ready.

Example

  player.on(FS_SDK_EVENTS_NAME.LOAD, function(data) {
     // Here you know when the player is ready.
      console.log("SDK client FIRED: Player loaded");
  })

Bind a callback that will be called during your application installation. You'll receive the progress of the installation.

data: | Property | Type | Description | Value | | --- | --- | --- | --- | | status | String | The current installation step | "COPY" or "UNARCHIVE" | | progress | Number | The progress value | between 0 and 1 |

Example

  player.on(FS_SDK_EVENTS_NAME.ON_APP_INSTALL_PROGRESS, function(data) {
    // Implement your own code.
    console.log(data.status + " the application : " + Math.round(data.progress*100) + "%");
  })

Bind a callback that will be called when your application installation has succeed.

Example

  player.on(FS_SDK_EVENTS_NAME.ON_APP_INSTALL_SUCCESS, function() {
    // Implement your own code.
    console.log("My application is fully installed");
  })

Bind a callback that will be called when your application installation has failed.

Example

  player.on(FS_SDK_EVENTS_NAME.ON_APP_INSTALL_FAIL, function() {
    // Implement your own code.
    console.log("Installation has failed");
  })

Bind a callback that will be called when your application starts.

Example

  player.on(FS_SDK_EVENTS_NAME.ON_APP_START, function() {
    // Implement your own code.
    console.log("Application started");
  })

Bind a callback that will be called when the stream starts.

Example

  player.on(FS_SDK_EVENTS_NAME.ON_STREAM_START, function() {
    // Implement your own code.
    console.log("Stream started");
  })

Bind a callback that will be called when the SDK start.

Example

  player.on(FS_SDK_EVENTS_NAME.ON_SDK_START, function() {
    // Implement your own code.
    console.log("SDK started");
  })

Bind a callback that will be called when the user is **active** on your session (only fired when a session is running).

Example

player.on(FS_SDK_EVENTS_NAME.ON_USER_ACTIVE, function() {
  // Implement your own code.
  console.log("My user is active");
})

Bind a callback that will be called when the user is **inactive** on your session (only fired when a session is running).

Example

player.on(FS_SDK_EVENTS_NAME.ON_USER_INACTIVE, function() {
  // Implement your own code.
  console.log("My user is inactive");
})

Bind a callback that will be called when the session is stopped (ex: stopped for inactivity).

Example

player.on(FS_SDK_EVENTS_NAME.ON_SESSION_STOPPED, function() {
  // Implement your own code.
  console.log("The session has been stopped");
})

Bind a callback that will be called frequently during a running session with all stats.

stats: | Property | Type | Description | DefaultValue | | --- | --- | --- | --- | | appHeight | Number | Height of the application screen on VM | 0 | | appWidth | Number | Width of the application screen on VM | 0 | | dataLatency | Number | Round trip network latency | 0 | | dataMethod | String | events/data transmission method (value: "datachannel" or "ws") | "datachannel" | | packetsLost | Number | Percent of lost packets (value: 0 to 1) | 0 | | serverCpuUsage | Number | Server CPU usage | 0 | | serverEncodingMs | Number | Server encoding time (milliseconds) | 0 | | serverFramerate | Number | Server framerate | 0 | | serverGpuMemTotal | Number | Total GPU RAM available on server (byte) | 0 | | serverGpuMemUsed | Number | Current GPU RAM used on server (byte) | 0 | | serverGpuUsage | Number | Server GPU usage percent | 0 | | serverGrabbingMs | Number | Server grabbing time (milliseconds) | 0 | | serverRamTotal | Number | Total RAM available on serve (byte) | 0 | | serverRamUsed | Number | Current RAM used on server (byte) | 0 | | streamingEngine | String | Current streaming engine used (value: "Furioos" or "RenderStreaming") | "Furioos" | | userActive | Boolean | Define if the user is consider as active by the Furioos player | 0 | | videoBitrate | Number | Received video bitrate (kbps) | 0 | | videoFramerate | Number | Received video framerate | 0 | | videoHeight | Number | Heigh of the received video | 0 | | videoWidth | Number | Width of the received video | 0 | | videoLatency | Number | Total video latency (round trip network latency + decoding time) | 0 |

Example

  player.on(FS_SDK_EVENTS_NAME.ON_STATS, function(stats) {
    // Implement your own code.
    console.log("Stats received: ", stats);
  })

Bind a callback that will be called while your application is sending you data. Data can be a String or an Object.

Example

  player.on(FS_SDK_EVENTS_NAME.ON_SDK_MESSAGE, function(data) {
    // Implement your own code.
    console.log("The application sent: " + data);
  })

Bind a callback that will be called when your application crashes.

Example

  player.on(FS_SDK_EVENTS_NAME.ON_CRASH_APP, function() {
    // Implement your own code.
    console.log("The application crashed");
  })

Bind a callback that will be called when the player is initialized. It Lets you know if you can restart a session in progress.

data: | Property | Type | Description | Value | | --- | --- | --- | --- | | canResumeSession | Boolean | Define if you can resume a session or not | |

Example

  player.on(FS_SDK_EVENTS_NAME.ON_RESUME_SESSION, function(data) {
    // Implement your own code.
    if(data.canResumeSession) {
      player.resumeSession();
    }
    console.log("Can resume sesssion: " + data.canResumeSession);
  })

Bind a callback to receive messages from your application.

Example:

    player.on(FS_SDK_EVENTS_NAME.ON_SDK_MESSAGE, function(data) {
      console.log("Message received from my application: ", data);
    });

Send data to your own application by using the Furioos SDK.

Example:

    player.sendSDKMessage({ "test": "test" });