Interface AccessoryWithClosedCaptions
-
public interface AccessoryWithClosedCaptionsAccessory with closed captions characteristicClosedCaptionsCharacteristic.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.concurrent.CompletableFuture<ClosedCaptionsEnum>getClosedCaptions()Retrieves the closed captions state (seeClosedCaptionsEnumfor supported values).java.util.concurrent.CompletableFuture<java.lang.Void>setClosedCaptions(ClosedCaptionsEnum closedCaptions)Set the closed captions state (seeClosedCaptionsEnumfor supported values).voidsubscribeClosedCaptions(HomekitCharacteristicChangeCallback callback)Subscribes to changes in the closed captions.voidunsubscribeClosedCaptions()Unsubscribes from changes in the closed captions.
-
-
-
Method Detail
-
getClosedCaptions
java.util.concurrent.CompletableFuture<ClosedCaptionsEnum> getClosedCaptions()
Retrieves the closed captions state (seeClosedCaptionsEnumfor supported values).- Returns:
- a future that will contain the closed captions
-
setClosedCaptions
java.util.concurrent.CompletableFuture<java.lang.Void> setClosedCaptions(ClosedCaptionsEnum closedCaptions)
Set the closed captions state (seeClosedCaptionsEnumfor supported values).- Parameters:
closedCaptions- closed captions- Returns:
- a future that completes when the change is made
-
subscribeClosedCaptions
void subscribeClosedCaptions(HomekitCharacteristicChangeCallback callback)
Subscribes to changes in the closed captions.- Parameters:
callback- the function to call when the closed captions changes.
-
unsubscribeClosedCaptions
void unsubscribeClosedCaptions()
Unsubscribes from changes in the closed captions.
-
-