ezmsg.lsl.inlet

Classes

class LSLInfo(name: str = '', type: str = '', host: str = '', channel_count: int | None = None, nominal_srate: float = 0.0, channel_format: str | None = None)

Bases: object

Parameters:

• name (str)

• type (str)

• host (str)

• channel_count (int | None)

• nominal_srate (float)

• channel_format (str | None)

name: str = ''

type: str = ''

host: str = ''

channel_count: int | None = None

nominal_srate: float = 0.0

channel_format: str | None = None

__init__(name='', type='', host='', channel_count=None, nominal_srate=0.0, channel_format=None)

Parameters:

• name (str)

• type (str)

• host (str)

• channel_count (int | None)

• nominal_srate (float)

• channel_format (str | None)

Return type:

None

class LSLInletGenerator(*args, **kwargs)

Bases: LSLInletProducer

Deprecated: use LSLInletProducer instead.

__init__(*args, **kwargs)

class LSLInletProducer(*args, settings=None, **kwargs)

Bases: BaseStatefulProducer[LSLInletSettings, AxisArray | None, LSLInletProducerState]

Parameters:

settings (LSLInletSettings | None)

__init__(*args, settings=None, **kwargs)

Parameters:

settings (LSLInletSettings | None)

shutdown()

Return type:

None

class LSLInletProducerState

Bases: object

__init__()

Return type:

None

resolver: ContinuousResolver | None = None

inlet: StreamInlet | None = None

clock_sync: ClockSync | None = None

msg_template: AxisArray | None = None

fetch_buffer: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None

hash: int = -1

class LSLInletSettings(info: LSLInfo = <factory>, local_buffer_dur: float = 1.0, use_arrival_time: bool = False, use_lsl_clock: bool = False, processing_flags: int = 15)

Bases: Settings

Parameters:

• info (LSLInfo)

• local_buffer_dur (float)

• use_arrival_time (bool)

• use_lsl_clock (bool)

• processing_flags (int)

info: LSLInfo

local_buffer_dur: float = 1.0

use_arrival_time: bool = False

Whether to ignore the LSL timestamps and use the time.time of the pull (True). If False (default), the LSL (send) timestamps are used. Send times may be converted from LSL clock to time.time clock. See use_lsl_clock.

use_lsl_clock: bool = False

Whether the AxisArray.Axis.offset should use LSL’s clock (True) or time.time’s clock (False – default).

processing_flags: int = 15

The processing flags option passed to pylsl.StreamInlet. Default is proc_ALL which includes all flags. Many users will want to set this to pylsl.proc_clocksync to disable dejittering.

__init__(info=<factory>, local_buffer_dur=1.0, use_arrival_time=False, use_lsl_clock=False, processing_flags=15)

Parameters:

• info (LSLInfo)

• local_buffer_dur (float)

• use_arrival_time (bool)

• use_lsl_clock (bool)

• processing_flags (int)

Return type:

None

class LSLInletUnit(*args, settings=None, **kwargs)

Bases: BaseProducerUnit[LSLInletSettings, AxisArray | None, LSLInletProducer]

Represents a node in a graph that creates an LSL inlet and forwards the pulled data to the unit’s output.

Parameters:

• stream_name – The name of the created LSL outlet.

• stream_type – The type of the created LSL outlet.

• settings (Settings | None)

SETTINGS

alias of LSLInletSettings

create_producer()

Create the producer instance from settings.

Return type:

None

shutdown()

Runs when the Unit terminates.

This is called from within the same process this unit will live in. This lifecycle hook can be overridden. It can be run as async functions by simply adding the async keyword when overriding.

This method is where you should clean up resources and perform any necessary shutdown procedures.

Return type:

None

class LSLInfo(name: str = '', type: str = '', host: str = '', channel_count: int | None = None, nominal_srate: float = 0.0, channel_format: str | None = None)

Bases: object

Parameters:

• name (str)

• type (str)

• host (str)

• channel_count (int | None)

• nominal_srate (float)

• channel_format (str | None)

name: str = ''

type: str = ''

host: str = ''

channel_count: int | None = None

nominal_srate: float = 0.0

channel_format: str | None = None

__init__(name='', type='', host='', channel_count=None, nominal_srate=0.0, channel_format=None)

Parameters:

• name (str)

• type (str)

• host (str)

• channel_count (int | None)

• nominal_srate (float)

• channel_format (str | None)

Return type:

None

class LSLInletSettings(info: LSLInfo = <factory>, local_buffer_dur: float = 1.0, use_arrival_time: bool = False, use_lsl_clock: bool = False, processing_flags: int = 15)

Bases: Settings

Parameters:

• info (LSLInfo)

• local_buffer_dur (float)

• use_arrival_time (bool)

• use_lsl_clock (bool)

• processing_flags (int)

info: LSLInfo

local_buffer_dur: float = 1.0

use_arrival_time: bool = False

Whether to ignore the LSL timestamps and use the time.time of the pull (True). If False (default), the LSL (send) timestamps are used. Send times may be converted from LSL clock to time.time clock. See use_lsl_clock.

use_lsl_clock: bool = False

Whether the AxisArray.Axis.offset should use LSL’s clock (True) or time.time’s clock (False – default).

processing_flags: int = 15

The processing flags option passed to pylsl.StreamInlet. Default is proc_ALL which includes all flags. Many users will want to set this to pylsl.proc_clocksync to disable dejittering.

__init__(info=<factory>, local_buffer_dur=1.0, use_arrival_time=False, use_lsl_clock=False, processing_flags=15)

Parameters:

• info (LSLInfo)

• local_buffer_dur (float)

• use_arrival_time (bool)

• use_lsl_clock (bool)

• processing_flags (int)

Return type:

None

class LSLInletProducerState

Bases: object

__init__()

Return type:

None

resolver: ContinuousResolver | None = None

inlet: StreamInlet | None = None

clock_sync: ClockSync | None = None

msg_template: AxisArray | None = None

fetch_buffer: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None

hash: int = -1

class LSLInletProducer(*args, settings=None, **kwargs)

Bases: BaseStatefulProducer[LSLInletSettings, AxisArray | None, LSLInletProducerState]

Parameters:

settings (LSLInletSettings | None)

__init__(*args, settings=None, **kwargs)

Parameters:

settings (LSLInletSettings | None)

shutdown()

Return type:

None

class LSLInletGenerator(*args, **kwargs)

Bases: LSLInletProducer

Deprecated: use LSLInletProducer instead.

__init__(*args, **kwargs)

class LSLInletUnit(*args, settings=None, **kwargs)

Bases: BaseProducerUnit[LSLInletSettings, AxisArray | None, LSLInletProducer]

Represents a node in a graph that creates an LSL inlet and forwards the pulled data to the unit’s output.

Parameters:

• stream_name – The name of the created LSL outlet.

• stream_type – The type of the created LSL outlet.

• settings (Settings | None)

SETTINGS

alias of LSLInletSettings

create_producer()

Create the producer instance from settings.

Return type:

None

shutdown()

Runs when the Unit terminates.

This is called from within the same process this unit will live in. This lifecycle hook can be overridden. It can be run as async functions by simply adding the async keyword when overriding.

This method is where you should clean up resources and perform any necessary shutdown procedures.

Return type:

None