CTRE Phoenix 6 C++ 24.3.0
ctre::phoenix6::configs::AudioConfigs Class Reference

Configs that affect audible components of the device. More...

#include <ctre/phoenix6/configs/Configs.hpp>

Inheritance diagram for ctre::phoenix6::configs::AudioConfigs:
ctre::phoenix6::configs::ParentConfiguration ctre::phoenix6::ISerializable

Public Member Functions

AudioConfigsWithBeepOnBoot (bool newBeepOnBoot)
 Modifies this configuration's BeepOnBoot parameter and returns itself for method-chaining and easier to use config API. More...
 
AudioConfigsWithBeepOnConfig (bool newBeepOnConfig)
 Modifies this configuration's BeepOnConfig parameter and returns itself for method-chaining and easier to use config API. More...
 
AudioConfigsWithAllowMusicDurDisable (bool newAllowMusicDurDisable)
 Modifies this configuration's AllowMusicDurDisable parameter and returns itself for method-chaining and easier to use config API. More...
 
std::string ToString () const override
 
std::string Serialize () const override
 
ctre::phoenix::StatusCode Deserialize (const std::string &to_deserialize) override
 
virtual std::string ToString () const =0
 
virtual ctre::phoenix::StatusCode Deserialize (const std::string &string)=0
 
virtual std::string Serialize () const =0
 

Public Attributes

bool BeepOnBoot = true
 If true, the TalonFX will beep during boot-up. More...
 
bool BeepOnConfig = true
 If true, the TalonFX will beep during configuration API calls if device is disabled. More...
 
bool AllowMusicDurDisable = false
 If true, the TalonFX will allow Orchestra and MusicTone requests during disabled state. More...
 

Detailed Description

Configs that affect audible components of the device.

Includes configuration for the beep on boot.

Member Function Documentation

◆ Deserialize()

ctre::phoenix::StatusCode ctre::phoenix6::configs::AudioConfigs::Deserialize ( const std::string &  to_deserialize)
inlineoverridevirtual

◆ Serialize()

std::string ctre::phoenix6::configs::AudioConfigs::Serialize ( ) const
inlineoverridevirtual

◆ ToString()

std::string ctre::phoenix6::configs::AudioConfigs::ToString ( ) const
inlineoverridevirtual

◆ WithAllowMusicDurDisable()

AudioConfigs & ctre::phoenix6::configs::AudioConfigs::WithAllowMusicDurDisable ( bool  newAllowMusicDurDisable)
inline

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 Value: False
Parameters
newAllowMusicDurDisableParameter to modify
Returns
Itself

◆ WithBeepOnBoot()

AudioConfigs & ctre::phoenix6::configs::AudioConfigs::WithBeepOnBoot ( bool  newBeepOnBoot)
inline

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 Value: True
Parameters
newBeepOnBootParameter to modify
Returns
Itself

◆ WithBeepOnConfig()

AudioConfigs & ctre::phoenix6::configs::AudioConfigs::WithBeepOnConfig ( bool  newBeepOnConfig)
inline

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 Value: True
Parameters
newBeepOnConfigParameter to modify
Returns
Itself

Member Data Documentation

◆ AllowMusicDurDisable

bool ctre::phoenix6::configs::AudioConfigs::AllowMusicDurDisable = false

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 Value: False

◆ BeepOnBoot

bool ctre::phoenix6::configs::AudioConfigs::BeepOnBoot = true

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 Value: True

◆ BeepOnConfig

bool ctre::phoenix6::configs::AudioConfigs::BeepOnConfig = true

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 Value: True

The documentation for this class was generated from the following file: