[−][src]Function lsl_sys::lsl_create_streaminfo
pub unsafe extern "C" fn lsl_create_streaminfo(
name: *const c_char,
type_: *const c_char,
channel_count: i32,
nominal_srate: f64,
channel_format: lsl_channel_format_t,
source_id: *const c_char
) -> lsl_streaminfo
Construct a new streaminfo object.
Core stream information is specified here. Any remaining meta-data can be added later.
@param 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.
@param type Content type of the stream. Please see https://github.com/sccn/xdf/wiki/Meta-Data (or
web search for: XDF meta-data) for pre-defined content-type names, but you can also make up your
own. The content type is the preferred way to find streams (as opposed to searching by name).
@param channel_count Number of channels per sample.
This stays constant for the lifetime of the stream.
@param nominal_srate The sampling rate (in Hz) as advertised by the
datasource, if regular (otherwise set to #LSL_IRREGULAR_RATE).
@param 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 #cft_double64).
A good default is #cft_float32. @param source_id Unique identifier of the source or device, if available (e.g. a serial number). Allows recipients to recover from failure even after the serving app or device crashes. May in some cases also be constructed from device settings. @return A newly created streaminfo handle or NULL in the event that an error occurred.