Struct libpulse_binding::stream::FlagSet

#[repr(transparent)]
pub struct FlagSet { /* private fields */ }

Flag set.

Implementations

impl FlagSet

pub const NOFLAGS: Self

Flag to pass when no specific options are needed.

pub const START_CORKED: Self

Create the stream corked, requiring an explicit Stream::uncork() call to uncork it.

pub const INTERPOLATE_TIMING: Self

Interpolate the latency for this stream. When enabled, Stream::get_latency() and Stream::get_time() will try to estimate the current record/playback time based on the local time that passed since the last timing info update. Using this option has the advantage of not requiring a whole round trip when the current playback/recording time is needed. Consider using this option when requesting latency information frequently. This is especially useful on long latency network connections. It makes a lot of sense to combine this option with AUTO_TIMING_UPDATE.

pub const NOT_MONOTONIC: Self

Don’t force the time to increase monotonically. If this option is enabled, Stream::get_time() will not necessarily return always monotonically increasing time values on each call. This may confuse applications which cannot deal with time going ‘backwards’, but has the advantage that bad transport latency estimations that caused the time to jump ahead can be corrected quickly, without the need to wait.

pub const AUTO_TIMING_UPDATE: Self

If set timing update requests are issued periodically automatically. Combined with INTERPOLATE_TIMING you will be able to query the current time and latency with Stream::get_time() and Stream::get_latency() at all times without a packet round trip.

pub const NO_REMAP_CHANNELS: Self

Don’t remap channels by their name, instead map them simply by their index. Implies NO_REMIX_CHANNELS.

pub const NO_REMIX_CHANNELS: Self

When remapping channels by name, don’t upmix or downmix them to related channels. Copy them into matching channels of the device 1:1.

pub const FIX_FORMAT: Self

Use the sample format of the sink/device this stream is being connected to, and possibly ignore the format the sample spec contains – but you still have to pass a valid value in it as a hint to PulseAudio what would suit your stream best. If this is used you should query the used sample format after creating the stream by using Stream::get_sample_spec(). Also, if you specified manual buffer metrics it is recommended to update them with Stream::set_buffer_attr() to compensate for the changed frame sizes.

When creating streams with Stream::new_extended(), this flag has no effect. If you specify a format with PCM encoding, and you want the server to choose the sample format, then you should leave the sample format unspecified in the Info object. This also means that you can’t use Info::new_from_sample_spec(), because that function always sets the sample format.

pub const FIX_RATE: Self

Use the sample rate of the sink, and possibly ignore the rate the sample spec contains. Usage similar to FIX_FORMAT.

When creating streams with Stream::new_extended(), this flag has no effect. If you specify a format with PCM encoding, and you want the server to choose the sample rate, then you should leave the rate unspecified in the Info object. This also means that you can’t use Info::new_from_sample_spec(), because that function always sets the sample rate.

pub const FIX_CHANNELS: Self

Use the number of channels and the channel map of the sink, and possibly ignore the number of channels and the map the sample spec and the passed channel map contains. Usage similar to FIX_FORMAT.

When creating streams with Stream::new_extended(), this flag has no effect. If you specify a format with PCM encoding, and you want the server to choose the channel count and/or channel map, then you should leave the channels and/or the channel map unspecified in the Info object. This also means that you can’t use Info::new_from_sample_spec(), because that function always sets the channel count (but if you only want to leave the channel map unspecified, then Info::new_from_sample_spec() works, because the channel map parameter is optional).

pub const DONT_MOVE: Self

Don’t allow moving of this stream to another sink/device. Useful if you use any of the Fix* flags and want to make sure that resampling never takes place – which might happen if the stream is moved to another sink/source with a different sample spec/channel map.

pub const VARIABLE_RATE: Self

Allow dynamic changing of the sampling rate during playback with Stream::update_sample_rate().

pub const PEAK_DETECT: Self

Find peaks instead of resampling.

pub const START_MUTED: Self

Create in muted state. If neither START_UNMUTED nor this is specified, it is left to the server to decide whether to create the stream in muted or in un-muted state.

pub const ADJUST_LATENCY: Self

Try to adjust the latency of the sink/source based on the requested buffer metrics and adjust buffer metrics accordingly. Also see BufferAttr. This option may not be specified at the same time as EARLY_REQUESTS.

pub const EARLY_REQUESTS: Self

Enable compatibility mode for legacy clients that rely on a “classic” hardware device fragment-style playback model. If this option is set, the minreq value of the buffer metrics gets a new meaning: instead of just specifying that no requests asking for less new data than this value will be made to the client it will also guarantee that requests are generated as early as this limit is reached. This flag should only be set in very few situations where compatibility with a fragment-based playback model needs to be kept and the client applications cannot deal with data requests that are delayed to the latest moment possible. (Usually these are programs that use usleep() or a similar call in their playback loops instead of sleeping on the device itself.) Also see BufferAttr. This option may not be specified at the same time as ADJUST_LATENCY.

pub const DONT_INHIBIT_AUTO_SUSPEND: Self

If set this stream won’t be taken into account when it is checked whether the device this stream is connected to should auto-suspend.

pub const START_UNMUTED: Self

Create in unmuted state. If neither START_MUTED nor this is specified, it is left to the server to decide whether to create the stream in muted or in unmuted state.

pub const FAIL_ON_SUSPEND: Self

If the sink/source this stream is connected to is suspended during the creation of this stream, cause it to fail. If the sink/source is being suspended during creation of this stream, make sure this stream is terminated.

pub const RELATIVE_VOLUME: Self

If a volume is passed when this stream is created, consider it relative to the sink’s current volume, never as absolute device volume. If this is not specified the volume will be consider absolute when the sink is in flat volume mode, relative otherwise.

pub const PASSTHROUGH: Self

Used to tag content that will be rendered by passthrough sinks. The data will be left as is and not reformatted, resampled.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for FlagSet

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

Formats the value using the given formatter.

impl BitAnd<FlagSet> for FlagSet

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

type Output = Self

The resulting type after applying the & operator.

impl BitAndAssign<FlagSet> for FlagSet

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<FlagSet> for FlagSet

fn bitor(self, other: FlagSet) -> Self

Returns the union of the two sets of flags.

type Output = Self

The resulting type after applying the | operator.

impl BitOrAssign<FlagSet> for FlagSet

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<FlagSet> for FlagSet

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

type Output = Self

The resulting type after applying the ^ operator.

impl BitXorAssign<FlagSet> for FlagSet

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for FlagSet

fn clone(&self) -> FlagSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlagSet

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

Formats the value using the given formatter.

impl Default for FlagSet

fn default() -> Self

Returns the “default value” for a type.

impl Extend<FlagSet> for FlagSet

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<FlagSet> for FlagSet

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for FlagSet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for FlagSet

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

Formats the value using the given formatter.

impl Not for FlagSet

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = Self

The resulting type after applying the ! operator.

impl Octal for FlagSet

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

Formats the value using the given formatter.

impl Ord for FlagSet

fn cmp(&self, other: &FlagSet) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<FlagSet> for FlagSet

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

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

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

This method tests for !=.

impl PartialOrd<FlagSet> for FlagSet

fn partial_cmp(&self, other: &FlagSet) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<FlagSet> for FlagSet

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

type Output = Self

The resulting type after applying the - operator.

impl SubAssign<FlagSet> for FlagSet

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for FlagSet

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

Formats the value using the given formatter.

impl Copy for FlagSet

impl Eq for FlagSet

impl StructuralEq for FlagSet

impl StructuralPartialEq for FlagSet