Class AudioConfigs

Namespace

CTRE.Phoenix6.Configs

Assembly

Phoenix6.Hardware.dll

Configs that affect audible components of the device.

Includes configuration for the beep on boot.

public class AudioConfigs : IParentConfiguration, ISerializable, ICloneable

Inheritance

object

AudioConfigs

Implements

IParentConfiguration

ISerializable

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

AllowMusicDurDisable

If true, the TalonFX will allow Orchestra and MusicTone requests during disabled state. This can be used to address corner cases when music features are needed when disabled. This setting defaults to false. Note that if the rotor is moving, music features are always disabled regardless of this setting.

• Default ValueFalse

public bool AllowMusicDurDisable

Field Value

bool

BeepOnBoot

If true, the TalonFX will beep during boot-up. This is useful for general debugging, and defaults to true. If rotor is moving during boot-up, the beep will not occur regardless of this setting.

• Default ValueTrue

public bool BeepOnBoot

Field Value

bool

BeepOnConfig

If true, the TalonFX will beep during configuration API calls if device is disabled. This is useful for general debugging, and defaults to true. Note that if the rotor is moving, the beep will not occur regardless of this setting.

• Default ValueTrue

public bool BeepOnConfig

Field Value

bool

Methods

Clone()

Creates a copy of this config group.

public AudioConfigs Clone()

Returns

AudioConfigs

Deserialize(string)

Deserialize string and put values into this object

public StatusCode Deserialize(string to_deserialize)

Parameters

to_deserialize string

String to deserialize

Returns

StatusCode

OK if deserialization is OK

Serialize()

Serialize this object into a string

public string Serialize()

Returns

string

This object's data serialized into a string

ToString()

Provides the string representation of this object

public override string ToString()

Returns

string

WithAllowMusicDurDisable(bool)

Modifies this configuration's AllowMusicDurDisable parameter and returns itself for method-chaining and easier to use config API.

If true, the TalonFX will allow Orchestra and MusicTone requests during disabled state. This can be used to address corner cases when music features are needed when disabled. This setting defaults to false. Note that if the rotor is moving, music features are always disabled regardless of this setting.

• Default ValueFalse

public AudioConfigs WithAllowMusicDurDisable(bool newAllowMusicDurDisable)

Parameters

newAllowMusicDurDisable bool

Parameter to modify

Returns

AudioConfigs

Itself

WithBeepOnBoot(bool)

Modifies this configuration's BeepOnBoot parameter and returns itself for method-chaining and easier to use config API.

If true, the TalonFX will beep during boot-up. This is useful for general debugging, and defaults to true. If rotor is moving during boot-up, the beep will not occur regardless of this setting.

• Default ValueTrue

public AudioConfigs WithBeepOnBoot(bool newBeepOnBoot)

Parameters

newBeepOnBoot bool

Parameter to modify

Returns

AudioConfigs

Itself

WithBeepOnConfig(bool)

Modifies this configuration's BeepOnConfig parameter and returns itself for method-chaining and easier to use config API.

If true, the TalonFX will beep during configuration API calls if device is disabled. This is useful for general debugging, and defaults to true. Note that if the rotor is moving, the beep will not occur regardless of this setting.

• Default ValueTrue

public AudioConfigs WithBeepOnConfig(bool newBeepOnConfig)

Parameters

newBeepOnConfig bool

Parameter to modify

Returns

AudioConfigs

Itself