Classes > TracksBoard class > Methods > TracksBoard.ItemSoundFileRawAdd method

Remarks

Adds a sound file containing RAW audio data to the audio stream previously created through the TracksBoard.Create method.

Important note about items overlapping

Overlapping of two items on the same track is now allowed so, in case the new item should cause an overlapping and upon space availability, the new item will be automatically moved to the next track or to the previous track; if both previous and next tracks should in any case suffer an overlapping, a new track will be automatically inserted on the nearest position.

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard class section.

Syntax

[Visual Basic]

Public Function ItemSoundFileRawAdd (

strFriendlyName as String,

nTrack as Int32,

strPathname as String,

nEncodeMode as enumRAWEncodeModes,

bIsBigEndian as enumBoolean,

nFrequency as Long,

nChannels as Long,

nOffsetMs as Int32,

nStartPositionMs as Int32,

nEndPositionMs as Int32,

ByRef nUniqueId as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes ItemSoundFileRawAdd (

string strFriendlyName,

Int32 nTrack,

string strPathname,

enumRAWEncodeModes nEncodeMode,

bool bIsBigEndian,

Int32 nFrequency,

Int32 nChannels,

Int32 nOffsetMs,

Int32 nStartPositionMs,

Int32 nEndPositionMs,

ref Int32 nUniqueId

);

[C++]

public: enumErrorCodes ItemSoundFileRawAdd (

string strFriendlyName,

Int32 nTrack,

string strPathname,

enumRAWEncodeModes nEncodeMode,

bool bIsBigEndian,

Int32 nFrequency,

Int32 nChannels,

Int32 nOffsetMs,

Int32 nStartPositionMs,

Int32 nEndPositionMs,

Int32 __gc *nUniqueId

);

Parameter

Description

strFriendlyName

Friendly name of the item

nTrack

Zero-based index of the track where the item will be placed. The current number of tracks can be obtained through the TracksBoard.TracksCountGet method.

strPathname

Absolute pathname of the raw sound file

nEncodeMode

Encode mode used to encode the RAW file.

Supported values are the following:

Mnemonic constant	Numeric value	Meaning
RAW_ENCODE_PCM_U8	0	RAW PCM 8 bits Unsigned
RAW_ENCODE_PCM_S8	1	RAW PCM 8 bits Signed
RAW_ENCODE_PCM_S16	2	RAW PCM 16 bits Signed
RAW_ENCODE_PCM_S24	3	RAW PCM 24 bits Signed
RAW_ENCODE_PCM_S32	4	RAW PCM 32 bits Signed
RAW_ENCODE_FLOAT32	5	RAW 32 bits floating point
RAW_ENCODE_G711_ULAW	6	RAW G711 U-LAW
RAW_ENCODE_G711_ALAW	7	RAW G711 A-LAW
RAW_ENCODE_GSM_610	8	RAW GSM 6.10
RAW_ENCODE_DIALOGIC_VOX	9	RAW Dialogic ADPCM VOX

bIsBigEndian

Boolean flag that specifies if bits order inside the RAW file are little-endian or big-endian

Supported values are the following:

Mnemonic Value	Meaning
false	The RAW file is encoded using little-endian
true	The RAW file is encoded using big-endian

nFrequency

Sample rate of the RAW file (e.g. 44100)

nChannels

Number of channels of the RAW file: for example, 1 for Mono or 2 for Stereo, 6 for 5.1 formats and so on

nOffsetMs

Offset of the sound, expressed in milliseconds, respect to the beginning of the audio stream.

nStartPositionMs

Initial position within the given file, expressed in milliseconds

nEndPositionMs

Final position within the given file, expressed in milliseconds

nUniqueId

Reference to a value that, on return from the method call, will contain the unique identifier of the newly added item: this unique identifier will be used in order to invoke further methods related to the use of this specific item.

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to get the error code
enumErrorCodes.ERR_NOERROR (0)	The method call was successful