@onirix/embed-sdk
Advanced tools
Readme
Take control of your Onirix augmented reality experiences. Responds to user interaction and acts on the 3D content of the scene.
This library acts as a wrapper of window.postMessage for simplifying communication with Onirix AR experiences. Not only can you use it in the online code editor of Onirix Studio projects, you can also connect to your scene loaded in an iFrame.
Take Onirix experiences to the next level.
Full documentation available at Onirix Docs.
npm install @onirix/embed-sdk
Or include the dependency within the HTML head tag:
<head>
<script src="https://unpkg.com/@onirix/embed-sdk@1.9.0/dist/ox-embed-sdk.esm.js">
</head>
Or as ESM modules:
import OnirixEmbedSDK from "https://unpkg.com/@onirix/embed-sdk@1.9.0/dist/ox-embed-sdk.esm.js";
Just create an instance of our EmbedSDK and execute the connect method. From that moment on you will be able to subscribe to the events that occur in the scene and you will be able to execute actions on the elements of the experience.
const embedSDK = new OnirixEmbedSDK();
await embedSDK.connect();
embedSDK.subscribe(OnirixEmbedSDK.Events.ELEMENT_CLICK, (params) => {
console.log('somebodey clicks me!', params);
});
embedSDK.enable(elementOid);
If you have embedded an Onirix Studio experience in your application through an iframe, you must pass the Html element of the iFrame to the EmbedSDK constructor.
const iframeElement = document.getElementById("<iframe_element_id>");
const embedSDK = new OnirixEmbedSDK(iframeElement);
Make sure that the iFrame is already loaded before instantiating the EmbedSDK.
See the complete list of events and actions in our documentation.
👤 Onirix
FAQs
Onirix helper library for iframe event communication.
The npm package @onirix/embed-sdk receives a total of 249 weekly downloads. As such, @onirix/embed-sdk popularity was classified as not popular.
We found that @onirix/embed-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.