Interface SupportsMusic

Namespace

CTRE.Phoenix6.Hardware.Traits

Assembly

Phoenix6.Hardware.dll

Contains all control functions available for motors that support playing music.

public interface SupportsMusic : CommonDevice

Inherited Members

CommonDevice.DeviceID

CommonDevice.Network

CommonDevice.DeviceHash

CommonDevice.AppliedControl

CommonDevice.HasResetOccurred

CommonDevice.GetResetOccurredChecker()

CommonDevice.OptimizeBusUtilization(double, double)

CommonDevice.ResetSignalFrequencies(double)

Methods

SetControl(ControlRequest)

Control device with generic control request object.

User must make sure the specified object is castable to a valid control request, otherwise this function will fail at run-time and return the NotSupported StatusCode

StatusCode SetControl(ControlRequest request)

Parameters

request ControlRequest

Control object to request of the device

Returns

StatusCode

Status Code of the request, 0 is OK

SetControl(MusicTone)

Plays a single tone at the user specified frequency.

MusicTone Parameters

• AudioFrequencySound frequency to play. A value of zero will silence the device. The effective frequency range is 10-20000 Hz. Any nonzero frequency less than 10 Hz will be capped to 10 Hz. Any frequency above 20 kHz will be capped to 20 kHz.

StatusCode SetControl(MusicTone request)

Parameters

request MusicTone

Control object to request of the device

Returns

StatusCode

Code response of the request