libfishsound 1.0.0
comments.h
Go to the documentation of this file.
1/*
2 Copyright (C) 2003 Commonwealth Scientific and Industrial Research
3 Organisation (CSIRO) Australia
4
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
7 are met:
8
9 - Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11
12 - Redistributions in binary form must reproduce the above copyright
13 notice, this list of conditions and the following disclaimer in the
14 documentation and/or other materials provided with the distribution.
15
16 - Neither the name of CSIRO Australia nor the names of its
17 contributors may be used to endorse or promote products derived from
18 this software without specific prior written permission.
19
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR
24 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31*/
32
33#ifndef __FISH_SOUND_COMMENT_H__
34#define __FISH_SOUND_COMMENT_H__
35
87#include <fishsound/fishsound.h>
88
92typedef struct {
94 char * name;
95
97 char * value;
99
100#ifdef __cplusplus
101extern "C" {
102#endif
103
111const char *
113
114
121const FishSoundComment *
123
131const FishSoundComment *
133
143const FishSoundComment *
145
156const FishSoundComment *
158 const FishSoundComment * comment);
159
168int
170
180int
181fish_sound_comment_add_byname (FishSound * fsound, const char * name,
182 const char * value);
183
193int
195
204int
206
207#ifdef __cplusplus
208}
209#endif
210
211#endif /* __FISH_SOUND_COMMENTS_H__ */
const FishSoundComment * fish_sound_comment_first(FishSound *fsound)
Retrieve the first comment.
const FishSoundComment * fish_sound_comment_first_byname(FishSound *fsound, char *name)
Retrieve the first comment with a given name.
const FishSoundComment * fish_sound_comment_next_byname(FishSound *fsound, const FishSoundComment *comment)
Retrieve the next comment following and with the same name as a given comment.
int fish_sound_comment_remove_byname(FishSound *fsound, char *name)
Remove all comments with a given name.
int fish_sound_comment_add(FishSound *fsound, FishSoundComment *comment)
Add a comment.
const char * fish_sound_comment_get_vendor(FishSound *fsound)
Retrieve the vendor string.
const FishSoundComment * fish_sound_comment_next(FishSound *fsound, const FishSoundComment *comment)
Retrieve the next comment.
int fish_sound_comment_remove(FishSound *fsound, FishSoundComment *comment)
Remove a comment.
int fish_sound_comment_add_byname(FishSound *fsound, const char *name, const char *value)
Add a comment by name and value.
The libfishsound C API.
void * FishSound
An opaque handle to a FishSound.
Definition fishsound.h:433
A comment.
Definition comments.h:92
char * value
The value of the comment, as UTF-8.
Definition comments.h:97
char * name
The name of the comment, eg.
Definition comments.h:94