org.firstinspires.ftc.ftccommon.external

Class SoundPlayingRobotMonitor

java.lang.Object

org.firstinspires.ftc.ftccommon.external.SoundPlayingRobotMonitor

All Implemented Interfaces:

RobotStateMonitor

public class SoundPlayingRobotMonitor
extends java.lang.Object
implements RobotStateMonitor

SoundPlayingRobotMonitor is an implementation of RobotStateMonitor that plays sounds at certain event transitions within the Robot Controller application.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SoundPlayingRobotMonitor.Sound

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	context
static boolean	DEBUG
protected java.lang.String	errorMessage
protected SoundPlayingRobotMonitor.Sound	lastSoundPlayed
protected NetworkStatus	networkStatus
protected PeerStatus	peerStatus
protected RobotState	robotState
protected RobotStatus	robotStatus
protected java.util.concurrent.atomic.AtomicInteger	runningsInFlight
static int	soundConnect
static int	soundDisconnect
static int	soundError
static int	soundRunning
static int	soundWarning
protected java.lang.String	warningMessage

Constructor Summary

Constructors

Constructor and Description
SoundPlayingRobotMonitor()
SoundPlayingRobotMonitor(Context context)

Method Summary

Modifier and Type	Method and Description
protected void	playConnect()
protected void	playDisconnect()
protected void	playError()
protected void	playRunning()
protected void	playSound(SoundPlayingRobotMonitor.Sound sound, int resourceId)
protected void	playSound(SoundPlayingRobotMonitor.Sound sound, int resourceId, Consumer<java.lang.Integer> runWhenStarted, java.lang.Runnable runWhenFinished)
protected void	playWarning()
static void	prefillSoundCache()
void	updateErrorMessage(java.lang.String errorMessage) Informs the monitor that a critical error occurred in the robot, or clears any error previously reported.
void	updateNetworkStatus(NetworkStatus networkStatus, java.lang.String extra) Informs the monitor of the current status of the network connection.
void	updatePeerStatus(PeerStatus peerStatus) Informs the monitor of the current status of relationship to the peer application.
void	updateRobotState(RobotState robotState) Informs the monitor of the current state of the robot.
void	updateRobotStatus(RobotStatus robotStatus) Informs the monitor of the current status of the robot.
void	updateWarningMessage(java.lang.String warningMessage) Informs the monitor that a warning has occurred in the robot, or clears any warning previously reported.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG

public static boolean DEBUG

context

protected Context context

robotState

protected RobotState robotState

robotStatus

protected RobotStatus robotStatus

networkStatus

protected NetworkStatus networkStatus

peerStatus

protected PeerStatus peerStatus

errorMessage

protected java.lang.String errorMessage

warningMessage

protected java.lang.String warningMessage

lastSoundPlayed

protected SoundPlayingRobotMonitor.Sound lastSoundPlayed

runningsInFlight

protected java.util.concurrent.atomic.AtomicInteger runningsInFlight

soundConnect

public static int soundConnect

soundDisconnect

public static int soundDisconnect

soundRunning

public static int soundRunning

soundWarning

public static int soundWarning

soundError

public static int soundError

Constructor Detail

SoundPlayingRobotMonitor

public SoundPlayingRobotMonitor()

SoundPlayingRobotMonitor

public SoundPlayingRobotMonitor(Context context)

Method Detail

prefillSoundCache

public static void prefillSoundCache()

playConnect

protected void playConnect()

playDisconnect

protected void playDisconnect()

playRunning

protected void playRunning()

playWarning

protected void playWarning()

playError

protected void playError()

updateRobotState

public void updateRobotState(RobotState robotState)

Description copied from interface: RobotStateMonitor

Informs the monitor of the current state of the robot. This may or may not be different from the state previously reported.

Specified by:

updateRobotState in interface RobotStateMonitor

Parameters:

robotState - the current state of the robot.

updateRobotStatus

public void updateRobotStatus(RobotStatus robotStatus)

Description copied from interface: RobotStateMonitor

Informs the monitor of the current status of the robot. This may or may not be different from the status previously reported. The robot status provides additional information when the robot is not in the running state.

Specified by:

updateRobotStatus in interface RobotStateMonitor

Parameters:

robotStatus - the current status of the robot

See Also:

RobotStatus

updatePeerStatus

public void updatePeerStatus(PeerStatus peerStatus)

Description copied from interface: RobotStateMonitor

Informs the monitor of the current status of relationship to the peer application. This may or may not be different from the status previously reported.

Specified by:

updatePeerStatus in interface RobotStateMonitor

Parameters:

peerStatus - the relationship of this app to its peer

See Also:

PeerStatus

updateNetworkStatus

public void updateNetworkStatus(NetworkStatus networkStatus,
                                java.lang.String extra)

Description copied from interface: RobotStateMonitor

Informs the monitor of the current status of the network connection. This may or may not be different from the status previously reported.

Specified by:

updateNetworkStatus in interface RobotStateMonitor

Parameters:

networkStatus - the current status of the network connection

extra - additional information useful in some statuses

updateErrorMessage

public void updateErrorMessage(java.lang.String errorMessage)

Description copied from interface: RobotStateMonitor

Informs the monitor that a critical error occurred in the robot, or clears any error previously reported. This may or may not be different from the error message previously reported.

Specified by:

updateErrorMessage in interface RobotStateMonitor

Parameters:

errorMessage - the error message being reported, or null if the error is being cleared.

updateWarningMessage

public void updateWarningMessage(java.lang.String warningMessage)

Description copied from interface: RobotStateMonitor

Informs the monitor that a warning has occurred in the robot, or clears any warning previously reported. This may or may not be different from the warning message previously reported.

Specified by:

updateWarningMessage in interface RobotStateMonitor

Parameters:

warningMessage - the warning message being reported, or null if the warning is being cleared.

playSound

protected void playSound(SoundPlayingRobotMonitor.Sound sound,
                         int resourceId)

playSound

protected void playSound(SoundPlayingRobotMonitor.Sound sound,
                         int resourceId,
                         Consumer<java.lang.Integer> runWhenStarted,
                         java.lang.Runnable runWhenFinished)