Struct Filters

pub struct Filters {
    pub volume: Option<f64>,
    pub equalizer: Option<Vec<Equalizer>>,
    pub karaoke: Option<Karaoke>,
    pub timescale: Option<Timescale>,
    pub tremolo: Option<TremoloVibrato>,
    pub vibrato: Option<TremoloVibrato>,
    pub rotation: Option<Rotation>,
    pub distortion: Option<Distortion>,
    pub channel_mix: Option<ChannelMix>,
    pub low_pass: Option<LowPass>,
    pub plugin_filters: Option<Value>,
}

Fields

volume: Option<f64>

Adjusts the player volume from 0.0 to 5.0, where 1.0 is 100%.

NOTE: Values >1.0 may cause clipping

equalizer: Option<Vec<Equalizer>>

Adjusts 15 different bands.

karaoke: Option<Karaoke>

Eliminates part of a band, usually targeting vocals.

timescale: Option<Timescale>

Changes the speed, pitch, and rate.

tremolo: Option<TremoloVibrato>

Creates a shuddering effect, where the volume quickly oscillates.

vibrato: Option<TremoloVibrato>

Creates a shuddering effect, where the pitch quickly oscillates.

rotation: Option<Rotation>

Rotates the audio around the stereo channels/user headphones (aka Audio Panning).

distortion: Option<Distortion>

Distorts the audio.

channel_mix: Option<ChannelMix>

Mixes both stereo channels (left and right).

low_pass: Option<LowPass>

Filters out higher frequencies.

plugin_filters: Option<Value>

Filter plugin configurations.

Trait Implementations

impl Clone for Filters

fn clone(&self) -> Filters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filters

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

Formats the value using the given formatter.

impl Default for Filters

fn default() -> Filters

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Filters

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoPy<Py<PyAny>> for Filters

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PartialEq for Filters

fn eq(&self, other: &Filters) -> 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 PyClass for Filters

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Filters

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Filters>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<Filters> for PyClassImplCollector<Filters>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a Filters

type Holder = Option<PyRef<'py, Filters>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut Filters

type Holder = Option<PyRefMut<'py, Filters>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyMethods<Filters> for PyClassImplCollector<Filters>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Filters

const NAME: &'static str = "Filters"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

type AsRefTarget = PyCell<Filters>

Utility type to make Py::as_ref work.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

impl Serialize for Filters

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Filters