bsl.StreamPlayer¶

class bsl.StreamPlayer(stream_name, fif_file, repeat=inf, trigger_def=None, chunk_size=16, high_resolution=False)[source]¶

Class for playing a recorded file on LSL network in another process.

Parameters:

stream_namestr: Stream’s server name, displayed on LSL network.
fif_filefile-like: Path to the compatible raw .fif file to play.
repeatint | float('inf'): Number of times the stream player will loop on the FIF file before interrupting. Default float('inf') can be passed to never interrupt streaming.
trigger_defNone | file-like | TriggerDef: If not None, a TriggerDef instance is used to log events with a descriptive string instead of their ID. If not None, either a TriggerDef instance or the path to a valid .ini file passed to TriggerDef.
chunk_sizeint: Number of samples to send at once (usually 16-32 is good enough).
high_resolutionbool: If True, it uses perf_counter instead of sleep for higher time resolution. However, it uses more CPU.

Attributes

`chunk_size`	Number of samples to send at once (usually `16-32` is good enough).
`fif_file`	Path to the compatible raw `.fif` file to play.
`high_resolution`	If `True`, it uses `perf_counter` instead of `sleep`.
`process`	Launched streaming process.
`repeat`	Number of times the stream player will loop.
`state`	Streaming state of the player.
`stream_name`	Stream's server name, displayed on LSL network.
`trigger_def`	Either `None` or TriggerDef instance.