Copyright © 2011-2018 MultiMedia Soft

TagsEditor.WAV_CartChunkTimeMarkerFieldSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Modifies a time marker field of the CART chunk. Existing time markers can be obtained through the TagsEditor.WAV_CartChunkTimeMarkerFieldGet method.

The modification only happens in memory and not directly into the original sound file: in order to store modifications inside the file you need to call the TagsEditor.WAV_SaveChanges method.

 

For further details about methods related to tags editing refer to the TagsEditorMan class.

For details about the editing of tags see the How to edit tag info in sound files tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function WAV_CartChunkTimeMarkerFieldSet (

nFieldId as enumCartChunkTimeMarkerField,

strFourccId as String

nPositionInSamples as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes WAV_CartChunkTimeMarkerFieldSet (

enumCartChunkTimeMarkerField nFieldId,

string strFourccId,

Int32 nPositionInSamples

);


 

[C++]

public: enumErrorCodes WAV_CartChunkTimeMarkerFieldSet (

enumCartChunkTimeMarkerField nFieldId,

string strFourccId,

Int32 nPositionInSamples

);


 

Parameter

Description

 

 

nFieldId

Identifier of the field to get.

Supported values are the following:

Mnemonic Value

Value

Meaning

WAV_CART_CHUNK_TIME_MARKER1

0

Time marker 1

WAV_CART_CHUNK_TIME_MARKER2

1

Time marker 2

WAV_CART_CHUNK_TIME_MARKER3

2

Time marker 3

WAV_CART_CHUNK_TIME_MARKER4

3

Time marker 4

WAV_CART_CHUNK_TIME_MARKER5

4

Time marker 5

WAV_CART_CHUNK_TIME_MARKER6

5

Time marker 6

WAV_CART_CHUNK_TIME_MARKER7

6

Time marker 7

WAV_CART_CHUNK_TIME_MARKER8

7

Time marker 8

strFourccId

String of 4 characters (also known as FOURCC) containing the identifier of the time marker.

The following table summarizes the basic timer types:

Timer ID

Description

Start-End

Enumerated

Multiples

XXX (*)

Custom timer

No

No

Yes

SEGx (**)

Segue timer

Yes

Yes

Yes

AUDx (**)

Audio boundary

Yes

No

No

INTx (**)

Introduction

Yes

Yes

Yes

OUTx (**)

Epilog

Yes

Yes

Yes

SECx (**)

Secondary

Yes

Yes

Yes

TERx (**)

Tertiary

Yes

Yes

Yes

MRKx (**)

Generic marker

No

Yes

Yes

EODx (**)

End-of-data

No

No

Yes

 

(*) You can define your own timer ID by replacing the XXX with other ASCII characters.

(**) Timers may be qualified in one of following ways:

 

1.as start or end timers, by replacing the "x" character with a lower case ASCII letter "s" for a start timer or a lower case ASCII letter "e" for an end timer; for example, the timer identification AUDs designates the start of audio following silence, while AUDe designates the end of the audio segment.
2.as enumerated timers, by replacing the "x" character with an ASCII numeric character; for example, SEC1 may be designated secondary timer number 1, SEC2 may be secondary number 2, and so on
3.as multiple timers, by having multiple instances of the same timer ID; one may have, for example, multiple instances of MRK. Custom timers belong in this category.

 

NOTE: Whatever category of timer you choose, it's recommended that the string is exactly 4 characters long: if the identifier should be shorter, pad  missing characters with blanks.

nPositionInSamples

Value representing the time marker position expressed in samples.

 

 

Return value

 

Value

Meaning

 

 

Negative value

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

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.