Beeper

@objc(GSBeeper)
public protocol Beeper : Peripheral

Beeper peripheral interface.

This peripheral allows playing an alert sound.

This peripheral can be retrieved by:

device.getPeripheral(Peripherals.beeper)
  • Whether the device is currently playing an alert sound.

    true if the device is currently playing an alert sound, false otherwise.

    Declaration

    Swift

    var alertSoundPlaying: Bool { get }
  • Commands the device to play an alert sound.

    The alert sound shall be stopped with stopAlertSound.

    Declaration

    Swift

    func startAlertSound() -> Bool

    Return Value

    true if the start alert sound operation could be initiated, false otherwise

  • Commands the device to stop playing the alert sound.

    Declaration

    Swift

    func stopAlertSound() -> Bool

    Return Value

    true if the stop alert sound operation could be initiated, false otherwise