Host API
chevron down
 

Host API

Interface: Host

Host API Information about the environment in which the companion runs

import { me as companion } from "companion"

console.log(`App Name: ${companion.host.app.name}`);
console.log(`App Version: ${companion.host.app.version}`);

console.log(`OS Name: ${companion.host.os.name}`);
console.log(`OS Version: ${companion.host.os.version}`);

Properties

readonly app

{ readonly name: string; readonly version: string; }

readonly os

{ readonly name: "Android" or "iOS" or "Windows"; readonly version: string; }