How to Show Local Images

Sources used in Eyeson video meetings aren't limited to server-hosted files - you can also use images directly from your local drive. This guide demonstrates how to overlay a local image onto your video stream.

curl

export ACCESS_KEY=...
curl -X POST \
  -F "file=@path/to/local/file.png" \
  -F "z-index=1" \
  "https://api.eyeson.team/rooms/$ACCESS_KEY/layers"

node sdk

import fs from 'node:fs';
import Eyeson from '@eyeson/node';

const file = './path/to/local/file.png';
const accessKey = '...';
const eyeson = new Eyeson();
const user = await eyeson.getUser(accessKey);
const buffer = await fs.promises.readFile(file);
await user.sendLayer(buffer, 1);

go sdk

import (
  "os"
  eyeson "github.com/eyeson-team/eyeson-go"
)
accessKey := "..."
userService, _ := eyeson.NewUserServiceFromAccessKey(accessKey)
buffer, _ := os.ReadFile("./path/to/local/file.png")
userService.SetLayerImage(buffer, eyeson.PNG, eyeson.Foreground, nil)

php sdk

$file = './path/to/local/file.png';
$accessKey = '...';
$eyeson = new Eyeson();
$layer = $eyeson->layer($accessKey);
$layer->sendImageFile($file, 1);

Removing Image Overlays

To remove an image overlay from the video stream, use the following API calls. This will clear the specified layer and remove the image from the meeting view.

curl

curl -X DELETE "https://api.eyeson.team/rooms/$ACCESS_KEY/layers/1"

node sdk

const accessKey = '...';
const eyeson = new Eyeson();
const user = await eyeson.getUser(accessKey);
await user.clearLayer(1);

go sdk

accessKey := "..."
userService, _ := eyeson.NewUserServiceFromAccessKey(accessKey)
userService.ClearLayer(eyeson.Foreground)

php sdk

$accessKey = '...';
$eyeson = new Eyeson();
$layer = $eyeson->layer($accessKey);
$layer->clear(1);