Copyright © 2011-2018 MultiMedia Soft

TagsEditor.OGG_TextFrameSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets contents of a specific text-based frame of the OGG Vorbis tag. Current contents can be retrieved through the TagsEditor.OGG_TextFrameGet 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.OGG_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 OGG_TextFrameSet (

nFrameId as enumOggFrames,

strText as String

) as enumErrorCodes


 

[C#]

public enumErrorCodes OGG_TextFrameSet (

enumOggFrames nFrameId,

string strText

);


 

[C++]

public: enumErrorCodes OGG_TextFrameSet (

enumOggFrames nFrameId,

string strText

);


 

Parameter

Description

 

 

nFrameId

Identifier of the tag frame to set.

Supported values are the following:

Mnemonic Value

Value

Meaning

OGG_FRAME_Album

0

Album

OGG_FRAME_Artist

1

Artist

OGG_FRAME_Comment

2

Comment

OGG_FRAME_Contact

3

Contact

OGG_FRAME_Copyright

4

Copyright

OGG_FRAME_Date

5

Date

OGG_FRAME_Description

6

Description

OGG_FRAME_Genre

7

Genre

OGG_FRAME_ISRC

8

International Standard Recording Code (ISRC)

OGG_FRAME_License

9

License

OGG_FRAME_Location

10

Location

OGG_FRAME_Organization

11

Organization

OGG_FRAME_Performer

12

Performer

OGG_FRAME_Title

13

Title

OGG_FRAME_Track

14

Track

OGG_FRAME_Vendor

15

Vendor

OGG_FRAME_Version

16

Version

 

User-defined frames can be added and retrieved through the TagsEditor.OGG_UserFrameSet and TagsEditor.OGG_UserFrameGet methods.

strText

String of text to enter inside the given frame

 

 

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.