AtomicNET : AtomicEngine Namespace

SoundSource Class

%Sound source component with stereo position. A sound source needs to be created to a node to be considered "enabled" and be able to play, however that node does not need to belong to a scene.

Syntax

public class SoundSource : Component

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from Component.

Public Constructors

Documentation for this section has not yet been entered.
Construct.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

AnimationEnabled bool . Documentation for this section has not yet been entered. (Inherited from Animatable.)
[write-only]
AnimationTime float . Documentation for this section has not yet been entered. (Inherited from Animatable.)
Attenuation float . Documentation for this section has not yet been entered.
AutoRemoveMode AutoRemoveMode . Documentation for this section has not yet been entered.
[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
Enabled bool . Documentation for this section has not yet been entered. (Inherited from Component.)
[read-only]
EnabledEffective bool . Documentation for this section has not yet been entered. (Inherited from Component.)
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
Frequency float . Documentation for this section has not yet been entered.
Gain float . Documentation for this section has not yet been entered.
[read-only]
ID uint . Documentation for this section has not yet been entered. (Inherited from Component.)
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Node Node . Documentation for this section has not yet been entered. (Inherited from Component.)
[read-only]
NumAttributes uint . Documentation for this section has not yet been entered. (Inherited from Serializable.)
[read-only]
NumNetworkAttributes uint . Documentation for this section has not yet been entered. (Inherited from Serializable.)
ObjectAnimation ObjectAnimation . Documentation for this section has not yet been entered. (Inherited from Animatable.)
Panning float . Documentation for this section has not yet been entered.
[read-only]
Playing bool . Documentation for this section has not yet been entered.
[write-only]
PlayingAttr bool . Documentation for this section has not yet been entered.
PositionAttr int . Documentation for this section has not yet been entered.
[read-only]
Sound Sound . Documentation for this section has not yet been entered.
[read-only]
Scene Scene . Documentation for this section has not yet been entered. (Inherited from Component.)
SoundType string . Documentation for this section has not yet been entered.
Temporary bool . Documentation for this section has not yet been entered. (Inherited from Serializable.)
[read-only]
TimePosition float . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
TypeNameStatic string . Documentation for this section has not yet been entered. (Inherited from AObject.)

Public Methods

AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
AllocateNetworkState ()
Allocate network attribute state. (Inherited from Serializable.)
ApplyAttributes ()
Apply attribute changes that can not be applied immediately. Called after scene load or a network update. (Inherited from Serializable.)
CleanupConnection (Connection)
Clean up all references to a network connection that is about to be removed. (Inherited from Component.)
static
csb_Atomic_SoundSource_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
DrawDebugGeometry (DebugRenderer, bool)
Visualize the component as debug geometry. (Inherited from Component.)
GetAnimationEnabled () : bool
Return animation enabled. (Inherited from Animatable.)
GetAttenuation () : float
Return attenuation.
GetAttributeAnimation (string) : ValueAnimation
Return attribute animation. (Inherited from Animatable.)
GetAttributeAnimationSpeed (string) : float
Return attribute animation speed. (Inherited from Animatable.)
GetAttributeAnimationTime (string) : float
Return attribute animation time position. (Inherited from Animatable.)
GetAttributeAnimationWrapMode (string) : WrapMode
Return attribute animation wrap mode. (Inherited from Animatable.)
GetAutoRemoveMode () : AutoRemoveMode
Return automatic removal mode on sound playback completion.
GetCategory () : string
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. (Inherited from AObject.)
GetComponent (StringHash) : Component
Return component in the same scene node by type. If there are several, returns the first. (Inherited from Component.)
GetComponent<T> (bool) : T
Documentation for this section has not yet been entered. (Inherited from Component.)
GetComponents (Vector<Component>, StringHash)
Return components in the same scene node by type. (Inherited from Component.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetDependencyNodes (Vector<Node>)
Return the depended on nodes to order network updates. (Inherited from Component.)
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetFrequency () : float
Return frequency.
GetGain () : float
Return gain.
GetID () : uint
Return ID. (Inherited from Component.)
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetInterceptNetworkUpdate (string) : bool
Return whether an attribute's network updates are being intercepted. (Inherited from Serializable.)
GetNode () : Node
Return scene node. (Inherited from Component.)
GetNumAttributes () : uint
Return number of attributes. (Inherited from Serializable.)
GetNumNetworkAttributes () : uint
Return number of network replication attributes. (Inherited from Serializable.)
GetObjectAnimation () : ObjectAnimation
Return object animation. (Inherited from Animatable.)
GetPanning () : float
Return stereo panning.
GetPositionAttr () : int
Return sound position attribute.
GetScene () : Scene
Return the scene the node belongs to. (Inherited from Component.)
GetSound () : Sound
Return sound.
GetSoundType () : string
Return sound type, determines the master gain group.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
GetTimePosition () : float
Return playback time position.
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
HasEventHandlers () : bool
Return whether has subscribed to any event. (Inherited from AObject.)
HasSubscribedToEvent (StringHash) : bool
Return whether has subscribed to an event without specific sender. (Inherited from AObject.)
HasSubscribedToEvent (AObject, StringHash) : bool
Return whether has subscribed to a specific sender's event. (Inherited from AObject.)
IsEnabled () : bool
Return whether is enabled. (Inherited from Component.)
IsEnabledEffective () : bool
Return whether is effectively enabled (node is also enabled.) (Inherited from Component.)
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
override
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from AObject.)
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
IsPlaying () : bool
Return whether is playing.
IsTemporary () : bool
Return whether is temporary. (Inherited from Serializable.)
Load (Deserializer, bool) : bool
Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful. (Inherited from Serializable.)
override
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Component.)
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Serializable.)
OnSetEnabled ()
Handle enabled/disabled state change. (Inherited from Component.)
Play (Sound)
Play a sound.
Play (Sound, float)
Play a sound with specified frequency.
Play (Sound, float, float)
Play a sound with specified frequency and gain.
Play (Sound, float, float, float)
Play a sound with specified frequency, gain and panning.
PrepareNetworkUpdate ()
Prepare network update by comparing attributes and marking replication states dirty as necessary. (Inherited from Component.)
ReadDeltaUpdate (Deserializer) : bool
Read and apply a network delta update. Return true if attributes were changed. (Inherited from Serializable.)
ReadLatestDataUpdate (Deserializer) : bool
Read and apply a network latest data update. Return true if attributes were changed. (Inherited from Serializable.)
Refs () : int
Return reference count. (Inherited from RefCounted.)
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
Remove ()
Remove from the scene node. If no other shared pointer references exist, causes immediate deletion. (Inherited from Component.)
RemoveAttributeAnimation (string)
Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer. (Inherited from Animatable.)
RemoveInstanceDefault ()
Remove instance's default values if they are set previously. (Inherited from Serializable.)
RemoveObjectAnimation ()
Remove object animation. Same as calling SetObjectAnimation with a null pointer. (Inherited from Animatable.)
ResetToDefault ()
Reset all editable attributes to their default values. (Inherited from Serializable.)
override
Save (Serializer) : bool
Save as binary data. Return true if successful. (Inherited from Component.)
Save (Serializer) : bool
Save as binary data. Return true if successful. (Inherited from Serializable.)
SaveDefaultAttributes () : bool
Return whether should save default-valued attributes into XML. Default false. (Inherited from Serializable.)
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetAnimationEnabled (bool)
Set automatic update of animation, default true. (Inherited from Animatable.)
SetAnimationTime (float)
Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case. (Inherited from Animatable.)
SetAttenuation (float)
Set attenuation. 1.0 is unaltered. Used for distance attenuated playback.
SetAttributeAnimation (string, ValueAnimation, WrapMode, float)
Set attribute animation. (Inherited from Animatable.)
SetAttributeAnimationSpeed (string, float)
Set attribute animation speed. (Inherited from Animatable.)
SetAttributeAnimationTime (string, float)
Set attribute animation time position manually. Automatic update should be disabled in this case. (Inherited from Animatable.)
SetAttributeAnimationWrapMode (string, WrapMode)
Set attribute animation wrap mode. (Inherited from Animatable.)
SetAutoRemoveMode (AutoRemoveMode)
/ Set to remove either the sound source component or its owner node from the scene automatically on sound playback completion. Disabled by default.
SetEnabled (bool)
Set enabled/disabled state. (Inherited from Component.)
SetFrequency (float)
Set frequency.
SetGain (float)
Set gain. 0.0 is silence, 1.0 is full volume.
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetInterceptNetworkUpdate (string, bool)
Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction. (Inherited from Serializable.)
SetObjectAnimation (ObjectAnimation)
Set object animation. (Inherited from Animatable.)
SetPanning (float)
Set stereo panning. -1.0 is full left and 1.0 is full right.
SetPlayingAttr (bool)
Set sound playing attribute
SetPositionAttr (int)
Set sound position attribute.
SetSoundType (string)
Set sound type, determines the master gain group.
SetTemporary (bool)
Set temporary flag. Temporary objects will not be saved. (Inherited from Serializable.)
Stop ()
Stop playback.
SubscribeToEvent (string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (AObject, NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromAllEvents ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (StringHash)
Unsubscribe from an event. (Inherited from AObject.)
UnsubscribeFromEvent (uint)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (AObject, StringHash)
Unsubscribe from a specific sender's event. (Inherited from AObject.)
UnsubscribeFromEvent<T> ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEventReceiver (AObject)
Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object) (Inherited from AObject.)
UnsubscribeFromEvents (AObject)
Unsubscribe from a specific sender's events. (Inherited from AObject.)
Update (float)
Update the sound source. Perform subclass specific operations. Called by Audio.
UpdateMasterGain ()
Update the effective master gain. Called internally and by Audio when the master gain changes.
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)
WriteInitialDeltaUpdate (Serializer, byte)
Write initial delta network update. (Inherited from Serializable.)
WriteLatestDataUpdate (Serializer, byte)
Write a latest data network update. (Inherited from Serializable.)

