io.github.hapjava.accessories.MicrophoneAccessory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hap Show documentation

Homekit Accessory Protocol for Java

There is a newer version: 2.0.7

package io.github.hapjava.accessories;

import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
import io.github.hapjava.services.Service;
import io.github.hapjava.services.impl.MicrophoneService;
import java.util.Collection;
import java.util.Collections;
import java.util.concurrent.CompletableFuture;

/** Microphone accessory with mute state. */
public interface MicrophoneAccessory extends HomekitAccessory {

  /**
   * Retrieves mute status.
   *
   * @return true if accessory is muted
   */
  CompletableFuture isMuted();

  /**
   * Sets the mute status
   *
   * @param mute true if accessory should be muted
   * @return a future that completes when the change is made
   * @throws Exception when the change cannot be made
   */
  CompletableFuture setMute(boolean mute) throws Exception;

  /**
   * Subscribes to changes in mute state.
   *
   * @param callback the function to call when the state changes.
   */
  void subscribeMuteState(HomekitCharacteristicChangeCallback callback);

  /** Unsubscribes from changes in the mute state. */
  void unsubscribeMuteState();

  @Override
  default Collection getServices() {
    return Collections.singleton(new MicrophoneService(this));
  }
}