umd Module

UmdInput Class

class tallypi.inputs.umd.UmdInput(*args, **kwargs)

Bases: tallypi.common.BaseInput

Networked tally input using the UMDv5 protocol

Parameters

• config (MultiTallyConfig) – The initial value for config

• hostaddr (str, optional) – The local hostaddr to listen on. Defaults to tslumd.receiver.UmdReceiver.DEFAULT_HOST

• hostport (int, optional) – The UDP hostport to listen on. Defaults to tslumd.receiver.UmdReceiver.DEFAULT_PORT

receiver: tslumd.receiver.UmdReceiver

The tslumd server

classmethod get_init_options() → Tuple[tallypi.config.Option]

Get the config.Option definitions required for this object

property hostaddr

The hostaddr of the receiver

property hostport

The hostport of the receiver

async open()

Initalize any necessary device communication

async close()

Close device communication

async set_hostaddr(hostaddr: str)

Set the hostaddr on the receiver

async set_hostport(hostport: int)

Set the hostport on the receiver

get_screen(screen_index: int) → Optional[tslumd.tallyobj.Screen]

Get a Screen object by the given index

If no screen exists, None is returned

get_all_screens() → Iterable[tslumd.tallyobj.Screen]

Get all available Screen instances for the input

get_tally(tally_key: Tuple[int, int]) → Optional[tslumd.tallyobj.Tally]

Get a Tally object by the given key

If no tally information exists for this input, None is returned

Parameters

tally_key (tslumd.common.TallyKey) – A tuple of (screen_index, tally_index) formatted as SingleTallyConfig.tally_key

get_all_tallies(screen_index: False) → Iterable[tslumd.tallyobj.Tally]

Get all available Tally instances for the input

Parameters

screen_index (int, optional) – If present, only include tallies within the specified screen