1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
|
/*
* Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __TIZEN_VIDEO_META_H__
#define __TIZEN_VIDEO_META_H__
#include <media_content_type.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @addtogroup CAPI_CONTENT_MEDIA_VIDEO_META_MODULE
* @{
*/
/**
* @brief Clones video metadata.
* @details This function copies the video metadata handle from a source to
* destination.
* @remark The destination handle must be released with video_meta_destroy() by you.
*
* @param [out] dst A destination handle to video metadata
* @param [in] src The source handle to video metadata
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @see video_meta_destroy()
*/
int video_meta_clone(video_meta_h *dst, video_meta_h src);
/**
* @brief Destroys video metadata.
* @details Function frees all resources related to video metadata handle. This handle
* no longer can be used to perform any operation. A new handle has to
* be created before the next use.
*
* @param [in] video The handle to video metadata
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Get copy of video metadata handle by calling video_meta_clone()
* @see video_meta_clone()
*
*/
int video_meta_destroy(video_meta_h video);
/**
* @brief Gets id of media of given video metadata.
*
* @remarks @a media id must be released with free() by you.
*
* @param [in] video The handle to video metadata
* @param [out] media_id The id of the video
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_media_id(video_meta_h video, char **media_id);
/**
* @brief Gets the video's title.
*
* @remarks @a title must be released with free() by you.
*
* @param [in] video The handle to video metadata
* @param [out] title The title of video metadata
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_title(video_meta_h video, char **title);
/**
* @brief Gets the video's album.
* If the value is an empty string, the method returns "Unknown".
*
* @remarks @a album must be released with free() by you.
*
* @param [in] video The handle to video metadata
* @param [out] album The video album or NULL
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_album(video_meta_h video, char **album);
/**
* @brief Gets the video's artist.
* If the value is an empty string, the method returns "Unknown".
*
* @remarks @a artist must be released with free() by you.
*
* @param [in] video The handle to video metadata
* @param [out] artist The artist of video metadata
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_artist(video_meta_h video, char **artist);
/**
* @brief Gets the video's genre.
* If the value is an empty string, the method returns "Unknown".
*
* @remarks @a genre must be released with free() by you.
*
* @param [in] video The handle to video metadata
* @param [out] genre The genre of video metadata
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_genre(video_meta_h video, char **genre);
/**
* @brief Gets the video's composer.
* If the value is an empty string, the method returns "Unknown".
*
* @remarks @a composer must be released with free() by you.
*
* @param [in] video The handle to video metadata
* @param [out] composer The composer of video metadata
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_composer(video_meta_h video, char **composer);
/**
* @brief Gets the video's year.
* If the value is an empty string, the method returns "Unknown".
*
* @remarks @a year must be released with free() by you.
*
* @param [in] video The handle to video metadata
* @param [out] year The year of video metadata
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_year(video_meta_h video, char **year);
/**
* @brief Gets the video's recorded_date.
*
* @remarks @a recorded_date must be released with free() by you.
*
* @param [in] video The handle to video metadata
* @param [out] recorded_date The recorded_date of video metadata
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_recorded_date(video_meta_h video, char **recorded_date);
/**
* @brief Gets the video's copyright.
*
* @remarks @a copyright must be released with free() by you.
*
* @param [in] video The handle to video metadata
* @param [out] copyright The copyright of video metadata
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_copyright(video_meta_h video, char **copyright);
/**
* @brief Gets the video's track number.
* If the value is an empty string, the method returns "Unknown".
*
* @remarks @a track_num must be released with free() by you.
*
* @param [in] video The handle to video metadata
* @param [out] track_num The track number of video metadata
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_track_num(video_meta_h video, char **track_num);
/**
* @brief Gets the video's bit rate.
*
* @remarks @a bit_rate must be released with free() by you.
*
* @param [in] video The handle to video metadata
* @param [out] bit_rate The bit rate of video metadata
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_bit_rate(video_meta_h video, int *bit_rate);
/**
* @brief Gets duration of video metadata.
*
* @param [in] video The handle to video metadata
* @param [out] duration The video duration in milliseconds
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int video_meta_get_duration(video_meta_h video, int *duration);
/**
* @brief Gets the video's width in pixels.
*
* @param [in] video The handle to video metadata
* @param [out] width The video width in pixels
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int video_meta_get_width(video_meta_h video, int *width);
/**
* @brief Gets the video's height in pixels.
*
* @param [in] video The handle to video metadata
* @param [out] height The video height in pixels
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int video_meta_get_height(video_meta_h video, int *height);
/**
* @brief Gets the video's played count.
*
* @param [in] video The handle to video metadata
* @param [out] played_count The number of played
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int video_meta_get_played_count(video_meta_h video, int *played_count);
/**
* @brief Gets the video's time last played parameter.
*
* @param [in] video The handle to video metadata
* @param [out] played_time The time last played in the video
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int video_meta_get_played_time(video_meta_h video, time_t *played_time);
/**
* @brief Gets the video's position played parameter.
* @details Function returns video's elapsed playback time parameter as period
* starting from the beginning of the movie.
*
* @param [in] video The handle to video metadata
* @param [out] played_position The position from the beginning of the video (in milliseconds)
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int video_meta_get_played_position(video_meta_h video, int *played_position);
/**
* @brief Sets the video's played count.
*
* @param [in] video The handle to video metadata
* @param [in] played_count The number of played
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @post video_meta_update_to_db()
*/
int video_meta_set_played_count(video_meta_h video, int played_count);
/**
* @brief Sets the video's time last played parameter.
*
* @param [in] video The handle to video metadata
* @param [in] played_time The time last played in the video
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @post video_meta_update_to_db()
*/
int video_meta_set_played_time(video_meta_h video, time_t played_time);
/**
* @brief Sets the video's position played parameter.
* @details Function returns video's elapsed playback time parameter as period
* starting from the beginning of the movie.
*
* @param [in] video The handle to video metadata
* @param [in] played_position The position from the beginning of the video (in milliseconds)
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @post video_meta_update_to_db()
*/
int video_meta_set_played_position(video_meta_h video, int played_position);
/**
* @brief Updates the video to the media database.
*
* @details The function updates the given video meta in the media database. The function should be called after any change in video attributes, to be updated to the media
* database. For example, after using video_meta_get_played_time() for setting the played time of the video, video_meta_update_to_db() function should be called so as to update
* the given video attibutes in the media database.
*
* @param[in] image The handle to image
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @pre This function requires opened connection to content service by media_content_connect().
* @see media_content_connect()
* @see video_meta_set_played_time()
* @see video_meta_set_played_count()
* @see video_meta_set_played_position()
*/
int video_meta_update_to_db(video_meta_h video);
/**
*@}
*/
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /*__TIZEN_VIDEO_META_H__*/
|
