AtomicNET : AtomicEngine Namespace

Sound Class

%Sound resource.

Syntax

public class Sound : Resource

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

Public Constructors

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

AsyncLoadState AsyncLoadState . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Compressed bool . Documentation for this section has not yet been entered.
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
DataSize uint . Documentation for this section has not yet been entered.
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Frequency float . 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]
IntFrequency uint . Documentation for this section has not yet been entered.
[read-only]
Length float . Documentation for this section has not yet been entered.
Looped bool . Documentation for this section has not yet been entered.
MemoryUse uint . Documentation for this section has not yet been entered. (Inherited from Resource.)
Name string . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
NameHash StringHash . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
SampleSize uint . Documentation for this section has not yet been entered.
[read-only]
SixteenBit bool . Documentation for this section has not yet been entered.
[write-only]
Size uint . 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.)
[read-only]
UseTimer uint . Documentation for this section has not yet been entered. (Inherited from Resource.)

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.)
override
BeginLoad (Deserializer) : bool
Load resource from stream. May be called from a worker thread. Return true if successful.
BeginLoad (Deserializer) : bool
Load resource from stream. May be called from a worker thread. Return true if successful. (Inherited from Resource.)
static
csb_Atomic_Sound_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
EndLoad () : bool
Finish resource loading. Always called from the main thread. Return true if successful. (Inherited from Resource.)
FixInterpolation ()
Fix interpolation by copying data from loop start to loop end (looped), or adding silence (oneshot.) Called internally, does not normally need to be called, unless the sound data is modified manually on the fly.
GetAsyncLoadState () : AsyncLoadState
Return the asynchronous loading state. (Inherited from Resource.)
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.)
GetDataSize () : uint
Return total sound data size.
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetFrequency () : float
Return default frequency as a float.
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetIntFrequency () : uint
Return default frequency as an integer.
GetLength () : float
Return length in seconds.
GetMemoryUse () : uint
Return memory use in bytes, possibly approximate. (Inherited from Resource.)
GetName () : string
Return name. (Inherited from Resource.)
GetNameHash () : StringHash
Return name hash. (Inherited from Resource.)
GetSampleSize () : uint
Return sample size.
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.)
GetUseTimer () : uint
Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero. (Inherited from Resource.)
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.)
IsCompressed () : bool
Return whether is compressed.
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
IsLooped () : bool
Return whether is looped.
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.)
IsSixteenBit () : bool
Return whether data is sixteen bit.
IsStereo () : bool
Return whether data is stereo.
Load (Deserializer) : bool
Documentation for this section has not yet been entered. (Inherited from Resource.)
LoadOggVorbis (Deserializer) : bool
Load Ogg Vorbis format sound data. Does not decode at load, but will rather be decoded while playing.
LoadRaw (Deserializer) : bool
Load raw sound data.
LoadWav (Deserializer) : bool
Load WAV format sound data.
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.)
ResetUseTimer ()
Reset last used timer. (Inherited from Resource.)
Save (Serializer) : bool
Save resource. Return true if successful. (Inherited from Resource.)
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetAsyncLoadState (AsyncLoadState)
Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user. (Inherited from Resource.)
SetFormat (uint, bool, bool)
Set uncompressed sound data format.
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetLoop (uint, uint)
Define loop.
SetLooped (bool)
Set loop on/off. If loop is enabled, sets the full sound as loop range.
SetMemoryUse (uint)
Set memory use in bytes, possibly approximate. (Inherited from Resource.)
SetName (string)
Set name. (Inherited from Resource.)
SetSize (uint)
Set sound size in bytes. Also resets the sound to be uncompressed and one-shot.
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.)
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

Sound Constructor

Documentation for this section has not yet been entered.

Syntax

public Sound ()

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 Constructor

Construct.

Syntax

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

BeginLoad Method

Load resource from stream. May be called from a worker thread. Return true if successful.

Syntax

public override bool BeginLoad (Deserializer source)

Parameters

source
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

Compressed Property

Documentation for this section has not yet been entered.

Syntax

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

csb_Atomic_Sound_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

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

DataSize Property

Documentation for this section has not yet been entered.

Syntax

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

FixInterpolation Method

Fix interpolation by copying data from loop start to loop end (looped), or adding silence (oneshot.) Called internally, does not normally need to be called, unless the sound data is modified manually on the fly.

Syntax

public void FixInterpolation ()

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; }

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

GetDataSize Method

Return total sound data size.

Syntax

public uint GetDataSize ()

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 default frequency as a float.

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

GetIntFrequency Method

Return default frequency as an integer.

Syntax

public uint GetIntFrequency ()

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

GetLength Method

Return length in seconds.

Syntax

public float GetLength ()

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 sample size.

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

IntFrequency Property

Documentation for this section has not yet been entered.

Syntax

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

IsCompressed Method

Return whether is compressed.

Syntax

public bool IsCompressed ()

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

IsLooped Method

Return whether is looped.

Syntax

public bool IsLooped ()

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

IsSixteenBit Method

Return whether data is sixteen bit.

Syntax

public bool IsSixteenBit ()

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 data 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

Length Property

Documentation for this section has not yet been entered.

Syntax

public float Length { 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

LoadOggVorbis Method

Load Ogg Vorbis format sound data. Does not decode at load, but will rather be decoded while playing.

Syntax

public bool LoadOggVorbis (Deserializer source)

Parameters

source
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

LoadRaw Method

Load raw sound data.

Syntax

public bool LoadRaw (Deserializer source)

Parameters

source
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

LoadWav Method

Load WAV format sound data.

Syntax

public bool LoadWav (Deserializer source)

Parameters

source
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

Looped Property

Documentation for this section has not yet been entered.

Syntax

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

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

SetFormat Method

Set uncompressed sound data format.

Syntax

public void SetFormat (uint frequency, bool sixteenBit, bool stereo)

Parameters

frequency
Documentation for this section has not yet been entered.
sixteenBit
Documentation for this section has not yet been entered.
stereo
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

SetLoop Method

Define loop.

Syntax

public void SetLoop (uint repeatOffset, uint endOffset)

Parameters

repeatOffset
Documentation for this section has not yet been entered.
endOffset
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

SetLooped Method

Set loop on/off. If loop is enabled, sets the full sound as loop range.

Syntax

public void SetLooped (bool enable)

Parameters

enable
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

SetSize Method

Set sound size in bytes. Also resets the sound to be uncompressed and one-shot.

Syntax

public void SetSize (uint dataSize)

Parameters

dataSize
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

SixteenBit Property

Documentation for this section has not yet been entered.

Syntax

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

Size Property

Documentation for this section has not yet been entered.

Syntax

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

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