Torque 3D 3.7
ContentsIndexHome
PreviousUpNext
SFXWrapAroundBuffer Members

The following tables list the members exposed by SFXWrapAroundBuffer.

 
Name 
Description 
 
Weak reference to WeakRefBase
 
Name 
Description 
 
Status indicators for sound buffers. 
 
Name 
Description 
 
Pointer to structure keeping the asynchronous I/O state of the buffer. For non-streaming buffers, this is released as soon as all data is loaded.
To allow seeking in streaming buffers even after playback has ended, we do not release the async state of these buffers until the buffer is actually released itself. This allows to always access the associated input stream.
@note For devices that handle loading/streaming on their own, this will not be set. 
 
Size of the device buffer in bytes
 
Total playback time of the associated sound stream in milliseconds. @note For streaming buffers, this will not correspond to the actual playtime of the device buffer. 
 
The sound sample format used by the buffer. 
 
If true, the buffer is dead and will be deleted. Can't be in status for synchronization reasons. 
 
For streaming buffers, tells whether the source stream loops. 
 
If true, this is a continuously streaming buffer. 
 
If true, this buffer can only have a single SFXVoice attached. 
 
< reference counter for StrongRefPtr objects 
 
The buffer readiness status. 
 
If this is a unique buffer (i.e. a streaming buffer), then this holds the reference to the unique voice. 
 
Absolute byte offset into the sound stream that the next packet write will occur at. This is notan offset into the device buffer in order to allow us to track how far in the source stream we are. 
 
Name 
Description 
 
Copy "length" bytes from "data" into the device at "offset". 
 
 
Set the buffer status and trigger mOnStatusChange if the status changes. @note Called on both the SFX update thread and the main thread.
 
 
 
 
@return the sample position in the sound stream as determined from the given buffer offset. 
 
This is the overview for the SFXBuffer constructor overload. 
 
 
Name 
Description 
 
Signal that is triggered when the buffer status changes. @note This signal is triggered on the same thread that the buffer update code runs on. 
 
This signal is triggered from SFXBuffer's destructor so the sound system can keep track of buffers being released on the device
Name 
Description 
This is friend class StrongObjectRef. 
dtor 
 
Name 
Description 
 
Decrements the reference count
 
 
object destroy self call (from StrongRefPtr). Override if this class has specially allocated memory. 
 
return The total playback time of the buffer in milliseconds. 
 
return The sound sample format used by the buffer. 
 
return The number of bytes consumed by this sound buffer. 
 
return The total number of samples in the buffer. 
 
This is getRefCount, a member of class StrongRefBase. 
 
return The current buffer loading/queue status. 
 
This is getWeakReference, a member of class WeakRefBase. 
 
Increments the reference count
 
return True if the buffer has exhausted its source stream 
 
return True if the buffer's packet queue has been starved and is waiting for data
 
return True if the buffer is pending deletion. 
 
return True if the buffer's packet queue is still loading. 
 
return True if the buffer's packet queue is loaded and ready for playback. 
 
return True if the buffer does continuous sound streaming. 
 
return True if the buffer can only have a single SFXVoice attached to it. 
 
load 
Start the async request chain for the buffer.
 
 
This is the overview for the SFXWrapAroundBuffer constructor overload. 
 
Update the object state. 
 
Name 
Description 
This is nested type SFXBuffer::AsyncStatePtr. 
The element type of this input stream. 
This is nested type SFXInternal::SFXWrapAroundBuffer::Parent. 
This is nested type SFXBuffer::SFXAsyncQueuePtr. 
This is nested type SFXBuffer::SFXAsyncStreamPtr. 
 
Name 
Description 
 
Encapsulates the async I/O state of the sound buffer. 
Copyright (c) 2015. All rights reserved.
What do you think about this topic? Send feedback!