Struct obws::client::Filters

pub struct Filters<'a> { /* private fields */ }

API functions related to filters.

Implementations

impl<'a> Filters<'a>

pub async fn list_kinds(&self) -> Result<Vec<String>>

Gets an array of all available source filter kinds.

pub async fn list(&self, source: SourceId<'_>) -> Result<Vec<SourceFilter>>

Gets an array of all of a source’s filters.

pub async fn default_settings<T>(&self, kind: &str) -> Result<T>

where T: DeserializeOwned,

Gets the default settings for a filter kind.

pub async fn create<T>(&self, filter: Create<'_, T>) -> Result<()>

where T: Serialize,

Creates a new filter, adding it to the specified source.

pub async fn remove(&self, source: SourceId<'_>, filter: &str) -> Result<()>

Removes a filter from a source.

pub async fn set_name(&self, name: SetName<'_>) -> Result<()>

Sets the name of a source filter (rename).

pub async fn get( &self, source: SourceId<'_>, filter: &str ) -> Result<SourceFilter>

Gets the info for a specific source filter.

pub async fn set_index(&self, index: SetIndex<'_>) -> Result<()>

Sets the index position of a filter on a source.

pub async fn set_settings<T>(&self, settings: SetSettings<'_, T>) -> Result<()>

where T: Serialize,

Sets the settings of a source filter.

pub async fn set_enabled(&self, enabled: SetEnabled<'_>) -> Result<()>

Sets the enable state of a source filter.