Comments Handling

Functions for handling comments
These functions make it possible to add comments and pictures to Ogg Opus files.
OPE_EXPORT OggOpusComments *	ope_comments_create (void)
	Create a new comments object. More...
OPE_EXPORT OggOpusComments *	ope_comments_copy (OggOpusComments *comments)
	Create a deep copy of a comments object. More...
OPE_EXPORT void	ope_comments_destroy (OggOpusComments *comments)
	Destroys a comments object. More...
OPE_EXPORT int	ope_comments_add (OggOpusComments *comments, const char *tag, const char *val)
	Add a comment. More...
OPE_EXPORT int	ope_comments_add_string (OggOpusComments *comments, const char *tag_and_val)
	Add a comment as a single tag=value string. More...
OPE_EXPORT int	ope_comments_add_picture (OggOpusComments *comments, const char *filename, int picture_type, const char *description)
	Add a picture from a file. More...
OPE_EXPORT int	ope_comments_add_picture_from_memory (OggOpusComments *comments, const char *ptr, size_t size, int picture_type, const char *description)
	Add a picture already in memory. More...

Detailed Description

Function Documentation

ope_comments_create()

OPE_EXPORT OggOpusComments* ope_comments_create

(

void

)

Create a new comments object.

Returns

Newly-created comments object.

ope_comments_copy()

OPE_EXPORT OggOpusComments* ope_comments_copy

(

OggOpusComments *

comments

)

Create a deep copy of a comments object.

Parameters

comments

Comments object to copy

Returns

Deep copy of input.

ope_comments_destroy()

OPE_EXPORT void ope_comments_destroy

(

OggOpusComments *

comments

)

Destroys a comments object.

Parameters

comments

Comments object to destroy

ope_comments_add()

OPE_EXPORT int ope_comments_add	(	OggOpusComments *	comments,
		const char *	tag,
		const char *	val
	)

Add a comment.

Parameters

[in,out]	comments	Where to add the comments
	tag	Tag for the comment (must not contain = char)
	val	Value for the tag

Returns

Error code

ope_comments_add_string()

OPE_EXPORT int ope_comments_add_string	(	OggOpusComments *	comments,
		const char *	tag_and_val
	)

Add a comment as a single tag=value string.

Parameters

[in,out]	comments	Where to add the comments
	tag_and_val	string of the form tag=value (must contain = char)

Returns

Error code

ope_comments_add_picture()

OPE_EXPORT int ope_comments_add_picture	(	OggOpusComments *	comments,
		const char *	filename,
		int	picture_type,
		const char *	description
	)

Add a picture from a file.

Parameters

[in,out]	comments	Where to add the comments
	filename	File name for the picture
	picture_type	Type of picture (-1 for default)
	description	Description (NULL means no comment)

Returns

Error code

ope_comments_add_picture_from_memory()

OPE_EXPORT int ope_comments_add_picture_from_memory	(	OggOpusComments *	comments,
		const char *	ptr,
		size_t	size,
		int	picture_type,
		const char *	description
	)

Add a picture already in memory.

Parameters

[in,out]	comments	Where to add the comments
	ptr	Pointer to picture in memory
	size	Size of picture pointed to by ptr
	picture_type	Type of picture (-1 for default)
	description	Description (NULL means no comment)

Returns

Error code