Struct rtaudio::StreamOptions

pub struct StreamOptions {
    pub flags: StreamFlags,
    pub num_buffers: u32,
    pub priority: i32,
    pub name: String,
}

Additional options for opening a stream.

Fields

flags: StreamFlags

The bit flag parameters for this stream.

By default, no flags are set.

num_buffers: u32

Used to control stream latency in the Windows DirectSound, Linux OSS, and Linux Alsa APIs only. A value of two is usually the smallest allowed. Larger numbers can potentially result in more robust stream performance, though likely at the cost of stream latency.

The actual value used when the stream is ran may be different.

The default value is 4.

priority: i32

Scheduling priority of callback thread (only used with flag StreamFlags::SCHEDULE_REALTIME).

Use a value of -1 for the default priority.

The default value is -1.

name: String

The name of the stream (currently used only in Jack).

The size of the name cannot exceed 511 bytes.

Implementations

impl StreamOptions

pub fn to_raw(&self) -> Result<rtaudio_stream_options_t, RtAudioError>

Trait Implementations

impl Clone for StreamOptions

fn clone(&self) -> StreamOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamOptions

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

Formats the value using the given formatter.

impl Default for StreamOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for StreamOptions

fn eq(&self, other: &StreamOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StreamOptions