AtomicNET : AtomicEngine Namespace

Audio Class

%Audio subsystem.

Syntax

public class Audio : AObject

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 AObject.

Public Constructors

Audio ()
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

[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.)
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Initialized bool . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Interpolation bool . Documentation for this section has not yet been entered.
Listener SoundListener . Documentation for this section has not yet been entered.
[read-only]
MixRate int . Documentation for this section has not yet been entered.
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Playing bool . Documentation for this section has not yet been entered.
[read-only]
SampleSize uint . Documentation for this section has not yet been entered.
[read-only]
SoundSources Vector<SoundSource> . Documentation for this section has not yet been entered.
[read-only]
Stereo bool . 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.)
AddSoundSource (SoundSource)
Add a sound source to keep track of. Called by SoundSource.
static
csb_Atomic_Audio_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
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.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetInterpolation () : bool
Return whether output is interpolated.
GetListener () : SoundListener
Return active sound listener.
GetMasterGain (string) : float
Return master gain for a specific sound source type. Unknown sound types will return full gain (1).
GetMixRate () : int
Return mixing rate.
GetSampleSize () : uint
Return byte size of one sample.
GetSoundSourceMasterGain (StringHash) : float
Return sound type specific gain multiplied by master gain.
GetSoundSources () : Vector<SoundSource>
Return all sound sources.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
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.)
HasMasterGain (string) : bool
Return whether the specified master gain has been defined.
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.)
IsInitialized () : bool
Return whether an audio stream has been reserved.
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 audio is being output.
IsSoundTypePaused (string) : bool
Return whether specific sound type has been paused.
IsStereo () : bool
Return whether output is stereo.
PauseSoundType (string)
Pause playback of specific sound type. This allows to suspend e.g. sound effects or voice when the game is paused. By default all sound types are unpaused.
Play () : bool
Restart sound output.
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.)
RemoveSoundSource (SoundSource)
Remove a sound source. Called by SoundSource.
ResumeAll ()
Resume playback of all sound types.
ResumeSoundType (string)
Resume playback of specific sound type.
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetListener (SoundListener)
Set active sound listener for 3D sounds.
SetMasterGain (string, float)
Set master gain on a specific sound type such as sound effects, music or voice.
SetMode (int, int, bool, bool) : bool
Initialize sound output with specified buffer length and output mode.
Stop ()
Suspend sound output.
StopSound (Sound)
Stop any sound source playing a certain sound clip.
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)
Documentation for this section has not yet been entered.
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

Audio Constructor

Documentation for this section has not yet been entered.

Syntax

public Audio ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Audio Constructor

Construct.

Syntax

public Audio (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

AddSoundSource Method

Add a sound source to keep track of. Called by SoundSource.

Syntax

public void AddSoundSource (SoundSource soundSource)

Parameters

soundSource
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_Audio_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_Audio_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

GetInterpolation Method

Return whether output is interpolated.

Syntax

public bool GetInterpolation ()

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

GetListener Method

Return active sound listener.

Syntax

public SoundListener GetListener ()

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

GetMasterGain Method

Return master gain for a specific sound source type. Unknown sound types will return full gain (1).

Syntax

public float GetMasterGain (string type)

Parameters

type
Documentation for this section has not yet been entered.

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

GetMixRate Method

Return mixing rate.

Syntax

public int GetMixRate ()

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

GetSampleSize Method

Return byte size of one sample.

Syntax

public uint GetSampleSize ()

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

GetSoundSourceMasterGain Method

Return sound type specific gain multiplied by master gain.

Syntax

public float GetSoundSourceMasterGain (StringHash typeHash)

Parameters

typeHash
Documentation for this section has not yet been entered.

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

GetSoundSources Method

Return all sound sources.

Syntax

public Vector<SoundSource> GetSoundSources ()

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

HasMasterGain Method

Return whether the specified master gain has been defined.

Syntax

public bool HasMasterGain (string type)

Parameters

type
Documentation for this section has not yet been entered.

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

Initialized Property

Documentation for this section has not yet been entered.

Syntax

public bool Initialized { 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

Interpolation Property

Documentation for this section has not yet been entered.

Syntax

public bool Interpolation { 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

IsInitialized Method

Return whether an audio stream has been reserved.

Syntax

public bool IsInitialized ()

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 audio is being output.

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

IsSoundTypePaused Method

Return whether specific sound type has been paused.

Syntax

public bool IsSoundTypePaused (string type)

Parameters

type
Documentation for this section has not yet been entered.

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

IsStereo Method

Return whether output is stereo.

Syntax

public bool IsStereo ()

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

Listener Property

Documentation for this section has not yet been entered.

Syntax

public SoundListener Listener { 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

MixRate Property

Documentation for this section has not yet been entered.

Syntax

public int MixRate { 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

PauseSoundType Method

Pause playback of specific sound type. This allows to suspend e.g. sound effects or voice when the game is paused. By default all sound types are unpaused.

Syntax

public void PauseSoundType (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

Play Method

Restart sound output.

Syntax

public bool Play ()

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

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

RemoveSoundSource Method

Remove a sound source. Called by SoundSource.

Syntax

public void RemoveSoundSource (SoundSource soundSource)

Parameters

soundSource
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

ResumeAll Method

Resume playback of all sound types.

Syntax

public void ResumeAll ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

ResumeSoundType Method

Resume playback of specific sound type.

Syntax

public void ResumeSoundType (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

SampleSize Property

Documentation for this section has not yet been entered.

Syntax

public uint SampleSize { 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

SetListener Method

Set active sound listener for 3D sounds.

Syntax

public void SetListener (SoundListener listener)

Parameters

listener
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

SetMasterGain Method

Set master gain on a specific sound type such as sound effects, music or voice.

Syntax

public void SetMasterGain (string type, float gain)

Parameters

type
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

SetMode Method

Initialize sound output with specified buffer length and output mode.

Syntax

public bool SetMode (int bufferLengthMSec, int mixRate, bool stereo, bool interpolation)

Parameters

bufferLengthMSec
Documentation for this section has not yet been entered.
mixRate
Documentation for this section has not yet been entered.
stereo
Documentation for this section has not yet been entered.
interpolation
Documentation for this section has not yet been entered.

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

SoundSources Property

Documentation for this section has not yet been entered.

Syntax

public Vector<SoundSource> SoundSources { 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

Stereo Property

Documentation for this section has not yet been entered.

Syntax

public bool Stereo { 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

Stop Method

Suspend sound output.

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

StopSound Method

Stop any sound source playing a certain sound clip.

Syntax

public void StopSound (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

Update Method

Documentation for this section has not yet been entered.

Syntax

public 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