Skip to main content

Installation

Using a CDN​

The easiest way to get started is by using a CDN like UNPKG:

<script type="module" src="https://unpkg.com/@miris-inc/components"></script>
<miris-scene viewer-key="IxJZJ3EYY2zBEl0ZPOJjf7QELIxwoKTcgRl-MqPE0p8">
  <miris-stream uuid="ec0897ea-fc0f-48d4-a03b-a0bd5e0a0417"></miris-stream>
</miris-scene>

You’re now ready to create a scene and begin streaming.

Using a package manager​

For more advanced setups, you may wish to use a package manager such as npm or bun.

First, install the @miris-inc/components package with your preferred package manager:

npm install @miris-inc/components

Then, simply import the package and add a scene:

import "@miris-inc/components";
<miris-scene viewer-key="l2LWVHS39ZhmXDOtefPoOmvPdAp55OxTPJfwVmNo7rY">
  <miris-stream uuid="68142886-80e8-4b1b-8445-4a235406273c"></miris-stream>
</miris-scene>

This will automatically register the custom elements included in this package.

Now you’re now ready to create a scene and begin streaming.