Trigger. More...
#import <ABTrigger.h>
Inherits NSObject.
Inherited by ABButtonTrigger.
Class Methods | |
| (ABTrigger *) | + triggerWithSystemType:block: |
| Create a trigger with a system type. | |
| (ABTrigger *) | + triggerWithTitle:icon:block: |
| Create a custom trigger. | |
Properties | |
| ABTriggerState | state |
| Trigger state. | |
| ABTriggerPerformBlock | block |
| Block to be performed on trigger activation/update. | |
| uint32_t | numericIdentifier |
| A numeric (or fourcc) identifier for the trigger, such as 'trig'. | |
Detailed Description
Trigger.
This class defines actions that can be performed on your app by other Audiobus apps. Triggers you define and add to the Audiobus controller via addTrigger: will be displayed within the Audiobus Connection Panel for other apps.
You can use a system trigger type, or define your own custom triggers.
Method Documentation
| + (ABTrigger*) triggerWithSystemType: | (ABTriggerSystemType) | type | |
| block: | (ABTriggerPerformBlock) | block | |
Create a trigger with a system type.
You should use this method as much as possible. Only use ABButtonTrigger if it is absolutely necessary that you create a custom trigger type.
System triggers are automatically ordered in the connection panel as follows: ABTriggerTypeRewind, ABTriggerTypePlayToggle, ABTriggerTypeRecordToggle.
- Parameters
-
type One of the system type identifiers block Block to be called when trigger is activated
| + (ABTrigger*) triggerWithTitle: | (NSString *) | title | |
| icon: | (UIImage *) | icon | |
Create a custom trigger.
- Deprecated:
- Deprecated in Version 2.0 - Use +[ABButtonTrigger buttonTriggerWithTitle:icon:block:] instead.
- Parameters
-
title A user-readable title (used for accessibility) icon A icon of maximum dimensions 80x80, to use to draw the trigger button. This icon will be used as a mask to render the inset button effect. Icon size should be divisible by 2. block Block to be called when trigger is activated
Property Documentation
|
readwritenonatomicassign |
Trigger state.
Updates to this property will affect the corresponding UI in connected applications.
|
readwritenonatomiccopy |
Block to be performed on trigger activation/update.
|
readwritenonatomicassign |
A numeric (or fourcc) identifier for the trigger, such as 'trig'.
This must be a unique value. If unset, a unique value will be chosen automatically, but this value is not guaranteed to remain the same across multiple sessions.
The documentation for this class was generated from the following file: