Skip to main content
Back to plugins
@capgo/ivs-player
Tutorial
by github.com/Cap-go

IVS Player

Stream ultra-low latency live video using Amazon Interactive Video Service (IVS)

Guide

Tutorial on IVS Player

Using @capgo/capacitor-ivs-player

Ivs player for capacitor app.

Install

bun add @capgo/capacitor-ivs-player
bunx cap sync

What This Plugin Exposes

  • create
  • start
  • cast
  • getCastStatus

Example Usage

create

See the upstream definitions for the current contract.

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.create({} as {
    url: string;
    pip?: boolean;
    title?: string;
    subtitle?: string;
    cover?: string;
    autoPlay?: boolean;
    toBack?: boolean;
    x?: number;
    y?: number;
    width?: number;

    height?: number;
  });

start

See the upstream definitions for the current contract.

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.start();

cast

See the upstream definitions for the current contract.

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.cast();

getCastStatus

See the upstream definitions for the current contract.

import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

await CapacitorIvsPlayer.getCastStatus();

Full Reference