Music in Anark Studio 2.5
Instance Properties
| name | type | description |
|---|---|---|
| active | Boolean | Should this asset be drawn? [from Asset] |
| balance | Number | Left-to-right balance of the audio. |
| behaviors | Collection | (read only) All Behavior objects attached under this asset. [from Asset] |
| buffered | Boolean | (read only) Is the music buffered and ready to play? |
| constructor | Object | A reference to the constructor class for the current object instance. [from Object] |
| context | TimeContext | (read only) The asset's local TimeContext object. [from Asset] |
| contextType | Number | Type of the TimeContext for this asset. [from Asset] |
| duration | Number | (read only) Length in seconds. |
| endLifeTime | Number | Ending time of the asset. [from Asset] |
| id | Number | (read only) Unique ID for the asset. [from Asset] |
| loop | Boolean | Should the music continuously loop? |
| music | Collection | (read only) All Music objects attached under this asset. [from Asset] |
| name | String | User-defined name for the asset. [from Asset] |
| parent | Object | (read only) Parent object of this asset. [from Asset] |
| prototype | Object | The prototype for a class. [from Object] |
| remoteSource | String | (read only) URL to the source for the music. |
| sounds | Collection | (read only) All Sounds objects attached under this asset. [from Asset] |
| startLifeTime | Number | Starting time of the asset. [from Asset] |
| type | String | (read only) Type of the asset. [from Asset] |
| volume | Number | Loudness of the music. |
Instance Methods
| name | returns | description |
|---|---|---|
| attach(assetObject) | (none) | Attach the argument underneath the asset. [from Asset] |
| copy() | Asset | Create a copy of the asset. [from Asset] |
| detach(assetObject) | (none) | Remove an asset from this asset. [from Asset] |
| hasOwnProperty(propertyOrMethodName) | Boolean | Determines if the object/instance itself has the named property or method. [from Object] |
| isPrototypeOf(instanceToTest) | Boolean | Determines if the calling object prototype is in the inheritance chain for the supplied argument. [from Object] |
| pause() | (none) | Pause playback. |
| play() | (none) | Start playing the music. |
| propertyIsEnumerable(propertyOrMethodName) | Boolean |
Determines if the object/instance itself has a property or method of the supplied name which will appear in a for (prop in obj) enumeration.
[from Object]
|
| seek(position) | (none) | Move to a specific time in the music. |
| startBuffering() | (none) | Start downloading and buffering the music. |
| stop() | (none) | Stop playing the music. |
| toLocaleString() | String |
For most objects, the same as toString() unless explicitly overridden.
[from Object]
|
| toString() | String | Returns a string representation of the object. [from Object] |
| valueOf() | String |
Returns the internal this value of the object.
[from Object]
|
Description
A Music object is a type of asset, that encapsulates a specific song or music clip. Currently, Music objects may be loaded from .mp2 and .mp3 files.
New music objects can be created via scripting. The Library asset constructor creates a new instance of the object from a resource in the Anark Studio Library. Music cannot be created using the scripting constructor because there would be no way to assign a remoteSource (which is read-only) to the music. Objects created via scripting are not available to the Anark Studio interface, but they do appear in the finished project.
Library asset constructor syntax
var theMusic = new Music( "library://libraryAssetName" [, objectToAttachTo] );libraryAssetName- required — A String with the name of the asset in the Anark Studio Library from which to create this object.
objectToAttachTo- optional — The String name of the object to which the music will be attached. The Music object must be attached to another object in the scene either now or later in order to appear in the scene during playback.
Music Examples
// Create and play a music object from the library.
theMusic = new Music( "library://Song", scene );