Passer au contenu
Capgo - Live Updates for Capacitor Apps Capgo

Getting Started

Ce contenu n'est pas encore disponible dans votre langue.

Install

Section titled “Install”
Terminal window
bun add @capgo/capacitor-ivs-player
bunx cap sync

Import

Section titled “Import”
import { CapacitorIvsPlayer } from '@capgo/capacitor-ivs-player';

API Overview

Section titled “API Overview”

create

Section titled “create”

See the source 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

Section titled “start”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.start();

cast

Section titled “cast”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.cast();

getCastStatus

Section titled “getCastStatus”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.getCastStatus();

pause

Section titled “pause”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.pause();

delete

Section titled “delete”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.delete();

getUrl

Section titled “getUrl”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.getUrl();

getState

Section titled “getState”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.getState();

setPlayerPosition

Section titled “setPlayerPosition”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.setPlayerPosition();

getPlayerPosition

Section titled “getPlayerPosition”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.getPlayerPosition();

setAutoQuality

Section titled “setAutoQuality”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.setAutoQuality();

getAutoQuality

Section titled “getAutoQuality”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.getAutoQuality();

setPip

Section titled “setPip”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.setPip();

getPip

Section titled “getPip”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.getPip();

setFrame

Section titled “setFrame”

Set the frame of the player view, all number have to be positive and integers

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


await CapacitorIvsPlayer.setFrame();

getFrame

Section titled “getFrame”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.getFrame();

setBackgroundState

Section titled “setBackgroundState”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.setBackgroundState({} as { backgroundState: CapacitorIvsPlayerBackgroundState });

getBackgroundState

Section titled “getBackgroundState”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.getBackgroundState();

setMute

Section titled “setMute”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.setMute();

getMute

Section titled “getMute”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.getMute();

setQuality

Section titled “setQuality”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.setQuality();

getQuality

Section titled “getQuality”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.getQuality();

getQualities

Section titled “getQualities”

See the source definitions for the current contract.

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


await CapacitorIvsPlayer.getQualities();

Type Reference

Section titled “Type Reference”

CapacitorIvsPlayerState

Section titled “CapacitorIvsPlayerState”
export type CapacitorIvsPlayerState = 'IDLE' | 'BUFFERING' | 'READY' | 'PLAYING' | 'ENDED' | 'UNKNOWN';

CapacitorIvsPlayerBackgroundState

Section titled “CapacitorIvsPlayerBackgroundState”
export type CapacitorIvsPlayerBackgroundState = 'PAUSED' | 'PLAYING';

Source Of Truth

Section titled “Source Of Truth”

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.