Copyright © 2008-2015 MultiMedia Soft

TagsEditor.ID3V2_EventTimingsFrameEventAdd method

Previous pageReturn to chapter overviewNext page

Remarks

 

Adds a new timing event, also known as "cue point", to insert inside the event timing frame (ETCO) of the ID3V2 tag.

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.ID3V2_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 ID3V2_EventTimingsFrameEventAdd (

nEventTimingType as enumId3v2EventTimingTypes,

nPositionInMs as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes ID3V2_EventTimingsFrameEventAdd (

enumId3v2EventTimingTypes nEventTimingType,

nPositionInMs nIndex

);


 

[C++]

public: enumErrorCodes ID3V2_EventTimingsFrameEventAdd (

enumId3v2EventTimingTypes nEventTimingType,

nPositionInMs nIndex

);


 

Parameter

Description

 

 

nEventTimingType

Value representing the type of event timing.

The value can be in the range from 0 to 254; some value is already predefined by the ID3V2 standard, other are reserved for future uses.

 

Supported predefined values are the following:

Mnemonic Value

Value

Meaning

ID3V2_ETCO_Padding

0

Padding

ID3V2_ETCO_End_of_initial_silence

1

End of initial silence

ID3V2_ETCO_Intro_start

2

Intro start

ID3V2_ETCO_Main_part_start

3

Main part start

ID3V2_ETCO_Outro_start

4

Outro start

ID3V2_ETCO_Outro_end

5

Outro end

ID3V2_ETCO_Verse_start

6

Verse start

ID3V2_ETCO_Refrain_start

7

Refrain start

ID3V2_ETCO_Interlude_start

8

Interlude start

ID3V2_ETCO_Theme_start

9

Theme start

ID3V2_ETCO_Variation_start

10

Variation start

ID3V2_ETCO_Key_change

11

Key change

ID3V2_ETCO_Time_change

12

Time change

ID3V2_ETCO_Momentary_unwanted_noise

13

Momentary unwanted noise (Snap, Crackle and Pop)

ID3V2_ETCO_Sustained_noise

14

Sustained noise

ID3V2_ETCO_Sustained_noise_end

15

Sustained noise end

ID3V2_ETCO_Intro_end

16

Intro end

ID3V2_ETCO_Main_part_end

17

Main part end

ID3V2_ETCO_Verse_end

18

Verse end

ID3V2_ETCO_Refrain_end

19

Refrain end

ID3V2_ETCO_Theme_end

20

Theme end

ID3V2_ETCO_Profanity

21

Profanity

ID3V2_ETCO_Profanity_end

22

Profanity end

ID3V2_ETCO_Audio_end_start_of_silence

253

Audio end - start of silence

ID3V2_ETCO_Audio_file_end

254

Audio file end

 

Not predefined values and/or reserved for future uses are the following:

Values range

Meaning

from 23 to 223

Reserved for future use

from 224 to 239

Not predefined synch 0-15 (0-F)

from 240 to 252

Reserved for future use

nPositionInMs

Position of the event timing expressed in milliseconds.

NOTE: Although the ID3V2 standard supports positions expressed in frames, this version of the component only allows entering the position in milliseconds.

 

 

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.