Interface AccessoryWithMute
-
public interface AccessoryWithMuteAccessory with mute characteristicMuteCharacteristic.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CompletableFuture<Boolean>isMuted()Retrieves mute status.CompletableFuture<Void>setMute(boolean mute)Sets the mute statusvoidsubscribeMuteState(HomekitCharacteristicChangeCallback callback)Subscribes to changes in mute state.voidunsubscribeMuteState()Unsubscribes from changes in the mute state.
-
-
-
Method Detail
-
isMuted
CompletableFuture<Boolean> isMuted()
Retrieves mute status.- Returns:
- true if accessory is muted
-
setMute
CompletableFuture<Void> setMute(boolean mute) throws Exception
Sets the mute status- Parameters:
mute- true if accessory should be muted- Returns:
- a future that completes when the change is made
- Throws:
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.
-
-