Enum SpeakerMapType

#[repr(C)]
pub enum SpeakerMapType {
    Default = 0,
    AllMono = 1,
    AllStereo = 2,
    _51ProTools = 3,
}

When creating a multichannel sound, FMOD will pan them to their default speaker locations:

• For example a 6 channel sound will default to one channel per 5.1 output speaker.
• Another example is a stereo sound. It will default to left = front left, right = front right.
• This is for sounds that are not ‘default’. For example you might have a sound that is 6 channels but actually made up of 3 stereo pairs, that should all be located in front left, front right only.

Variants

Default = 0

This is the default, and just means FMOD decides which speakers it puts the source channels.

AllMono = 1

This means the sound is made up of all mono sounds. All voices will be panned to the front center by default in this case.

AllStereo = 2

This means the sound is made up of all stereo sounds. All voices will be panned to front left and front right alternating every second channel.

_51ProTools = 3

Map a 5.1 sound to use protools L C R Ls Rs LFE mapping. Will return an error if not a 6 channel sound.

Trait Implementations

impl Clone for SpeakerMapType

fn clone(&self) -> SpeakerMapType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpeakerMapType

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

Formats the value using the given formatter.

impl PartialEq for SpeakerMapType

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

fn partial_cmp(&self, other: &SpeakerMapType) -> 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 Copy for SpeakerMapType

impl StructuralPartialEq for SpeakerMapType