Copyright © 2005-2023 MultiMedia Soft

SoundComposer.SessionCreate method

Previous pageReturn to chapter overviewNext page

Remarks

 

Creates a new and empty multi-channel sound composer session that may host various sound files on allocated channels.

 

For further details about sound composing see the SoundComposerMan class and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function SessionCreate (

nPlayerIndex as Int16,

nSampleRate as Int32,

nChannels as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes SessionCreate (

Int16 nPlayerIndex,

Int32 nSampleRate,

Int32 nChannels

);


 

[C++]

public: enumErrorCodes SessionCreate (

Int16 nPlayerIndex,

Int32 nSampleRate,

Int32 nChannels

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the player that owns the sound composer session

nSampleRate

Sample rate of the stream, e.g. 44100

nChannels

Number of channels of the audio stream.

Supported values are the following:

Value

Meaning

1

Mono audio stream

2

Stereo audio stream

4

3.1 audio stream

6

5.1 audio stream

8

7.1 audio stream

 

 

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.