Member Details

SoundSource Constructor

Documentation for this section has not yet been entered.

Syntax

public SoundSource ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SoundSource Constructor

Construct.

Syntax

public SoundSource (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Attenuation Property

Documentation for this section has not yet been entered.

Syntax

public float Attenuation { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AutoRemoveMode Property

Documentation for this section has not yet been entered.

Syntax

public AutoRemoveMode AutoRemoveMode { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_SoundSource_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_SoundSource_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Frequency Property

Documentation for this section has not yet been entered.

Syntax

public float Frequency { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Gain Property

Documentation for this section has not yet been entered.

Syntax

public float Gain { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetAttenuation Method

Return attenuation.

Syntax

public float GetAttenuation ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetAutoRemoveMode Method

Return automatic removal mode on sound playback completion.

Syntax

public AutoRemoveMode GetAutoRemoveMode ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetFrequency Method

Return frequency.

Syntax

public float GetFrequency ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetGain Method

Return gain.

Syntax

public float GetGain ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPanning Method

Return stereo panning.

Syntax

public float GetPanning ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPositionAttr Method

Return sound position attribute.

Syntax

public int GetPositionAttr ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetSound Method

Return sound.

Syntax

public Sound GetSound ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetSoundType Method

Return sound type, determines the master gain group.

Syntax

public string GetSoundType ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTimePosition Method

Return playback time position.

Syntax

public float GetTimePosition ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsPlaying Method

Return whether is playing.

Syntax

public bool IsPlaying ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Panning Property

Documentation for this section has not yet been entered.

Syntax

public float Panning { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Play Method

Play a sound.

Syntax

public void Play (Sound sound)

Parameters

sound
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Play Method

Play a sound with specified frequency.

Syntax

public void Play (Sound sound, float frequency)

Parameters

sound
Documentation for this section has not yet been entered.
frequency
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Play Method

Play a sound with specified frequency and gain.

Syntax

public void Play (Sound sound, float frequency, float gain)

Parameters

sound
Documentation for this section has not yet been entered.
frequency
Documentation for this section has not yet been entered.
gain
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Play Method

Play a sound with specified frequency, gain and panning.

Syntax

public void Play (Sound sound, float frequency, float gain, float panning)

Parameters

sound
Documentation for this section has not yet been entered.
frequency
Documentation for this section has not yet been entered.
gain
Documentation for this section has not yet been entered.
panning
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Playing Property

Documentation for this section has not yet been entered.

Syntax

public bool Playing { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

PlayingAttr Property

Documentation for this section has not yet been entered.

Syntax

public bool PlayingAttr { set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

PositionAttr Property

Documentation for this section has not yet been entered.

Syntax

public int PositionAttr { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetAttenuation Method

Set attenuation. 1.0 is unaltered. Used for distance attenuated playback.

Syntax

public void SetAttenuation (float attenuation)

Parameters

attenuation
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetAutoRemoveMode Method

/ Set to remove either the sound source component or its owner node from the scene automatically on sound playback completion. Disabled by default.

Syntax

public void SetAutoRemoveMode (AutoRemoveMode mode)

Parameters

mode
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetFrequency Method

Set frequency.

Syntax

public void SetFrequency (float frequency)

Parameters

frequency
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetGain Method

Set gain. 0.0 is silence, 1.0 is full volume.

Syntax

public void SetGain (float gain)

Parameters

gain
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetPanning Method

Set stereo panning. -1.0 is full left and 1.0 is full right.

Syntax

public void SetPanning (float panning)

Parameters

panning
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetPlayingAttr Method

Set sound playing attribute

Syntax

public void SetPlayingAttr (bool value)

Parameters

value
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetPositionAttr Method

Set sound position attribute.

Syntax

public void SetPositionAttr (int value)

Parameters

value
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetSoundType Method

Set sound type, determines the master gain group.

Syntax

public void SetSoundType (string type)

Parameters

type
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Sound Property

Documentation for this section has not yet been entered.

Syntax

public Sound Sound { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SoundType Property

Documentation for this section has not yet been entered.

Syntax

public string SoundType { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Stop Method

Stop playback.

Syntax

public void Stop ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

TimePosition Property

Documentation for this section has not yet been entered.

Syntax

public float TimePosition { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Update Method

Update the sound source. Perform subclass specific operations. Called by Audio.

Syntax

public virtual void Update (float timeStep)

Parameters

timeStep
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

UpdateMasterGain Method

Update the effective master gain. Called internally and by Audio when the master gain changes.

Syntax

public void UpdateMasterGain ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0