Copyright © 2005-2018 MultiMedia Soft

SoundGenerator.StreamElementTypeGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the offset of the given sound element respect to the beginning of the audio stream.

 

For further details about sound generation see the SoundGenerator object and the How to generate wave tones, noises, DTMF tones and text to speech tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function StreamElementTypeGet (

nPlayerIndex as Int16,

nUniqueId as Int32,

nType as enumSoundGeneratorTypes

) as enumErrorCodes


 

[C#]

public enumErrorCodes StreamElementTypeGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

ref enumSoundGeneratorTypes nType

);


 

[C++]

public: enumErrorCodes StreamElementTypeGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

enumSoundGeneratorTypes __gc *nType

);


 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

nUniqueId

The unique identifier of the element previously returned by one of the following calls:

- SoundGenerator.StreamChannelAddTone

- SoundGenerator.StreamChannelAddNoise

- SoundGenerator.StreamChannelAddDtmfString

- SoundGenerator.StreamChannelAddSlidingTone

- SoundGenerator.StreamChannelAddSpeechFromFile

- SoundGenerator.StreamChannelAddSpeechFromString

- SoundGenerator.StreamChannelElementUniqueIdGet

nType

Reference to a value that, on return from the method call, will contain the type of the sound element.

Supported values are the following:

Mnemonic Value

Value

Meaning

SOUND_GEN_TYPE_WAVETONE

0

Wave tone element added through a call to the SoundGenerator.StreamChannelAddTone method.

SOUND_GEN_TYPE_NOISE

1

Noise element added through a call to the SoundGenerator.StreamChannelAddNoise method.

SOUND_GEN_TYPE_SLIDING_WAVETONE

2

Sliding wave tone element added through a call to the SoundGenerator.StreamChannelAddSlidingTone method.

SOUND_GEN_TYPE_DTMF

3

DTMF string element added through a call to the SoundGenerator.StreamChannelAddDtmfString method.

SOUND_GEN_TYPE_TEXT_TO_SPEECH

4

Text to speech element added through a call to the SoundGenerator.StreamChannelAddSpeechFromFile or SoundGenerator.StreamChannelAddSpeechFromString methods.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.