iblrig.video.CameraSession

class iblrig.video.CameraSession[source]

__init__(subject=None, config_name='default', **kwargs)[source]

Parameters:

subject (str, optional) – The subject name.
config_name (str=``’default’``) – The name of the camera configuration key in the hardware settings to use.

status

This status will be returned when messages received during the main loop and determines response to remote events.

Type:: str

communicator

A Communicator object that can be used to communicate with the behaviour rig.

Type:: iblutil.io.net.app.EchoProtocol

finalize_recording()[source]

initialize_recording()[source]

run()[source]

run_setup_workflow()[source]

start_recording()[source]

stop_recording()[source]

property cameras

property one

Return ONE instance.

Unlike super class getter, this method will always instantiate ONE, allowing subclasses to update with an Alyx token from a remotely connected rig. This instance is used for formatting the experiment reference string.

Returns:: An instance of ONE.
Return type:: one.api.One

property status