Copyright © 2006-2018 MultiMedia Soft

StartFromQueueRaw method

Previous pageReturn to chapter overviewNext page

Remarks

 

Starts a new recording session from a queue filled with raw PCM audio data. The queue can be filled in real time using the SendDataToQueueRaw method.

When using this method to start a recording session, the EncodeFormats.ResampleMode property must be set to RESAMPLE_MODE_CUSTOM_FORMAT.

 

A successful call to this method causes the container application to be notified through the CallbackForRecordersEvents delegate invoked with the nEvent parameter set to EV_REC_START

 

For details about the encoding format and parameters applied during recording see the How to perform a recording session section.

 

 

Syntax

 

[Visual Basic]

Public Function StartFromQueueRaw (

strOutputPath as string

nEncodeMode as enumRAWEncodeModes,

bIsBigEndian as Boolean,

nFrequency as Int32,

nChannels as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes StartFromQueueRaw (

string strOutputPath

enumRAWEncodeModes nEncodeMode,

bool bIsBigEndian,

Int32 nFrequency,

Int32 nChannels

);


 

[C++]

public: enumErrorCodes StartFromQueueRaw (

string strOutputPath

enumRAWEncodeModes nEncodeMode,

bool bIsBigEndian,

Int32 nFrequency,

Int32 nChannels

);


 

 

Parameter

Description

 

 

strOutputPath

String representing the absolute pathname of the output file that will contain the recorded data. If this pathname should contain invalid characters, they would be automatically changed into an underscore '_' character.

If the string is left empty, the recording session will be performed in memory.

nEncodeMode

Encode mode used to encode RAW audio data.

Supported values are the following:

Mnemonic constant

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 RAW audio data (e.g. 44100)

nChannels

Number of channels of RAW audio data: 1 for Mono or 2 for Stereo

 

 

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.