Struct OutputFlags 

pub struct OutputFlags(/* private fields */);

Available on crate feature events only.

These flags determine what type of data the source outputs and expects.

Implementations

impl OutputFlags

pub const VIDEO: Self

Source has video.

Unless SOURCE_ASYNC_VIDEO is specified, the source must include the video_render callback in the source definition structure.

pub const AUDIO: Self

Source has audio.

Use the obs_source_output_audio function to pass raw audio data, which will be automatically converted and uploaded. If used with SOURCE_ASYNC_VIDEO, audio will automatically be synced up to the video output.

pub const ASYNC: Self

Async video flag (use Self::ASYNC_VIDEO).

pub const ASYNC_VIDEO: Self

Source passes raw video data via RAM.

Use the obs_source_output_video function to pass raw video data, which will be automatically uploaded at the specified timestamp.

If this flag is specified, it is not necessary to include the video_render callback. However, if you wish to use that function as well, you must call obs_source_getframe to get the current frame data, and obs_source_releaseframe to release the data when complete.

pub const CUSTOM_DRAW: Self

Source uses custom drawing, rather than a default effect.

If this flag is specified, the video_render callback will pass a NULL effect, and effect-based filters will not use direct rendering.

pub const INTERACTION: Self

Source supports interaction.

When this is used, the source will receive interaction events if they provide the necessary callbacks in the source definition structure.

pub const COMPOSITE: Self

Source composites sub-sources

When used specifies that the source composites one or more sub-sources. Sources that render sub-sources must implement the audio_render callback in order to perform custom mixing of sub-sources.

This capability flag is always set for transitions.

pub const DO_NOT_DUPLICATE: Self

Source should not be fully duplicated

When this is used, specifies that the source should not be fully duplicated, and should prefer to duplicate via holding references rather than full duplication.

pub const DEPRECATED: Self

Source is deprecated and should not be used.

pub const DO_NOT_SELF_MONITOR: Self

Source cannot have its audio monitored

Specifies that this source may cause a feedback loop if audio is monitored with a device selected as desktop audio.

This is used primarily with desktop audio capture sources.

pub const CAP_DISABLED: Self

Source type is currently disabled and should not be shown to the user.

pub const CAP_OBSOLETE: Self

Source type is obsolete (has been updated with new defaults/properties/etc).

pub const MONITOR_BY_DEFAULT: Self

Source should enable monitoring by default. Monitoring should be set by the frontend if this flag is set.

pub const SUBMIX: Self

Used internally for audio submixing.

pub const CONTROLLABLE_MEDIA: Self

Source type can be controlled by media controls.

pub const CEA_708: Self

Source type provides cea708 data.

pub const SRGB: Self

Source understands SRGB rendering.

pub const CAP_DONT_SHOW_PROPERTIES: Self

Source type prefers not to have its properties shown on creation (prefers to rely on defaults first).

pub const REQUIRES_CANVAS: Self

Source requires a canvas to operate.

impl OutputFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl OutputFlags

pub const fn iter(&self) -> Iter<OutputFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<OutputFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for OutputFlags

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

Formats the value using the given formatter.

impl BitAnd for OutputFlags

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

The bitwise and (&) of the bits in two flags values.

type Output = OutputFlags

The resulting type after applying the & operator.

impl BitAndAssign for OutputFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for OutputFlags

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

The bitwise or (|) of the bits in two flags values.

type Output = OutputFlags

The resulting type after applying the | operator.

impl BitOrAssign for OutputFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for OutputFlags

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = OutputFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for OutputFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for OutputFlags

fn clone(&self) -> OutputFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputFlags

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

Formats the value using the given formatter.

impl Default for OutputFlags

fn default() -> OutputFlags

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OutputFlags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<OutputFlags> for OutputFlags

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

The bitwise or (|) of the bits in each flags value.

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 Flags for OutputFlags

const FLAGS: &'static [Flag<OutputFlags>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> OutputFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl From<OutputFlags> for u32

fn from(value: OutputFlags) -> Self

Converts to this type from the input type.

impl From<u32> for OutputFlags

fn from(value: u32) -> Self

Converts to this type from the input type.

impl FromIterator<OutputFlags> for OutputFlags

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

The bitwise or (|) of the bits in each flags value.

impl Hash for OutputFlags

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for OutputFlags

type Item = OutputFlags

The type of the elements being iterated over.

type IntoIter = Iter<OutputFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for OutputFlags

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

Formats the value using the given formatter.

impl Not for OutputFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = OutputFlags

The resulting type after applying the ! operator.

impl Octal for OutputFlags

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

Formats the value using the given formatter.

impl Ord for OutputFlags

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for OutputFlags

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for OutputFlags

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for OutputFlags

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for OutputFlags

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = OutputFlags

The resulting type after applying the - operator.

impl SubAssign for OutputFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for OutputFlags

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

Formats the value using the given formatter.

impl Copy for OutputFlags

impl Eq for OutputFlags

impl StructuralPartialEq for OutputFlags