Interface AccessoryWithMute
-
public interface AccessoryWithMute
Accessory with mute characteristicMuteCharacteristic
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.concurrent.CompletableFuture<java.lang.Boolean>
isMuted()
Retrieves mute status.java.util.concurrent.CompletableFuture<java.lang.Void>
setMute(boolean mute)
Sets the mute statusvoid
subscribeMuteState(HomekitCharacteristicChangeCallback callback)
Subscribes to changes in mute state.void
unsubscribeMuteState()
Unsubscribes from changes in the mute state.
-
-
-
Method Detail
-
isMuted
java.util.concurrent.CompletableFuture<java.lang.Boolean> isMuted()
Retrieves mute status.- Returns:
- true if accessory is muted
-
setMute
java.util.concurrent.CompletableFuture<java.lang.Void> setMute(boolean mute) throws java.lang.Exception
Sets the mute status- Parameters:
mute
- true if accessory should be muted- Returns:
- a future that completes when the change is made
- Throws:
java.lang.Exception
- when the change cannot be made
-
subscribeMuteState
void subscribeMuteState(HomekitCharacteristicChangeCallback callback)
Subscribes to changes in mute state.- Parameters:
callback
- the function to call when the state changes.
-
unsubscribeMuteState
void unsubscribeMuteState()
Unsubscribes from changes in the mute state.
-
-