libfishsound
1.0.1
include
fishsound
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
92
typedef
struct
{
94
char
*
name
;
95
97
char
*
value
;
98
}
FishSoundComment
;
99
100
#ifdef __cplusplus
101
extern
"C"
{
102
#endif
103
111
const
char
*
112
fish_sound_comment_get_vendor
(
FishSound
* fsound);
113
114
121
const
FishSoundComment
*
122
fish_sound_comment_first
(
FishSound
* fsound);
123
131
const
FishSoundComment
*
132
fish_sound_comment_next
(
FishSound
* fsound,
const
FishSoundComment
* comment);
133
143
const
FishSoundComment
*
144
fish_sound_comment_first_byname
(
FishSound
* fsound,
char
* name);
145
156
const
FishSoundComment
*
157
fish_sound_comment_next_byname
(
FishSound
* fsound,
158
const
FishSoundComment
* comment);
159
168
int
169
fish_sound_comment_add
(
FishSound
* fsound,
FishSoundComment
* comment);
170
180
int
181
fish_sound_comment_add_byname
(
FishSound
* fsound,
const
char
* name,
182
const
char
* value);
183
193
int
194
fish_sound_comment_remove
(
FishSound
* fsound,
FishSoundComment
* comment);
195
204
int
205
fish_sound_comment_remove_byname
(
FishSound
* fsound,
char
* name);
206
207
#ifdef __cplusplus
208
}
209
#endif
210
211
#endif
/* __FISH_SOUND_COMMENTS_H__ */
fish_sound_comment_first
const FishSoundComment * fish_sound_comment_first(FishSound *fsound)
Retrieve the first comment.
fish_sound_comment_first_byname
const FishSoundComment * fish_sound_comment_first_byname(FishSound *fsound, char *name)
Retrieve the first comment with a given name.
fish_sound_comment_next_byname
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.
fish_sound_comment_remove_byname
int fish_sound_comment_remove_byname(FishSound *fsound, char *name)
Remove all comments with a given name.
fish_sound_comment_add
int fish_sound_comment_add(FishSound *fsound, FishSoundComment *comment)
Add a comment.
fish_sound_comment_get_vendor
const char * fish_sound_comment_get_vendor(FishSound *fsound)
Retrieve the vendor string.
fish_sound_comment_next
const FishSoundComment * fish_sound_comment_next(FishSound *fsound, const FishSoundComment *comment)
Retrieve the next comment.
fish_sound_comment_remove
int fish_sound_comment_remove(FishSound *fsound, FishSoundComment *comment)
Remove a comment.
fish_sound_comment_add_byname
int fish_sound_comment_add_byname(FishSound *fsound, const char *name, const char *value)
Add a comment by name and value.
fishsound.h
The libfishsound C API.
FishSound
void * FishSound
An opaque handle to a FishSound.
Definition:
fishsound.h:433
FishSoundComment
A comment.
Definition:
comments.h:92
FishSoundComment::value
char * value
The value of the comment, as UTF-8.
Definition:
comments.h:97
FishSoundComment::name
char * name
The name of the comment, eg.
Definition:
comments.h:94
Generated by
1.9.4