![](\".docs/assets/SDKs_Communication.jpg\")
\n\n> ***Important**: Before sending or receiving messages, the session must be launched. You can check it with ON_APP_START event*\n\nHere are some examples:\n- If you want to change the color of an object from your website, you can:\n - Send a message with the final color from your website\n - From your application, get the color in the message and assign the material with the new color\n- If you want to get the position of the player to display it on your website\n - Send a message with player coord from the application\n - From your website, get the coordinates and show it on your website\n\nTo implement a bidirectionnal communication you can find details below:\n- About [Furioos SDK for Unity](https://github.com/Unity-Technologies/furioos-sdk-unity)\n- About [Furioos SDK for Unreal](https://github.com/Unity-Technologies/furioos-sdk-unreal-engine)\n\n### Example of application\nHere is an example of an application that customizes the Furioos player and uses the message system for a complete integration with the website.\\\nOn the left, the menu is on the website side (html).\\\nOn the right, the house dispay is on the application side (Furious player). \n\n![](\".docs/assets/sdk-ui-example.png\")
\n\n## Installation\n### Via NPM\n```bash\nnpm install --save furioos-sdk\n```\nor\n```bash\nyarn add furioos-sdk\n```\n\nYou can find a full example [HERE](/examples/furioos-sdk-js-npm-example)\n\n### Via CDN\n```bash\n\n```\n\nYou can find a full example [HERE](/examples/furioos-sdk-js-cdn-example)\n\n## API\n#### constructor(sdkShareLinkID, containerDivId, options)\nInstanciate the player for a given application.\n| Property | Type | Description | optional | DefaultValue |\n| --- | --- | --- | --- | --- |\n| **`sdkShareLinkID`** | String | Furioos SDK Link ID of the application you want to share. | false | null |\n| **`containerDivId`** | String | The ID of the HTML container div that will host the render. | false | null |\n| **`options`** | Object | The options to setup the player are these following : | true | {} |\n\n##### options:\n| Property | Type | Description | optional | DefaultValue |\n| --- | --- | --- | --- | --- |\n| **`whiteLabel`** | Boolean | Remove all Furioos' Logo | true | false |\n| **`hideToolbar`** | Boolean | Hide the toolbar to create your own | true | false |\n| **`hideTitle`** | Boolean | Hide the title bar to create your own | true | false |\n| **`hidePlayButton`** | Boolean | Hide the play button | true | false |\n| **`debugAppMode`** | Boolean | Active local debug of your application. See [Debug localy the SDK communication tunnel](#debug-localy-the-sdk-communication-tunnel) for more detail | true | false |\n| **`inactiveTimeout`** | Number | Defines the inactivity time in a session before it closes (in ms) Min: 10s / Max: 24h | true | 60000 (ms) |\n\n\n### Basic Example\n\n```javascript\nimport { Player, FS_SDK_EVENTS_NAME } from 'furioos-sdk';\n\nconst options = {\n whiteLabel: true,\n hideToolbar: false,\n hideTitle: true,\n hidePlayButton: false,\n inactiveTimeout: 60000,\n};\n\nconst player = new Player(\"YOUR_SDK_LINK_ID\" ,\"containerDivId\", options);\n\n// Bind player loaded\nplayer.on(FS_SDK_EVENTS_NAME.LOAD, function() {\n console.log(\"SDK client FIRED: Player loaded\");\n});\n\n// Bind application install progress\nplayer.on(FS_SDK_EVENTS_NAME.ON_APP_INSTALL_PROGRESS, function(data) {\n console.log(\"SDK client FIRED: App install progress\", data);\n});\n\n// Bind application start\nplayer.on(FS_SDK_EVENTS_NAME.ON_APP_START, function() {\n console.log(\"SDK client FIRED: App start\");\n});\n\n// Bind stream start\nplayer.on(FS_SDK_EVENTS_NAME.ON_STREAM_START, function() {\n console.log(\"SDK client FIRED: Stream start\");\n});\n\n// Bind stream start\nplayer.on(FS_SDK_EVENTS_NAME.ON_SDK_START, function() {\n console.log(\"SDK client FIRED: SDK start\");\n});\n\n// Bind SDK messages\nplayer.on(FS_SDK_EVENTS_NAME.ON_SDK_MESSAGE, function(data) {\n console.log(\"SDK Message Received:\", data);\n});\n\n// Bind an event that lets you know if you can resume session\nplayer.on(FS_SDK_EVENTS_NAME.ON_RESUME_SESSION, function({ canResumeSession }) {\n if(canResumeSession) {\n player.resumeSession();\n }\n});\n\n// Bind session stoppeds\nplayer.on(FS_SDK_EVENTS_NAME.ON_SESSION_STOPPED, function() {\n console.log(\"SDK client FIRED: Session Stopped\");\n});\n\n```\n\n## Properties\n>***important** These properties are only getters*\n#### quality: String\nGet the current setted quality. Possible values : AUTO / LOW / MEDIUM / HIGH\n\n#### volume: Number\nGet the current setted volume. Value between 0 - 1\n\n## Methods\nChange the thumbnail of your app.
\nCall this function to get an estimated time to get a session on Furioos.
\n\n Call this function to get unique VM informations.\n This function returns metadata only if a session is running.\n
\n\n Start a new session.\n
\n\n Set the quality of the stream.
\n Use the new quality values by importing FS_QUALITY_VALUES
\n :warning: You can access deprecated quality values by importing QUALITY_VALUES. However these value are no longer available.\n
\n Set the volume of the stream.\n
\n\n Bind a callback that will be called when the player is ready.\n
\n\n Bind a callback that will be called during your application installation.\n You'll receive the progress of the installation.\n
\n\n Bind a callback that will be called when your application installation has succeed.\n
\n\n Bind a callback that will be called when your application installation has failed.\n
\n\n Bind a callback that will be called when your application starts.\n
\n\n Bind a callback that will be called when the stream starts.\n
\n\n Bind a callback that will be called when the SDK start.\n
\nBind a callback that will be called when the user is **active** on your session (only fired when a session is running).
\nBind a callback that will be called when the user is **inactive** on your session (only fired when a session is running).
\nBind a callback that will be called when the session is stopped (ex: stopped for inactivity).
\nBind a callback that will be called frequently during a running session with all stats.
\n\n Bind a callback that will be called while your application is sending you data.\n Data can be a String or an Object.\n
\n\n Bind a callback that will be called when your application crashes.\n
\n\n Bind a callback that will be called when the player is initialized.\n It Lets you know if you can restart a session in progress.\n
\n\n Bind a callback to receive messages from your application.\n
\n\n Send data to your own application by using the Furioos SDK.\n
\n![](\".docs/assets/debug-mode.png\")
\n\n\n#### Unity Side\n\nNothing to configure. When you start your application(With last version of the Furioos SDK Unity) with the play button in the Unity Editor, the local debug mode is automatically enabled.\n\n#### Unreal Engine Side\n\nFor the moment, it is not possible activate the debug mode. The new version of the Furioos SDK for Unreal is coming soon.\n\n## :warning: Common Errors\n\n- *Failed to execute 'postMessage' on 'DOMWindow': The target origin (http://....) provided does not match the recipient window's origin ('http://...')*\n\n This error means that you do not have the correct website URL set on your SDK link, on Furioos side. \nYour player’s implementation url must match the website URL entered when creating your SDK link on the Furioos side. \nIf you’re working locally, remind that you might need to change the URL on the SDK Link, example: http://localhost:8080. ","readmeFilename":"README.md"}