< AMControllable > Protocol Reference

Provides a protocol for retrieving controls from controllable objects. More...

#import <AMControllable.h>

Inheritance diagram for < AMControllable >:

AMChunk AMCue AMCueInstance AMSection AMSound AMSoundInstance

List of all members.

Public Member Functions

(NSSet *) - getControls
 Gets the name of the controls supported.
(AMControl *) - getControlWithName:
 Gets the control with the specified name.
(AMControl *) - createControlWithName:
 Gets the control with the specified name or creates it if it doesn't exist.


Detailed Description

Provides a protocol for retrieving controls from controllable objects.

Member Function Documentation

- (AMControl *) createControlWithName: (NSString *)  _name  

Gets the control with the specified name or creates it if it doesn't exist.

Parameters:
name The name of the control to get or create. Should be one of the constant control names defined in the AMControl class.
Returns:
The desired control, or nil if it is not supported by the audio object.

- (NSSet *) getControls  

Gets the name of the controls supported.

Returns:
An NSSet object containing the names of the controls as NSString objects.

- (AMControl *) getControlWithName: (NSString *)  _name  

Gets the control with the specified name.

Parameters:
name The name of the control to get. Should be one of the constant control names defined in the AMControl class.
Returns:
The desired control, or nil if it does not exist.


The documentation for this protocol was generated from the following file:

Generated on Mon May 16 16:29:48 2011 for ARIA by  doxygen 1.5.9