BB FlashBack SDK: FBSounds

MixAndExtractSoundsFrames

Description

For the selected frames, this method saves all sound tracks to a single sound file.

See How The Sound Classes Work for more information on sound tracks.

Syntax

[C#/C++]
public long MixAndExtractSoundsFrames (BSTR Filename, SoundFormat CompressFormat, long Format, long mp3profile, bool UseBestFormat, long StartFrame, long EndFrame);

[VB.NET]
Public Function MixAndExtractSoundsFrames (ByVal Filename As String, ByVal compressformat As SoundFormat, ByVal Format As Integer, ByVal mp3profile As Integer, ByVal UseBestFormat As Boolean, ByVal StartFrame As Integer, ByVal EndFrame As Integer) As Integer

Parameters

Filename (in) - name of the file to save the tracks to.

 

CompressFormat (in) - determines the format of the saved sound file.

0

Unchanged - keeps the current format of the sound.

1

WAV (uncompressed)

2

MP3

 

Format (in) - this can be one of the following standard Win32 SDK constants, describing the number of channels, sample rate and bits per sample:

Value

Format

WAVE_FORMAT_1M08

11.025 kHz, mono, 8-bit.

WAVE_FORMAT_1M16

11.025 kHz, mono, 16-bit.

WAVE_FORMAT_1S08

11.025 kHz, stereo, 8-bit.

WAVE_FORMAT_1S16

11.025 kHz, stereo, 16-bit.

WAVE_FORMAT_2M08

22.05 kHz, mono, 8-bit.

WAVE_FORMAT_2M16

22.05 kHz, mono, 16-bit.

WAVE_FORMAT_2S08

22.05 kHz, stereo, 8-bit.

WAVE_FORMAT_2S16

22.05 kHz, stereo, 16-bit.

WAVE_FORMAT_4M08

44.1 kHz, mono, 8-bit.

WAVE_FORMAT_4M16

44.1 kHz, mono, 16-bit.

WAVE_FORMAT_4S08

44.1 kHz, stereo, 8-bit.

WAVE_FORMAT_4S16

44.1 kHz, stereo, 16-bit.

 

mp3profile (in) - This property is ignored if the CompressFormat parameter is not set to MP3.

It can be one of the following constants:

Value

Audio Quality

0

Normal

1

Low

2

High

5

Very high

Higher audio quality means less compression and larger file sizes.

 

UseBestFormat (in) - If the Format parameter is set to zero, the value of UseBestFormat determines the sound format to be used on export.

Set UseBestFormat to True to mix all sounds to the highest quality format used by any sound in the movie.

Set UseBestFormat to False to mix all sounds to the lowest quality format used by any sound in the movie.

StartFrame (in) - the first frame of the sequence for which sound is to be extracted.

EndFrame (in) - the last frame of the sequence for which sound is to be extracted.

 

Return Values

Returns zero if unsuccessful, non-zero if successful.

See Also

How the sound classes work