Image

A component for rendering images:

• From external URLs
• From the server hosting a Smelter instance

Note

To use this component, you need to first register the image with a matching imageId using the Smelter.registerImage function.

Reference

ImageExample.tsx

import { Image, View } from "@swmansion/smelter";
import Smelter from "@swmansion/smelter-node";

function ExampleApp() {
  return (
    <View style={{ backgroundColor: "rgb(255,255,255)" }}>
      <Image source="https://example.com/image.svg" />
    </View>
  );
}

async function run() {
  const smelter = new Smelter();
  await smelter.init();

  await smelter.registerOutput("output", <ExampleApp />, {
    type: "mp4",
    serverPath: "./output.mp4",
    video: {
      encoder: {
        type: "ffmpeg_h264",
        preset: "ultrafast",
      },
      resolution: {
        width: 1920,
        height: 1080,
      },
    },
  });

  await smelter.start();
}
void run();

Type definitions

type ImageProps = {
  id?: string;
  imageId: string;
}

Props

imageId

ID of an image. It identifies an image registered using a Smelter.registerImage method.

• Type: string

---

id

ID of a component.

• Type: string
• Default value: Value produced by useId hook