Copyright © 2005-2018 MultiMedia Soft

SoundGenerator.StreamElementOffsetGet 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 StreamElementOffsetGet (

nPlayerIndex as Int16,

nUniqueId as Int32,

ByRef nOffsetMs as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes StreamElementOffsetGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

ref Int32 nOffsetMs

);


 

[C++]

public: enumErrorCodes StreamElementOffsetGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

Int32 __gc *nOffsetMs

);


 

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

nOffsetMs

Reference to a value that, on return from the method call, will contain the offset of the sound element, expressed in milliseconds

 

 

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.