public static class LSL.StreamInfo
extends java.lang.Object
Constructor and Description |
---|
LSL.StreamInfo(com.sun.jna.Pointer handle) |
LSL.StreamInfo(java.lang.String name,
java.lang.String type) |
LSL.StreamInfo(java.lang.String name,
java.lang.String type,
int channel_count) |
LSL.StreamInfo(java.lang.String name,
java.lang.String type,
int channel_count,
double nominal_srate) |
LSL.StreamInfo(java.lang.String name,
java.lang.String type,
int channel_count,
double nominal_srate,
int channel_format) |
LSL.StreamInfo(java.lang.String name,
java.lang.String type,
int channel_count,
double nominal_srate,
int channel_format,
java.lang.String source_id)
Construct a new stream_info object.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
as_xml()
Retrieve the entire stream_info in XML format.
|
int |
channel_count()
Number of channels of the stream.
|
int |
channel_format()
Channel format of the stream.
|
double |
created_at()
Creation time stamp of the stream.
|
LSL.XMLElement |
desc()
Extended description of the stream.
|
void |
destroy()
Destroy a previously created StreamInfo object.
|
com.sun.jna.Pointer |
handle()
Get access to the underlying native handle.
|
java.lang.String |
hostname()
Hostname of the providing machine.
|
java.lang.String |
name()
Name of the stream.
|
double |
nominal_srate()
Sampling rate of the stream, according to the source (in Hz).
|
java.lang.String |
session_id()
Session ID for the given stream.
|
java.lang.String |
source_id()
Unique identifier of the stream's source, if available.
|
java.lang.String |
type()
Content type of the stream.
|
java.lang.String |
uid()
Unique ID of the stream outlet instance (once assigned).
|
int |
version()
Protocol version used to deliver the stream.
|
public LSL.StreamInfo(java.lang.String name, java.lang.String type, int channel_count, double nominal_srate, int channel_format, java.lang.String source_id)
name
- Name of the stream. Describes the device (or product series) that this stream makes available
(for use by programs, experimenters or data analysts). Cannot be empty.type
- Content type of the stream. Please see Table of Content Types in the documentation for naming recommendations.
The content type is the preferred way to find streams (as opposed to searching by name).channel_count
- Number of channels per sample. This stays constant for the lifetime of the stream.nominal_srate
- The sampling rate (in Hz) as advertised by the data source, if regular (otherwise set to IRREGULAR_RATE).channel_format
- Format/type of each channel. If your channels have different formats, consider supplying
multiple streams or use the largest type that can hold them all (such as cf_double64).source_id
- Unique identifier of the device or source of the data, if available (such as the serial number).
This is critical for system robustness since it allows recipients to recover from failure even after the
serving app, device or computer crashes (just by finding a stream with the same source id on the network again).
Therefore, it is highly recommended to always try to provide whatever information can uniquely identify the data source itself.public LSL.StreamInfo(java.lang.String name, java.lang.String type, int channel_count, double nominal_srate, int channel_format)
public LSL.StreamInfo(java.lang.String name, java.lang.String type, int channel_count, double nominal_srate)
public LSL.StreamInfo(java.lang.String name, java.lang.String type, int channel_count)
public LSL.StreamInfo(java.lang.String name, java.lang.String type)
public LSL.StreamInfo(com.sun.jna.Pointer handle)
public void destroy()
public java.lang.String name()
public java.lang.String type()
public int channel_count()
public double nominal_srate()
public int channel_format()
public java.lang.String source_id()
public int version()
public double created_at()
public java.lang.String uid()
public java.lang.String session_id()
public java.lang.String hostname()
public LSL.XMLElement desc()
public java.lang.String as_xml()
public com.sun.jna.Pointer handle()