AppendAutomationItemAddFromFileRaw method |
|
Remarks
Adds a sound file in RAW format, or a portion of the sound file, taken from a given pathname to the append automation list.
For further information about management of append automation sessions refer to the How to mix or append several sounds in one single shot tutorial.
Syntax
[Visual Basic] Public Function AppendAutomationItemAddFromFileRaw ( strPathname as String, nEncodeMode as enumRAWEncodeModes, bIsBigEndian as Boolean, nFrequency as Int32, nChannels as Int32, nStartPosition as Int32, nEndPosition as Int32, fVolume as Single ) as enumErrorCodes |
[C#] public enumErrorCodes AppendAutomationItemAddFromFileRaw ( string strPathname, enumRAWEncodeModes nEncodeMode, bool bIsBigEndian, Int32 nFrequency, Int32 nChannels, Int32 nStartPosition, Int32 nEndPosition, float fVolume ); |
[C++] public: enumErrorCodes AppendAutomationItemAddFromFileRaw ( string strPathname, enumRAWEncodeModes nEncodeMode, bool bIsBigEndian, Int32 nFrequency, Int32 nChannels, Int32 nStartPosition, Int32 nEndPosition, float fVolume ); |
Parameter |
Description |
|||||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||||
strPathname |
String representing the absolute pathname of the source sound file. |
|||||||||||||||||||||||||||||||||
nEncodeMode |
Encode mode used to encode the RAW file. Supported values are the following:
|
|||||||||||||||||||||||||||||||||
bIsBigEndian |
Boolean flag that specifies if bits order inside the RAW file are little-endian or big-endian Supported values are the following:
|
|||||||||||||||||||||||||||||||||
nFrequency |
Sample rate of the RAW file (e.g. 44100) |
|||||||||||||||||||||||||||||||||
nChannels |
Number of channels of the RAW file: 1 for Mono or 2 for Stereo |
|||||||||||||||||||||||||||||||||
nStartPosition |
Start position, expressed in milliseconds, of the range to load from the added sound file |
|||||||||||||||||||||||||||||||||
nEndPosition |
End position, expressed in milliseconds, of the range to load from the added sound file |
|||||||||||||||||||||||||||||||||
fVolume |
Volume level applied to the added song when it will be appended. Supported values are expressed with a linear volume in the range from 0 to 100. In case you should need to set a volume expressed in dB, before setting this parameter you could convert the value in dB into a linear value through the following formula (C syntax): VolumeLinear = 100 * pow (10, VolumeInDB/20); |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred. Check the LastError property value in order to see the last error. |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful. |