This documentation is for a deprecated version. For the latest version, please refer to: [Coming soon]
This API v1.0.0 create a safe cross-origin communication between the VR360+ embeded and the main page via Window.postMessage().
It is in the form of JavaScript library you include in your own code.
<script type="text/javascript" src="https://apps.zondavirtual.com/api/ZondaVR360WebappApiv1.0.0.min.js"></script> ¶ Initialization
Declare an API variable. This will Initialize the cross-origin communication. The variable will be used later for all other function calls.
¶ IFrame Object
<iframe id="vr360Iframe" style="height: 100%;width:100%" src="https://apps.zondavirtual.com/vr360/index.html?id=d87e18db-3def-45ac-adb1-b9d4a6d045bc" onload="iframeLoaded(event)"></iframe>The VR360+ link need to be set as the source of the IFrame. The API takes some time to initialize once initialized an event is sent to call back function.
¶ Parameters:
- IFrame*: Reference DOM element or element string id.
- CallBackFunctionName : Call back function on initialization.
Those marked with* are mandatory.
function iframeLoaded(event)
{
vr360WebApi = new ZondaVR360WebAppApi(document.getElementById("vr360Iframe"),"vr360callbackFunction");
}¶ Message ID returns
- "S_001" : “Success”
- "S_002" : “VR360+ API connected to [IFrameId]”
- "S_003" : “VR360+ Loaded!”
- "E_001" : “IFrame [IFrameId] doesn't exist ”
- "E_002" : "The connection with the VR360+ is not established"
¶ Console Errors:
IFrame container is undefined. Review the Iframe parameter.
¶ GetConfigId API Call
- vpsApi.getConfigId(callback) : Get ConfigID for current View.
vr360WebApi.getConfigId((e) => {console.log(e)})
- callBackFunction: Call back function. Used to get ConfigID of the current VR360.
¶ Return Config ID.
¶ URL parameters.
- callbackFunction: To get the returned ConfigID.
¶ Other Available Functions
- vr360WebApi.getConfigJSON(callBackFunction): Returns a list of all selected options in JSON format.
- vr360WebApi.loadConfigId(configID, callBackFunction): Load a configID and apply it to the current scene.
- vr360WebApi.downloadImage(callBackFunction): Start a browser Download of the current view in PNG.
- vr360WebApi.getImage(callBackFunction): Returns an image of the current view in base64.
Demo URL: https://apps.zondavirtual.com/demo/VR360CommunicationAPI/index.html
¶ Version History
- 1.0
- Initial Release