Methods > Recorders > StartFromDjStudioPlayer method

Remarks

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

In case the output of the player should be multi-channel, 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.

Syntax

[Visual Basic]

Public Function StartFromDjStudioPlayer (

nPlayerHandle as Int32,

bApplyBeforeEffects as Boolean,

strOutputPath as string

) as enumErrorCodes

[C#]

public enumErrorCodes StartFromDjStudioPlayer (

int nPlayerHandle,

bool bApplyBeforeEffects,

string strOutputPath

);

[C++]

public: enumErrorCodes StartFromDjStudioPlayer (

int nPlayerHandle,

bool bApplyBeforeEffects,

string strOutputPath

);

Parameter

Description

nPlayerHandle

Handle of the audio player returned by the GetPlayerHandle method of the Audio DJ Studio API for .NET component.

bApplyBeforeEffects

Boolean flag that specifies if the recording session should keep count or ignore special effects (like volume, balance, various DSPs, etc.) applied to the player's stream through dedicated methods of the Audio DJ Studio API for .NET component

Supported values are the following:

Mnemonic Value	Meaning
false	The recording session keeps count of special effects applied to the playing stream
true	The recording session ignores special effects applied to the playing stream

strOutputPath

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

If this parameter is left empty, recorded data will be stored inside a memory buffer.

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.