Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dcnieho authored Dec 16, 2024
1 parent b82e772 commit 93ce4fe
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions LSL_streamer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,13 @@ The following method calls are available on a `TittaLSL.Sender` instance:
|Call|Inputs|Outputs|Description|
| --- | --- | --- | --- |
|`getEyeTracker()`||<ol><li>`eyeTracker`: information about the eyeTracker that TittaLSL is connected to.</li></ol>|Get information about the eye tracker that the TittaLSL instance is connected to and will stream data from.|
|`start()`|<ol><li>`stream`: a string, possible values: `gaze`, `externalSignal`, `timeSync` and `positioning`.</li></ol>|<ol><li>`success`: a boolean indicating whether sending of the stream was started. May be false if sending was already started.</li></ol>|Start providing data of a specified type on the network.|
|`create()`|<ol><li>`stream`: a string, possible values: `gaze`, `externalSignal`, `timeSync` and `positioning`.</li><li>`doStartSending`: a boolean (optional), indicating whether sending of data for this stream should be started upon its creation. Default true.</li></ol>|<ol><li>`success`: a boolean indicating whether the stream was created. May be false if the stream was already created.</li></ol>|Create a stream providing data of a specified type on the network.|
|`hasStream()`|<ol><li>`stream`: a string, possible values: `gaze`, `externalSignal`, `timeSync` and `positioning`.</li></ol>|<ol><li>`hasStream`: a boolean indicating whether the indicated stream type is being made available on the network.</li></ol>|Check whether the specified stream type from the connected eye tracker is being made available on the network.|
|`start()`|<ol><li>`stream`: a string, possible values: `gaze`, `externalSignal`, `timeSync` and `positioning`.</li></ol>||Start sending data of a specified type on the network. Can be used for resuming a paused stream.|
|`setIncludeEyeOpennessInGaze()`|<ol><li>`include`: a boolean, indicating whether eye openness samples should be provided in the sent gaze stream or not. Default false.</li></ol>||Set whether calls to start or stop providing the gaze stream will include data from the eye openness stream. An error will be raised if set to true, but the connected eye tracker does not provide an eye openness stream.|
|`isStreaming()`|<ol><li>`stream`: a string, possible values: `gaze`, `externalSignal`, `timeSync` and `positioning`.</li></ol>|<ol><li>`streaming`: a boolean indicating whether the indicated stream type is being made available on the network.</li></ol>|Check whether the specified stream type from the connected eye tracker is being made available on the network.|
|`stop()`|<ol><li>`stream`: a string, possible values: `gaze`, `externalSignal`, `timeSync` and `positioning`.</li></ol>||Stop providing data of a specified type on the network.|
|`isStreaming()`|<ol><li>`stream`: a string, possible values: `gaze`, `externalSignal`, `timeSync` and `positioning`.</li></ol>|<ol><li>`streaming`: a boolean indicating whether data is being streamed for the indicated stream type. False if data sending is paused for the stream.</li></ol>|Check whether data is being streamed from the connected eye tracker for the specified stream type.|
|`stop()`|<ol><li>`stream`: a string, possible values: `gaze`, `externalSignal`, `timeSync` and `positioning`.</li></ol>||Stop streaming data of a specified type on the network. Can be used for resuming a paused stream.|
|`destroy()`|<ol><li>`stream`: a string, possible values: `gaze`, `externalSignal`, `timeSync` and `positioning`.</li></ol>||Stop providing data of a specified type on the network and destroy the stream.|


The following static calls are available for `TittaLSL.Receiver`:
Expand Down

0 comments on commit 93ce4fe

Please sign in to comment.