DOMAudioBinding

From Virtual World Web Wiki
Jump to: navigation, search

Represents an actual audio clip bound to an DOMAudioEvent in an DOMAudioFont

  • Inherits class: DOMObject
  • This is a leaf node type. This node type cannot have children.

Remarks [edit]

Properties

DOMAudioChannel AudioChannel {get; set;}
Selects the audio channel on which this clip should play
See also: DOMAudioChannel
DOMAudioFontMaterial AudioFontMaterial {get; set;}
If specified, limits this binding to certain physics materials. (e.g only play the splashing footstep sounds when someone is walking in water)
ResourceValue Clip {get; set;}
The resource of the audio clip.
float DopplerLevel {get; set;}
Determines how much doppler effect will be applied to this audio source (if is set to 0, then no effect is applied).
float MaxDistance {get; set;}
The distance where the sound stops attenuating at. Beyond this point it will stay at the volume it would be at MaxDistance units from the listener and will not attenuate any more.
float MinDistance {get; set;}
Within the MinDistance, the sound will stay at loudest possible. Outside MinDistance it will begin to attenuate. Increase the MinDistance of a sound to make it ‘louder’ in a 3d world, and decrease it to make it ‘quieter’ in a 3d world.
float Pitch {get; set;}
A pitch modifier. 1.0 is normal, higher and lower values change the pitch accordingly
bool Playing {get; set;}
True if the clip is should play.
bool ThreeD {get; set;}
True if the volume of the audio clip should be attenuated by the distance of the listener.
float Volume {get; set;}
The relative volume at which this clip should be played
int Weight {get; set;}
Used to influence the likelyhood of this clip being chosen over others bound to the same event

Constructors

DOMAudioBinding()
Constructs a new DOMAudioBinding with default settings
DOMAudioBinding(string title)
Constructs a new DOMAudioBinding, setting a title and adding children at the same time

Methods

bool CheckParent(DOMObject parent)
Called on DOMObject derived types just before they are added to the DOM to ensure their parent is appropriate.