Torque3D Documentation / _generateds / SFXInternal::SFXAsyncQueue

SFXInternal::SFXAsyncQueue

Engine/source/sfx/sfxInternal.h

An async stream queue that writes sound packets to SFXBuffers in sync to the playback of an SFXVoice.

More...

Public Types

enum
_Anonymous_ {  DEFAULT_STREAM_QUEUE_LENGTH = 3
}

Public Functions

SFXAsyncQueue(SFXVoice * voice, SFXBuffer * buffer, bool looping)

Construct a new sound queue that pushes sound packets to "buffer" in sync to the playback of "voice".

Detailed Description

An async stream queue that writes sound packets to SFXBuffers in sync to the playback of an SFXVoice.

Sound packet queues use sample counts as tick counts.

Public Types

@170

Enumerator

DEFAULT_STREAM_QUEUE_LENGTH = 3

The number of stream packets that the playback queue for streaming sounds will be sliced into.

This should generally be left at three since there is an overhead incurred for each additional segment. Having three segments gives one segment for current immediate playback, one segment as intermediate buffer, and one segment for stream writes.

typedef AsyncPacketQueue< SFXStreamPacket *, SFXVoiceTimeSource, SFXBuffer * > Parent 

Public Functions

SFXAsyncQueue(SFXVoice * voice, SFXBuffer * buffer, bool looping)

Construct a new sound queue that pushes sound packets to "buffer" in sync to the playback of "voice".

Parameters:

voice

The SFXVoice to synchronize to.

buffer

The sound buffer to push sound packets to.