Command line🔗

A Player, or the legacy StreamViewer, can be called from the command line. For each command, the flag -h or --help provides additional information.

$ mne-lsl

The command mne-lsl provides the available commands in the command-line interface.

Player🔗

An MNE readable file can be streamed with a PlayerLSL with the command:

$ mne-lsl player fname

With the arguments:

  • fname (positional, mandatory): file-like, file to stream (must be readable with mne.io.read_raw()).

  • -c, --chunk-size (optional, default 16): int, number of samples pushed at once.

  • --n-repeat (optional, default np.inf): int, number of times to repeat the stream.

  • -n, --name (optional, default MNE-LSL-Player): str, name of the LSL stream.

  • --annotations (optional): enable streaming of annotations on a second StreamOutlet.

StreamViewer🔗

A legacy StreamViewer can be opened with the command:

$ mne-lsl viewer

With the arguments:

  • -s, --stream (optional): str, name of the stream to connect to.

Note

If stream_name is not provided, a prompt is displayed to select a stream among the available ones.

The StreamViewer opens 2 windows:

  • A controller to select the channels to plot and set different plotting parameters.

  • A plotting window using the pyqtgraph backend displaying the signal in real-time.