Skip to content

installers.infra.livekit #

Installer - Livekit Module

This module provides heroscript actions for installing and managing Livekit.

Actions

livekit.install

Installs the Livekit server.

Parameters:

  • reset (bool): If true, force a reinstall even if Livekit is already detected. Default: false.

Example:

!!livekit.install
reset: true

Constants #

const version = '1.9.0'

fn delete #

fn delete(args ArgsGet) !

fn exists #

fn exists(args ArgsGet) !bool

does the config exists?

fn get #

fn get(args ArgsGet) !&LivekitServer

fn heroscript_dumps #

fn heroscript_dumps(obj LivekitServer) !string

///////////NORMALLY NO NEED TO TOUCH

fn heroscript_loads #

fn heroscript_loads(heroscript string) !LivekitServer

fn list #

fn list(args ArgsList) ![]&LivekitServer

if fromdb set: load from filesystem, and not from mem, will also reset what is in mem

fn new #

fn new(args ArgsGet) !&LivekitServer

fn play #

fn play(mut plbook PlayBook) !

fn set #

fn set(o LivekitServer) !

register the config for the future

fn switch #

fn switch(name string)

switch instance to be used for livekit

struct ArgsGet #

@[params]
struct ArgsGet {
pub mut:
	name   string = 'default'
	fromdb bool // will load from filesystem
	create bool // default will not create if not exist
}

///////FACTORY

struct ArgsList #

@[params]
struct ArgsList {
pub mut:
	fromdb bool // will load from filesystem
}

struct InstallArgs #

@[params]
struct InstallArgs {
pub mut:
	reset bool
}

struct LivekitServer #

@[heap]
struct LivekitServer {
pub mut:
	name       string = 'default'
	apikey     string
	apisecret  string @[secret]
	configpath string
	nr         int = 0 // each specific instance onto this server needs to have a unique nr
}

THIS THE THE SOURCE OF THE INFORMATION OF THIS FILE, HERE WE HAVE THE CONFIG OBJECT CONFIGURED AND MODELLED

fn (LivekitServer) destroy #

fn (mut self LivekitServer) destroy() !

fn (LivekitServer) install #

fn (mut self LivekitServer) install(args InstallArgs) !

fn (LivekitServer) install_start #

fn (mut self LivekitServer) install_start(args InstallArgs) !

fn (LivekitServer) reload #

fn (mut self LivekitServer) reload() !

load from disk and make sure is properly intialized

fn (LivekitServer) restart #

fn (mut self LivekitServer) restart() !

fn (LivekitServer) running #

fn (mut self LivekitServer) running() !bool

fn (LivekitServer) start #

fn (mut self LivekitServer) start() !

fn (LivekitServer) stop #

fn (mut self LivekitServer) stop() !