RecordedSound.SeekPlayPosition method

RecordedSound.SeekPlayPosition method

Remarks

Seeks the current playback session to the specified position.

This method will only work with a playing or paused playback session: if you need to start the playback session from a certain position, use the RecordedSound.PlayRange method instead of the RecordedSound.Play method.

For further details about recorded sound methods refer to the RecordedSound class section.

For further details see the How to perform a recording session section.

Syntax

[Visual Basic]

Public Function SeekPlayPosition (

nPosition as Int32,

nScaleUnits as enumScaleUnits

) as enumErrorCodes

[C#]

public enumErrorCodes SeekPlayPosition (

Int32 nPosition,

enumScaleUnits nScaleUnits

);

[C++]

public: enumErrorCodes SeekPlayPosition (

Int32 nPosition,

enumScaleUnits nScaleUnits

);

Parameter

Description

nPosition

Number representing the position to reach; it's value depends upon the value of the nScaleUnits parameter

nScaleUnits

The unit used to define the nPosition parameter.

Supported values are the following:

Mnemonic constant	Value	Meaning
SCALE_MILLISECONDS	0	Milliseconds
SCALE_SECONDS	1	Seconds
SCALE_MINUTES	2	Minutes
SCALE_HOURS	3	Hours
SCALE_PERCENTAGE	4	Percentage (expressed with values from 0 to 100)

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.

Return to Table of contents