Skip to content

Commit 506509d

Browse files
committed
Fixed remaining references to old documentation.
1 parent 41d0731 commit 506509d

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

LSL.cs

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ public class StreamInfo
115115
* Core stream information is specified here. Any remaining meta-data can be added later.
116116
* @param name Name of the stream. Describes the device (or product series) that this stream makes available
117117
* (for use by programs, experimenters or data analysts). Cannot be empty.
118-
* @param type Content type of the stream. Please see Table of Content Types in the documentation for naming recommendations.
118+
* @param type Content type of the stream. Please see https://github.com/sccn/xdf/wiki/Meta-Data (or web search for:
119+
* XDF meta-data) for pre-defined content-type names, but you can also make up your own.
119120
* The content type is the preferred way to find streams (as opposed to searching by name).
120121
* @param channel_count Number of channels per sample. This stays constant for the lifetime of the stream.
121122
* @param nominal_srate The sampling rate (in Hz) as advertised by the data source, if regular (otherwise set to IRREGULAR_RATE).
@@ -155,7 +156,7 @@ public class StreamInfo
155156
* The content type is a short string such as "EEG", "Gaze" which describes the content carried by the channel (if known).
156157
* If a stream contains mixed content this value need not be assigned but may instead be stored in the description of channel types.
157158
* To be useful to applications and automated processing systems using the recommended content types is preferred.
158-
* See Table of Content Types in the documentation.
159+
* Content types usually follow those pre-defined in https://github.com/sccn/xdf/wiki/Meta-Data (or web search for: XDF meta-data).
159160
*/
160161
public string type() { return Marshal.PtrToStringAnsi(dll.lsl_get_type(obj)); }
161162

@@ -220,7 +221,7 @@ public class StreamInfo
220221
* The session id is an optional human-assigned identifier of the recording session.
221222
* While it is rarely used, it can be used to prevent concurrent recording activitites
222223
* on the same sub-network (e.g., in multiple experiment areas) from seeing each other's streams
223-
* (assigned via a configuration file by the experimenter, see Configuration File in the docs).
224+
* (assigned via a configuration file by the experimenter, see Network Connectivity in the LSL wiki).
224225
*/
225226
public string session_id() { return Marshal.PtrToStringAnsi(dll.lsl_get_session_id(obj)); }
226227

@@ -237,9 +238,10 @@ public class StreamInfo
237238
/**
238239
* Extended description of the stream.
239240
* It is highly recommended that at least the channel labels are described here.
240-
* See code examples in the documentation. Other information, such as amplifier settings,
241+
* See code examples on the LSL wiki. Other information, such as amplifier settings,
241242
* measurement units if deviating from defaults, setup information, subject information, etc.,
242-
* can be specified here, as well. See Meta-Data Recommendations in the docs.
243+
* can be specified here, as well. Meta-data recommendations follow the XDF file format project
244+
* (github.com/sccn/xdf/wiki/Meta-Data or web search for: XDF meta-data).
243245
*
244246
* Important: if you use a stream content type for which meta-data recommendations exist, please
245247
* try to lay out your meta-data in agreement with these recommendations for compatibility with other applications.
@@ -421,7 +423,7 @@ public class StreamOutlet
421423
* The network is usually the subnet specified at the local router, but may also include
422424
* a multicast group of machines (given that the network supports it), or list of hostnames.
423425
* These details may optionally be customized by the experimenter in a configuration file
424-
* (see Configuration File in the documentation).
426+
* (see Network Connectivity in the LSL wiki).
425427
* This is the default mechanism used by the browsing programs and the recording program.
426428
* @param wait_time The waiting time for the operation, in seconds, to search for streams.
427429
* Warning: If this is too short (less than 0.5s) only a subset (or none) of the
@@ -1202,4 +1204,4 @@ class dll
12021204
public static extern void lsl_destroy_continuous_resolver(IntPtr obj);
12031205
}
12041206
}
1205-
}
1207+
}

0 commit comments

Comments
 (0)