umd
Module¶
UmdInput Class¶
-
class
tallypi.inputs.umd.
UmdInput
(*args, **kwargs)[source]¶ 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 totslumd.receiver.UmdReceiver.DEFAULT_HOST
hostport (int, optional) – The UDP
hostport
to listen on. Defaults totslumd.receiver.UmdReceiver.DEFAULT_PORT
-
receiver
: tslumd.receiver.UmdReceiver¶ The tslumd server
-
classmethod
get_init_options
() → Tuple[tallypi.config.Option][source]¶ Get the
config.Option
definitions required for this object
-
get_screen
(screen_index: int) → Optional[tslumd.tallyobj.Screen][source]¶ Get a
Screen
object by the given indexIf no screen exists,
None
is returned
-
get_all_screens
() → Iterable[tslumd.tallyobj.Screen][source]¶ Get all available
Screen
instances for the input
-
get_tally
(tally_key: Tuple[int, int]) → Optional[tslumd.tallyobj.Tally][source]¶ Get a
Tally
object by the given keyIf no tally information exists for this input,
None
is returned- Parameters
tally_key (tslumd.common.TallyKey) – A tuple of (
screen_index
,tally_index
) formatted asSingleTallyConfig.tally_key
-
get_all_tallies
(screen_index: False) → Iterable[tslumd.tallyobj.Tally][source]¶ Get all available
Tally
instances for the input- Parameters
screen_index (int, optional) – If present, only include tallies within the specified screen