Developer Info¶

class openob.node.Node(node_name)[source]¶

OpenOB node instance.

Nodes run links. Each Node looks after its end of a link, ensuring that it remains running and tries to recover from failures, as well as responding to configuration changes.

Nodes have a name; everything else is link specific.

For instance, a node might be the ‘studio’ node, which would run a ‘tx’ end for the ‘stl’ link.

Nodes have a config host which is where they store their inter-Node data and communicate with other Nodes.

run_link(link_config, audio_interface)[source]¶

Run a new TX or RX node.

class openob.link_config.LinkConfig(link_name, redis_host)[source]¶

The LinkConfig class encapsulates link configuration. It’s genderless; a TX node should be able to set up a new link and an RX node should be able (once the TX node has specified the port caps) to configure itself to receive the stream using the data and methods in this config.

blocking_get(key)[source]¶

Get a value, blocking until it’s not None if needed

commit_changes(restart=False)[source]¶

To be called after calls to set() on a running link to signal a reconfiguration event for that link. If restart is True, the link should simply terminate itself so it can be restarted with the new parameters. If restart is False, the link should set all parameters it can which do not involve a restart.

get(key)[source]¶

Get a value from the config store

scoped_key(key)[source]¶

Return an appropriate key name scoped to a link

set(key, value)[source]¶

Set a value in the config store

set_from_argparse(opts)[source]¶

Given an optparse object from bin/openob, configure this link

class openob.audio_interface.AudioInterface(node_name, interface_name='default')[source]¶

The AudioInterface class describes an audio interface on a Node. The configuration is not shared across the network. The type property of an AudioInterface should define the mode of link operation.

get(key)[source]¶

Get a config value

set(key, value)[source]¶

Set a config value

set_from_argparse(opts)[source]¶

Set up the audio interface from argparse options