Methods > Recorders > StartFromDjStudioMixer method

Remarks

Starts a recording session getting sound data from the output of a given custom stream mixer instanced by Audio DJ Studio API for .NET.

In case the output of the stream mixer should be multi-channel meaning that it was created using the StreamMixerCreateWithSurround method of Audio DJ Studio API for .NET, the recorder could keep channels separated only in case the format of the output file should support multi-channel too, like WAV, Ogg Vorbis, Opus and WMA formats.

After calling this method, the container application is notified through the CallbackForRecordersEvents delegate invoked with the nEvent parameter set to EV_REC_START.

The recording session can be stopped at any time through a call to the Stop method.

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

For details about the use of custom stream mixers, see the "How to use custom Stream Mixers" tutorial inside the documentation of Audio DJ Studio API for .NET.

Syntax

[Visual Basic]

Public Function StartFromDjStudioMixer (

nStreamMixerID as Int16,

strOutputPath as string

) as enumErrorCodes

[C#]

public enumErrorCodes StartFromDjStudioMixer (

Int16 nStreamMixerID,

string strOutputPath

);

[C++]

public: enumErrorCodes StartFromDjStudioMixer (

Int16 nStreamMixerID,

string strOutputPath

);

Parameter	Description

nStreamMixerID	Number representing the unique identifier of the stream mixer. This unique identifier is assigned by Audio DJ Studio API for .NET after calling its StreamMixerCreate or StreamMixerCreateWithSurround method.
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.

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.