Copyright © 2006-2026 MultiMedia Soft

StartFromDjStudioPlayer method

Previous pageReturn to chapter overviewNext page

Remarks

 

Starts a recording session getting sound data from the output of a given player instanced by Active DJ Studio.

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.

 

Calling this method will cause the control to fire a RecordingStarted event. 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]

control.StartFromDjStudioPlayer (

nPlayerHandle as Long,

bApplyBeforeEffects as enumBoolean,

strOutputPath as string,

) as enumErrorCodes


 

[C++]

short control.StartFromDjStudioPlayer (

long nPlayerHandle,

short bApplyBeforeEffects,

LPCTSTR strOutputPath

);


 

 

Parameter

Description

 

 

nPlayerHandle

Handle of the audio player returned by the GetPlayerHandle method of the Active DJ Studio 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 Active DJ Studio component

Supported values are the following:

Mnemonic Value

Meaning

BOOL_FALSE

The recording session keeps count of special effects applied to the playing stream

BOOL_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 error code meaning

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.