Struct lsl::StreamOutlet

pub struct StreamOutlet { /* fields omitted */ }

A stream outlet. Outlets are used to make streaming data (and the meta-data) available on the lab network.

The actual sample-pushing functionality is provided via the Pushable and ExPushable traits below.

Examples: the send_*.rs examples (found in the crate's github repository) illustrate the use of StreamOutlet.

Implementations

impl StreamOutlet

pub fn new(
    info: &StreamInfo,
    chunk_size: i32,
    max_buffered: i32
) -> Result<StreamOutlet, Error>

Establish a new stream outlet. This makes the stream discoverable.

Arguments:

• info: The stream information to use for creating this stream. Stays constant over the lifetime of the outlet.
• chunk_size: The desired chunk granularity (in samples) for transmission. If specified as 0, each push operation yields one chunk. Inlets can override this setting.
• max_buffered: The maximum amount of data to buffer (in seconds if there is a nominal sampling rate, otherwise x100 in samples). A good default is 360, which corresponds to 6 minutes of data. Note that, for high-bandwidth data you should consider using a lower value here to avoid running out of RAM in case data have to be buffered unexpectedly.

pub fn have_consumers(&self) -> bool

Check whether consumers are currently registered.

You can use this to disable sending data if there's no consumer (e.g. to save battery on an embedded device) -- however, this is not necessary and most production clients do not use it.

pub fn wait_for_consumers(&self, timeout: f64) -> bool

Wait until some consumer shows up (without wasting resources, e.g., on embedded devices).

To have no timeout, you can use the value lsl::FOREVER here. Returns True if the wait was successful, false if the timeout expired.

Note that it is not necessary to do this, and most production clients do not use this feature.

pub fn info(&self) -> Result<StreamInfo, Error>

Retrieve the stream info provided by this outlet.

This is what was used to create the stream (and also has the Additional Network Information fields assigned).

In extremely rare cases this may fail with an Err::ResourceCreation variant (e.g., due to out of memory).

Trait Implementations

impl Debug for StreamOutlet

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for StreamOutlet

fn drop(&mut self)

Executes the destructor for this type.

impl<'_> ExPushable<Vec<&'_ [u8]>> for StreamOutlet

fn push_sample_ex(
    &self,
    data: &Vec<&[u8]>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a vector of values of some type as a sample into the outlet. Each entry in the vector corresponds to one channel. The function handles type checking & conversion.

fn push_chunk_ex(
    &self,
    samples: &Vec<T>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet.

fn push_chunk_stamped_ex(
    &self,
    samples: &Vec<T>,
    timestamps: &Vec<f64>,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet. Allows for specifying a separate time stamp for each sample (for irregular-rate streams).

impl<'_> ExPushable<Vec<&'_ str>> for StreamOutlet

fn push_sample_ex(
    &self,
    data: &Vec<&str>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a vector of values of some type as a sample into the outlet. Each entry in the vector corresponds to one channel. The function handles type checking & conversion.

fn push_chunk_ex(
    &self,
    samples: &Vec<T>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet.

fn push_chunk_stamped_ex(
    &self,
    samples: &Vec<T>,
    timestamps: &Vec<f64>,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet. Allows for specifying a separate time stamp for each sample (for irregular-rate streams).

impl ExPushable<Vec<String>> for StreamOutlet

fn push_sample_ex(
    &self,
    data: &Vec<String>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a vector of values of some type as a sample into the outlet. Each entry in the vector corresponds to one channel. The function handles type checking & conversion.

fn push_chunk_ex(
    &self,
    samples: &Vec<T>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet.

fn push_chunk_stamped_ex(
    &self,
    samples: &Vec<T>,
    timestamps: &Vec<f64>,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet. Allows for specifying a separate time stamp for each sample (for irregular-rate streams).

impl ExPushable<Vec<f32>> for StreamOutlet

fn push_sample_ex(
    &self,
    data: &Vec<f32>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a vector of values of some type as a sample into the outlet. Each entry in the vector corresponds to one channel. The function handles type checking & conversion.

fn push_chunk_ex(
    &self,
    samples: &Vec<T>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet.

fn push_chunk_stamped_ex(
    &self,
    samples: &Vec<T>,
    timestamps: &Vec<f64>,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet. Allows for specifying a separate time stamp for each sample (for irregular-rate streams).

impl ExPushable<Vec<f64>> for StreamOutlet

fn push_sample_ex(
    &self,
    data: &Vec<f64>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a vector of values of some type as a sample into the outlet. Each entry in the vector corresponds to one channel. The function handles type checking & conversion.

fn push_chunk_ex(
    &self,
    samples: &Vec<T>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet.

fn push_chunk_stamped_ex(
    &self,
    samples: &Vec<T>,
    timestamps: &Vec<f64>,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet. Allows for specifying a separate time stamp for each sample (for irregular-rate streams).

impl ExPushable<Vec<i16>> for StreamOutlet

fn push_sample_ex(
    &self,
    data: &Vec<i16>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a vector of values of some type as a sample into the outlet. Each entry in the vector corresponds to one channel. The function handles type checking & conversion.

fn push_chunk_ex(
    &self,
    samples: &Vec<T>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet.

fn push_chunk_stamped_ex(
    &self,
    samples: &Vec<T>,
    timestamps: &Vec<f64>,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet. Allows for specifying a separate time stamp for each sample (for irregular-rate streams).

impl ExPushable<Vec<i32>> for StreamOutlet

fn push_sample_ex(
    &self,
    data: &Vec<i32>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a vector of values of some type as a sample into the outlet. Each entry in the vector corresponds to one channel. The function handles type checking & conversion.

fn push_chunk_ex(
    &self,
    samples: &Vec<T>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet.

fn push_chunk_stamped_ex(
    &self,
    samples: &Vec<T>,
    timestamps: &Vec<f64>,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet. Allows for specifying a separate time stamp for each sample (for irregular-rate streams).

impl ExPushable<Vec<i64>> for StreamOutlet

fn push_sample_ex(
    &self,
    data: &Vec<i64>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a vector of values of some type as a sample into the outlet. Each entry in the vector corresponds to one channel. The function handles type checking & conversion.

fn push_chunk_ex(
    &self,
    samples: &Vec<T>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet.

fn push_chunk_stamped_ex(
    &self,
    samples: &Vec<T>,
    timestamps: &Vec<f64>,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet. Allows for specifying a separate time stamp for each sample (for irregular-rate streams).

impl ExPushable<Vec<i8>> for StreamOutlet

fn push_sample_ex(
    &self,
    data: &Vec<i8>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a vector of values of some type as a sample into the outlet. Each entry in the vector corresponds to one channel. The function handles type checking & conversion.

fn push_chunk_ex(
    &self,
    samples: &Vec<T>,
    timestamp: f64,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet.

fn push_chunk_stamped_ex(
    &self,
    samples: &Vec<T>,
    timestamps: &Vec<f64>,
    pushthrough: bool
) -> Result<(), Error>

Push a chunk of samples (batched into a Vec) into the outlet. Allows for specifying a separate time stamp for each sample (for irregular-rate streams).