2
ModuleConfigCondition
Mees van der Wijk edited this page 2025-08-28 00:49:03 +02:00

Module config Condition

A condition is a way for a cue list to wait till a condition is met. There are two types of conditions: server or client.

Client Conditions

Client conditions can be met via the ModuleClientAPI. Because the ModuleClientAPI runs on the machines of viewers which you can not trust, Getiyo has a system that allows cue list makers to specify a minimum percentage of clients to have met the condition before continuing. The ModuleServerAPI can force a client condition.

Server Conditions

Server conditions can be met via the ModuleServerAPI.

Although these two types of conditions function differently you specify them the same way in your module.json. Below is an example of what a condition would look like:

{
    "title": "Wait for something",
    "description": "This will wait till something will happen."
}
Parameter Description
title Visual title of the condition
description Short description that explains what the condition does

View module.json.