Copyright © 2011-2019 MultiMedia Soft

JoinFilesFromDisk method

Previous pageReturn to chapter overviewNext page

Remarks

 

Joins two mono sound files into a single output stereo file keeping them separated inside left and right channel. The sound encoding format is defined inside the EncodeFormats.FormatToUse property.

A joining session can be stopped at any time through a call to the CancelJoinFilesFromDisk method.

 

If the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_WAV, the joining will only work if the EncodeFormats.WAV.EncodeMode property is set to a format supporting stereo  meaning that, for example, it will not work for mono-only formats like WAV_ENCODE_GSM_610 or WAV_ENCODE_G721_ADPCM_32.

 

If the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_AIFF, the joining will only work if the EncodeFormats.AIFF.EncodeMode property is set to a format supporting stereo meaning that, for example, it will not work for mono-only formats like AIFF_ENCODE_GSM_610.

 

If the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_AU, the joining will only work if the EncodeFormats.AU.EncodeMode property is set to a format supporting stereo meaning that, for example, it will not work for mono-only formats like AU_ENCODE_G721_ADPCM_32 or AU_ENCODE_G723_ADPCM_24 or AU_ENCODE_G723_ADPCM_40.

 

If the EncodeFormats.FormatToUse property is set to ENCODING_FORMAT_ACM, the joining will only work if the selected codec supports stereo meaning that, for example, it will not work for mono-only codecs like GSM 6.10 or G721 ADPCM.

 

During the execution of the joining session the CallbackPercentage delegate is invoked, with the nOperation parameter set to OPERATION_JOIN_SOUNDS, in order to notify about the percentage of advancement of the joining session.

 

For further details about callback delegates see the How to synchronize the container application with the API tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function JoinFilesFromDisk (

nOutputFrequency as Int32,

strPathnameLeft as String,

nOffsetLeftInMs as Int32,

strPathnameRight as String,

nOffsetRightInMs as Int32,

strPathnameOutput as String

) as enumErrorCodes

 

[C#]

public enumErrorCodes JoinFilesFromDisk (

Int32 nOutputFrequency,

string strPathnameLeft,

Int32 nOffsetLeftInMs,

string strPathnameRight,

Int32 nOffsetRightInMs,

string strPathnameOutput

);

 

[C++]

public: enumErrorCodes JoinFilesFromDisk (

Int32 nOutputFrequency,

string strPathnameLeft,

Int32 nOffsetLeftInMs,

string strPathnameRight,

Int32 nOffsetRightInMs,

string strPathnameOutput

);

 

Parameter

Description

 

 

nOutputFrequency

Resampling frequency for the output file.

strPathnameLeft

String containing the absolute pathname of the first input mono file that will be stored inside the left channel of the output stereo file. If this pathname should contain invalid characters, they would be automatically changed into an underscore '_' character.

nOffsetLeftInMs

Offset expressed in milliseconds at which the first input mono file will be stored inside the output stereo file.

strPathnameRight

String containing the absolute pathname of the second input mono file that will be stored inside the right channel of the output stereo file. If this pathname should contain invalid characters, they would be automatically changed into an underscore '_' character.

nOffsetRightInMs

Offset expressed in milliseconds at which the second input mono file will be stored inside the output stereo file.

strPathnameOutput

String containing the absolute pathname of the output stereo file. If this pathname should contain invalid characters, they would be automatically changed into an underscore '_' character.

 

 

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.