< AMInstanciable > Protocol Reference
Provides a protocol for instanciable audio objects. More...
#import <AMInstanciable.h>
Public Member Functions | |
| (id) | - createInstance |
| Creates a new instance of the object if possible and return it. | |
| (id) | - createInstanceWithParentUid: |
| Creates a new instance of the object with the given parent UID if possible and return it. | |
| (void) | - destroyInstance: |
| Destroy the given instance of the object. | |
| (void) | - destroyInstanceFromParentUid: |
| Destroy the instance of the playable source with the given parent UID. | |
| (id) | - startFromParentUid:listener: |
| Starts the playable source with the given parent UID. | |
| (id) | - stopFromParentUid: |
| Stops the instance of the playable source with the given parent UID. | |
| (BOOL) | - isPlayingFromParentUid: |
| Gets the current playing status of the instance of the source with the given parent UID. | |
| (double) | - getDurationFromParentUid: |
| Gets the duration of the instance of the playable source with the given parent UID. | |
Detailed Description
Provides a protocol for instanciable audio objects.Member Function Documentation
| - (id) createInstance |
Creates a new instance of the object if possible and return it.
If creating a new instance is not possible, nil is returned.
- Returns:
- The new instance object or nil.
| - (id) createInstanceWithParentUid: | (UID) | _uid |
Creates a new instance of the object with the given parent UID if possible and return it.
If creating a new instance is not possible, nil is returned.
- Parameters:
-
uid The UID of the object holding the instance new instance.
- Returns:
- The new instance object or nil.
| - (void) destroyInstance: | (id) | _instance |
Destroy the given instance of the object.
- Parameters:
-
instance The instance of the object to destroy.
| - (void) destroyInstanceFromParentUid: | (UID) | _uid |
Destroy the instance of the playable source with the given parent UID.
- Parameters:
-
uid The parent UID you want to destroy the corresponding instance.
| - (double) getDurationFromParentUid: | (UID) | _uid |
Gets the duration of the instance of the playable source with the given parent UID.
- Parameters:
-
uid The parent UID of the instance.
- Returns:
- The duration of the sources in seconds, or -1 if the duration is unknown.
| - (BOOL) isPlayingFromParentUid: | (UID) | _uid |
Gets the current playing status of the instance of the source with the given parent UID.
- Parameters:
-
uid The parent UID of the instance.
- Returns:
- YES if the source is currently playing, NO otherwise.
| - (id) startFromParentUid: | (UID) | _uid | ||
| listener: | (id) | _listener | ||
Starts the playable source with the given parent UID.
- Parameters:
-
uid The UID of the object holding the instance of the playable object. listener The optional listener of the created instance events.
- Returns:
- The playing instance of the source.
| - (id) stopFromParentUid: | (UID) | _uid |
Stops the instance of the playable source with the given parent UID.
If no instance is found with this ID suffix, it will be ignored.
- Parameters:
-
uid The parent UID of the instance to stop.
- Returns:
- The instance of the source that was stopped.
The documentation for this protocol was generated from the following file:
- /Users/lasorsa/Documents/SVN/aria/trunk/src/a2ml/core/protocols/AMInstanciable.h
