Set this field if a specific Audio object should be targeted when playing the sound sample.

This field is set on initialisation. It indicates the total number of bytes per second that will be played if the sample is played back at its normal frequency.

This field reflects the audio channel index that the sound is currently playing through, or has most recently played through.

Setting the Compression field will determine how much compression is applied when saving an audio sample. The range of compression is 0 to 100%, with 100% being the strongest level available while 0% is uncompressed and loss-less. This field is ignored if the file format does not support compression.

This field specifies the frequency of the sampled sound data. If the frequency cannot be determined from the source, this value will be zero.

Note that if the playback frequency needs to be altered, set the Playback field.

The Header field is a pointer to a 128 byte buffer that contains the first 128 bytes of information read from an audio file on initialisation. This special field is considered to be helpful only to developers writing add-on components for the sound class.

The buffer that is referred to by the Header field is not populated until the Init action is called on the sound object.

This field specifies the length of the sample data in bytes. To get the length of the sample in seconds, divide this value by the BytesPerSecond field.

When using looped samples (via the SDF::LOOP flag), set the LoopEnd field if the sample should end at a position that is earlier than the sample's actual length. The LoopEnd value is specified in bytes and must be less or equal to the length of the sample and greater than the LoopStart value.

When using looped samples (via the SDF::LOOP flag), set the LoopStart field if the sample should begin at a position other than zero. The LoopStart value is specified in bytes and must be less than the length of the sample and the LoopEnd value.

Note that the LoopStart variable does not affect the position at which playback occurs for the first time - it only affects the restart position when the end of the sample is reached.

Set the Note field to alter the playback frequency of a sound sample. Setting this field as opposed to the Playback frequency will assure that the sample is played at a correctly scaled tone.

The Note field can be set using either string or integer based format. If using the integer format, the chosen value will reflect the position on a musical keyboard. A value of zero refers to the middle C key. Each octave is measured in sets of 12 notes, so a value of 24 would indicate a C note at 3 times normal playback. To play at lower values, simply choose a negative integer to slow down sample playback.

Setting the Note field with the string format is useful if human readability is valuable. The correct format is KEY OCTAVE SHARP. Here are some examples: C5, D7#, G2, E3S.

The middle C key for this format is C5. The maximum octave that you can achieve for the string format is 9 and the lowest is 0. Use either the S character or the # character for referral to a sharp note.

The Octave field determines the octave to use when playing back a sound sample. The default setting is zero, which represents the octave at which the sound was sampled. Setting a negative octave will lower the playback rate, while positive values raise the playback rate. The minimum octave setting is -5 and the highest setting is +5.

The octave can also be adjusted by setting the Note field. Setting the Octave field directly is useful if you need to quickly double or halve the playback rate.

Set OnStop to a callback function to receive an event trigger when sample playback stops. The prototype for the function is void OnStop(*Sound).

The timing of this event does not guarantee precision, but should be accurate to approximately 1/100th of a second in most cases.

The Pan field adjusts the "horizontal position" of a sample that is being played through stereo speakers. The default value for this field is zero, which plays the sound through both speakers at an equal level. The minimum value is -1.0 to force play through the left speaker and the maximum value is 1.0 for the right speaker.

This field must refer to a file that contains the audio data that will be loaded. If creating a new sample with the SDF::NEW flag, it is not necessary to define a file source.

Set this field to define the exact frequency of a sample's playback. The playback frequency can be modified at any time, including during audio playback if real-time adjustments to a sample's audio output rate is desired.

The current playback position of the audio sample is indicated by this field. Writing to the field will alter the playback position, either when the sample is next played, or immediately if it is currently playing.

The playback priority of the sample is defined here. This helps to determine if the sample should be played when all available mixing channels are busy. Naturally, higher priorities are played over samples with low priorities.

The minimum priority value allowed is -100, the maximum is 100.

The field specifies the volume of a sound in the range 0 - 1.0 (low to high). Setting this field during sample playback will dynamically alter the volume.