AKToggleable

public protocol AKToggleable

Protocol for dictating that a node can be in a started or stopped state

  • Tells whether the node is processing (ie. started, playing, or active)

    Declaration

    Swift

    var isStarted: Bool
  • Function to start, play, or activate the node, all do the same thing

    Declaration

    Swift

    func start()
  • Function to stop or bypass the node, both are equivalent

    Declaration

    Swift

    func stop()
  • isPlaying Extension method

    Synonym for isStarted that may make more sense with musical instruments

    Declaration

    Swift

    public var isPlaying: Bool
  • isStopped Extension method

    Antonym for isStarted

    Declaration

    Swift

    public var isStopped: Bool
  • isBypassed Extension method

    Antonym for isStarted that may make more sense with effects

    Declaration

    Swift

    public var isBypassed: Bool
  • play() Extension method

    Synonym to start that may more more sense with musical instruments

    Declaration

    Swift

    public func play()
  • bypass() Extension method

    Synonym for stop that may make more sense with effects

    Declaration

    Swift

    public func bypass()