2 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 namespace Tizen.Content.MediaContent
22 /// Provides the column names that can be used for Select and Count commands.
24 /// <seealso cref="SelectArguments"/>
25 /// <seealso cref="CountArguments"/>
26 /// <seealso cref="QueryArguments.FilterExpression"/>
27 /// <seealso cref="SelectArguments.SortOrder"/>
28 /// <seealso cref="AlbumCommand.Count(CountArguments)"/>
29 /// <seealso cref="AlbumCommand.CountMember(int, CountArguments)"/>
30 /// <seealso cref="AlbumCommand.Select(SelectArguments)"/>
31 /// <seealso cref="AlbumCommand.SelectMember(int, SelectArguments)"/>
32 /// <seealso cref="BookmarkCommand.Count(CountArguments)"/>
33 /// <seealso cref="BookmarkCommand.Select(SelectArguments)"/>
34 /// <seealso cref="FaceInfoCommand.Select(SelectArguments)"/>
35 /// <seealso cref="FolderCommand.Count(CountArguments)"/>
36 /// <seealso cref="FolderCommand.CountMedia(string, CountArguments)"/>
37 /// <seealso cref="FolderCommand.Select(SelectArguments)"/>
38 /// <seealso cref="FolderCommand.SelectMedia(string, SelectArguments)"/>
39 /// <seealso cref="MediaInfoCommand.CountMedia(CountArguments)"/>
40 /// <seealso cref="MediaInfoCommand.SelectMedia(SelectArguments)"/>
41 /// <seealso cref="PlaylistCommand.Count(CountArguments)"/>
42 /// <seealso cref="PlaylistCommand.Select(SelectArguments)"/>
43 /// <seealso cref="PlaylistCommand.CountMember(int, CountArguments)"/>
44 /// <seealso cref="PlaylistCommand.SelectMember(int, SelectArguments)"/>
45 /// <seealso cref="TagCommand.Count(CountArguments)"/>
46 /// <seealso cref="TagCommand.CountMedia(int, CountArguments)"/>
47 /// <seealso cref="TagCommand.Select(SelectArguments)"/>
48 /// <seealso cref="TagCommand.SelectMedia(int, SelectArguments)"/>
49 /// <since_tizen> 4 </since_tizen>
50 public static class MediaInfoColumns
53 /// Gets the column name for the ID of media.
55 /// <value>The column name for the ID of media.</value>
56 /// <remarks>The value type is string.</remarks>
57 /// <seealso cref="MediaInfo.Id"/>
58 /// <since_tizen> 4 </since_tizen>
59 public static string Id => "MEDIA_ID";
62 /// Gets the column name for the path of media.
64 /// <value>The column name for the file path of media.</value>
65 /// <remarks>The value type is string.</remarks>
66 /// <seealso cref="MediaInfo.Path"/>
67 /// <since_tizen> 4 </since_tizen>
68 public static string Path => "MEDIA_PATH";
71 /// Gets the column name for the display name of media.
73 /// <value>The column name for the display name of media.</value>
74 /// <remarks>The value type is string.</remarks>
75 /// <seealso cref="MediaInfo.DisplayName"/>
76 /// <since_tizen> 4 </since_tizen>
77 public static string DisplayName => "MEDIA_DISPLAY_NAME";
80 /// Gets the column name for the type of media.
82 /// <value>The column name for the type of media.</value>
84 /// The value type is integer.
85 /// The value should be an integer that is one of the <see cref="MediaContent.MediaType"/> values.
87 /// <seealso cref="MediaInfo.MediaType"/>
88 /// <since_tizen> 4 </since_tizen>
89 public static string MediaType => "MEDIA_TYPE";
92 /// Gets the column name for the mime type of media.
94 /// <value>The column name for the mime type of media.</value>
95 /// <remarks>The value type is string.</remarks>
96 /// <seealso cref="MediaInfo.MimeType"/>
97 /// <since_tizen> 4 </since_tizen>
98 public static string MimeType => "MEDIA_MIME_TYPE";
101 /// Gets the column name for the file size of media.
103 /// <value>The column name for the file size of media.</value>
104 /// <remarks>The value type is integer.</remarks>
105 /// <seealso cref="MediaInfo.FileSize"/>
106 /// <since_tizen> 4 </since_tizen>
107 public static string FileSize => "MEDIA_SIZE";
110 /// Gets the column name for the date added of media.
112 /// <value>The column name for the date added of media.</value>
114 /// The value type is integer.
115 /// <see cref="DateTimeOffset"/> needs to be converted into the unix time.
117 /// <seealso cref="MediaInfo.DateAdded"/>
118 /// <seealso cref="DateTimeOffset.ToUnixTimeSeconds"/>
119 /// <since_tizen> 4 </since_tizen>
120 public static string DateAdded => "MEDIA_ADDED_TIME";
123 /// Gets the column name for the date modified of media.
125 /// <value>The column name for the date modified of media.</value>
127 /// The value type is integer.
128 /// <see cref="DateTimeOffset"/> needs to be converted into the unix time.
130 /// <seealso cref="MediaInfo.DateModified"/>
131 /// <seealso cref="DateTimeOffset.ToUnixTimeSeconds"/>
132 /// <since_tizen> 4 </since_tizen>
133 public static string DateModified => "MEDIA_MODIFIED_TIME";
136 /// Gets the column name for the timeline of media.
138 /// <value>The column name for the timeline of media.</value>
140 /// The value type is integer.
141 /// <see cref="DateTimeOffset"/> needs to be converted into the unix time.
143 /// <seealso cref="MediaInfo.Timeline"/>
144 /// <seealso cref="DateTimeOffset.ToUnixTimeSeconds"/>
145 /// <since_tizen> 4 </since_tizen>
146 public static string Timeline => "MEDIA_TIMELINE";
149 /// Gets the column name for the thumbnail path of media.
151 /// <value>The column name for the thumbnail path of media.</value>
153 /// The value type is string.
155 /// <seealso cref="MediaInfo.ThumbnailPath"/>
156 /// <since_tizen> 4 </since_tizen>
157 public static string ThumbnailPath => "MEDIA_THUMBNAIL_PATH";
160 /// Gets the column name for the title of media.
162 /// <value>The column name for the title of media.</value>
164 /// The value type is string.
166 /// <seealso cref="MediaInfo.Title"/>
167 /// <since_tizen> 4 </since_tizen>
168 public static string Title => "MEDIA_TITLE";
171 /// Gets the column name for the album of media.
173 /// <value>The column name for the album of media.</value>
175 /// The value type is string.
177 /// <seealso cref="AudioInfo.Album"/>
178 /// <since_tizen> 4 </since_tizen>
179 public static string Album => "MEDIA_ALBUM";
182 /// Gets the column name for the artist of media.
184 /// <value>The column name for the artist of media.</value>
186 /// The value type is string.
188 /// <seealso cref="AudioInfo.Artist"/>
189 /// <seealso cref="VideoInfo.Artist"/>
190 /// <since_tizen> 4 </since_tizen>
191 public static string Artist => "MEDIA_ARTIST";
194 /// Gets the column name for the album artist of media.
196 /// <value>The column name for the album artist of media.</value>
198 /// The value type is string.
200 /// <seealso cref="AudioInfo.AlbumArtist"/>
201 /// <seealso cref="VideoInfo.AlbumArtist"/>
202 /// <since_tizen> 4 </since_tizen>
203 public static string AlbumArtist => "MEDIA_ALBUM_ARTIST";
206 /// Gets the column name for the genre of media.
208 /// <value>The column name for the genre of media.</value>
210 /// The value type is string.
212 /// <seealso cref="AudioInfo.Genre"/>
213 /// <seealso cref="VideoInfo.Genre"/>
214 /// <since_tizen> 4 </since_tizen>
215 public static string Genre => "MEDIA_GENRE";
218 /// Gets the column name for the composer of media.
220 /// <value>The column name for the composer of media.</value>
222 /// The value type is string.
224 /// <seealso cref="AudioInfo.Composer"/>
225 /// <seealso cref="VideoInfo.Composer"/>
226 /// <since_tizen> 4 </since_tizen>
227 public static string Composer => "MEDIA_COMPOSER";
230 /// Gets the column name for the year of media.
232 /// <value>The column name for the year of media.</value>
234 /// The value type is string.
236 /// <seealso cref="AudioInfo.Year"/>
237 /// <seealso cref="VideoInfo.Year"/>
238 /// <since_tizen> 4 </since_tizen>
239 public static string Year => "MEDIA_YEAR";
242 /// Gets the column name for the date recorded of media.
244 /// <value>The column name for the date recorded of media.</value>
246 /// The value type is string.
248 /// <seealso cref="AudioInfo.DateRecorded"/>
249 /// <seealso cref="VideoInfo.DateRecorded"/>
250 /// <since_tizen> 4 </since_tizen>
251 public static string DateRecorded => "MEDIA_RECORDED_DATE";
254 /// Gets the column name for the track number of media.
256 /// <value>The column name for the track number of media.</value>
258 /// The value type is string.
260 /// <seealso cref="AudioInfo.TrackNumber"/>
261 /// <seealso cref="VideoInfo.TrackNumber"/>
262 /// <since_tizen> 4 </since_tizen>
263 public static string TrackNumber => "MEDIA_TRACK_NUM";
266 /// Gets the column name for the duration of media.
268 /// <value>The column name for the duration of media.</value>
270 /// The value type is integer.
272 /// <seealso cref="AudioInfo.Duration"/>
273 /// <seealso cref="VideoInfo.Duration"/>
274 /// <since_tizen> 4 </since_tizen>
275 public static string Duration => "MEDIA_DURATION";
278 /// Gets the column name for the longitude of media.
280 /// <value>The column name for the longitude of media.</value>
282 /// The value type is real.
284 /// <seealso cref="MediaInfo.Longitude"/>
285 /// <since_tizen> 4 </since_tizen>
286 public static string Longitude => "MEDIA_LONGITUDE";
289 /// Gets the column name for the latitude of media.
291 /// <value>The column name for the latitude of media.</value>
293 /// The value type is real.
295 /// <seealso cref="MediaInfo.Latitude"/>
296 /// <since_tizen> 4 </since_tizen>
297 public static string Latitude => "MEDIA_LATITUDE";
300 /// Gets the column name for the altitude of media.
302 /// <value>The column name for the altitude of media.</value>
304 /// The value type is real.
306 /// <seealso cref="MediaInfo.Altitude"/>
307 /// <since_tizen> 4 </since_tizen>
308 public static string Altitude => "MEDIA_ALTITUDE";
311 /// Gets the column name for the width of media.
313 /// <value>The column name for the width of media.</value>
315 /// The value type is integer.
317 /// <seealso cref="ImageInfo.Width"/>
318 /// <seealso cref="VideoInfo.Width"/>
319 /// <since_tizen> 4 </since_tizen>
320 public static string Width => "MEDIA_WIDTH";
323 /// Gets the column name for the height of media.
325 /// <value>The column name for the height of media.</value>
327 /// The value type is integer.
329 /// <seealso cref="ImageInfo.Height"/>
330 /// <seealso cref="VideoInfo.Height"/>
331 /// <since_tizen> 4 </since_tizen>
332 public static string Height => "MEDIA_HEIGHT";
335 /// Gets the column name for the date taken of media.
337 /// <value>The column name for the date taken of media.</value>
339 /// The value type is integer.
341 /// <seealso cref="ImageInfo.DateTaken"/>
342 /// <since_tizen> 4 </since_tizen>
343 public static string DateTaken => "MEDIA_DATETAKEN";
346 /// Gets the column name for the favorite status of media.
348 /// <value>The column name for the favorite status of media.</value>
350 /// The value type is integer (1 : true, 0 : false).
352 /// <seealso cref="MediaInfo.IsFavorite"/>
353 /// <since_tizen> 4 </since_tizen>
354 public static string Favorite => "MEDIA_FAVOURITE";
357 /// Gets the column name for the drm of media.
359 /// <value>The column name for the drm of media.</value>
361 /// The value type is integer (1 : true, 0 : false).
363 /// <seealso cref="MediaInfo.IsDrm"/>
364 /// <since_tizen> 4 </since_tizen>
365 public static string IsDrm => "MEDIA_IS_DRM";
369 /// Provides the folder column names that can be used for Select and Count commands.
371 /// <seealso cref="SelectArguments"/>
372 /// <seealso cref="CountArguments"/>
373 /// <seealso cref="QueryArguments.FilterExpression"/>
374 /// <seealso cref="SelectArguments.SortOrder"/>
375 /// <seealso cref="AlbumCommand.Count(CountArguments)"/>
376 /// <seealso cref="AlbumCommand.Select(SelectArguments)"/>
377 /// <since_tizen> 4 </since_tizen>
378 public static class AlbumColumns
381 /// Gets the column name for the name of album.
383 /// <value>The column name for the name of album.</value>
385 /// The value type is string.
387 /// <seealso cref="Album.Name"/>
388 /// <since_tizen> 4 </since_tizen>
389 public static string Name => "MEDIA_ALBUM";
392 /// Gets the column name for the artist of album.
394 /// <value>The column name for the artist of album.</value>
396 /// The value type is string.
398 /// <seealso cref="Album.Artist"/>
399 /// <since_tizen> 4 </since_tizen>
400 public static string Artist => "MEDIA_ARTIST";
404 /// Provides the folder column names that can be used for Select and Count commands.
406 /// <seealso cref="SelectArguments"/>
407 /// <seealso cref="CountArguments"/>
408 /// <seealso cref="QueryArguments.FilterExpression"/>
409 /// <seealso cref="SelectArguments.SortOrder"/>
410 /// <seealso cref="FolderCommand.Count(CountArguments)"/>
411 /// <seealso cref="FolderCommand.Select(SelectArguments)"/>
412 /// <since_tizen> 4 </since_tizen>
413 public static class FolderColumns
416 /// Gets the column name for the ID of folder.
418 /// <value>The column name for the ID of folder.</value>
420 /// The value type is string.
422 /// <seealso cref="Folder.Id"/>
423 /// <since_tizen> 4 </since_tizen>
424 public static string Id => "FOLDER_ID";
427 /// Gets the column name for the path of folder.
429 /// <value>The column name for the path of folder.</value>
431 /// The value type is string.
433 /// <seealso cref="Folder.Path"/>
434 /// <since_tizen> 4 </since_tizen>
435 public static string Path => "FOLDER_PATH";
438 /// Gets the column name for the name of folder.
440 /// <value>The column name for the name of folder.</value>
442 /// The value type is string.
444 /// <seealso cref="Folder.Name"/>
445 /// <since_tizen> 4 </since_tizen>
446 public static string Name => "FOLDER_NAME";
450 /// Provides the playlist column names that can be used for Select and Count commands.
452 /// <seealso cref="SelectArguments"/>
453 /// <seealso cref="CountArguments"/>
454 /// <seealso cref="QueryArguments.FilterExpression"/>
455 /// <seealso cref="SelectArguments.SortOrder"/>
456 /// <seealso cref="PlaylistCommand.Count(CountArguments)"/>
457 /// <seealso cref="PlaylistCommand.Select(SelectArguments)"/>
458 /// <since_tizen> 4 </since_tizen>
459 public static class PlaylistColumns
462 /// Gets the column name for the name of playlist.
464 /// <value>The column name for the name of playlist.</value>
466 /// The value type is string.
468 /// <seealso cref="Playlist.Name"/>
469 /// <since_tizen> 4 </since_tizen>
470 public static string Name => "PLAYLIST_NAME";
473 /// Gets the column name for the ID of playlist.
475 /// <value>The column name for the ID of playlist.</value>
477 /// The value type is integer.
479 /// <seealso cref="Playlist.Id"/>
480 /// <since_tizen> 4 </since_tizen>
481 public static string Id => "PLAYLIST_ID";
484 /// Gets the column name for the member order of playlist.
486 /// <value>The column name for the member order of playlist.</value>
488 /// The value type is integer.
490 /// <seealso cref="PlaylistCommand.UpdatePlayOrder(int, PlayOrder)"/>
491 /// <since_tizen> 4 </since_tizen>
492 public static string MemberOrder => "PLAYLIST_MEMBER_ORDER";
495 /// Gets the column name for the number of members of playlist.
497 /// <value>The column name for the number of members of playlist.</value>
499 /// The value type is integer.
501 /// <seealso cref="PlaylistCommand.AddMember(int, string)"/>
502 /// <seealso cref="PlaylistCommand.RemoveMember(int, int)"/>
503 /// <since_tizen> 4 </since_tizen>
504 public static string Count => "PLAYLIST_MEDIA_COUNT";
508 /// Provides the tag column names that can be used for the <see cref="SelectArguments"/>.
510 /// <seealso cref="SelectArguments"/>
511 /// <seealso cref="CountArguments"/>
512 /// <seealso cref="QueryArguments.FilterExpression"/>
513 /// <seealso cref="SelectArguments.SortOrder"/>
514 /// <seealso cref="MediaInfoCommand.CountTag(string, CountArguments)"/>
515 /// <seealso cref="MediaInfoCommand.SelectTag(string, SelectArguments)"/>
516 /// <seealso cref="TagCommand.Count(CountArguments)"/>
517 /// <seealso cref="TagCommand.CountMedia(int, CountArguments)"/>
518 /// <seealso cref="TagCommand.Select(SelectArguments)"/>
519 /// <seealso cref="TagCommand.SelectMedia(int, SelectArguments)"/>
520 /// <since_tizen> 4 </since_tizen>
521 public static class TagColumns
524 /// Gets the column name for the name of tag.
526 /// <value>The column name for the name of tag.</value>
528 /// The value type is string.
530 /// <seealso cref="Tag.Name"/>
531 /// <since_tizen> 4 </since_tizen>
532 public static string Name => "TAG_NAME";
535 /// Gets the column name for the number of media of tag.
537 /// <value>The column name for the number of media of tag.</value>
539 /// The value type is integer.
541 /// <seealso cref="TagCommand.AddMedia(int, string)"/>
542 /// <seealso cref="TagCommand.RemoveMedia(int, string)"/>
543 /// <since_tizen> 4 </since_tizen>
544 public static string Count => "TAG_MEDIA_COUNT";
547 /// Gets the column name for the ID of tag.
549 /// <value>The column name for the ID of tag.</value>
551 /// The value type is integer.
553 /// <seealso cref="Tag.Id"/>
554 /// <since_tizen> 4 </since_tizen>
555 public static string Id => "TAG_ID";
559 /// Provides the bookmark column names that can be used for Select and Count commands.
561 /// <seealso cref="SelectArguments"/>
562 /// <seealso cref="CountArguments"/>
563 /// <seealso cref="QueryArguments.FilterExpression"/>
564 /// <seealso cref="SelectArguments.SortOrder"/>
565 /// <seealso cref="BookmarkCommand.Count(CountArguments)"/>
566 /// <seealso cref="BookmarkCommand.Select(SelectArguments)"/>
567 /// <seealso cref="MediaInfoCommand.CountBookmark(string, CountArguments)"/>
568 /// <seealso cref="MediaInfoCommand.SelectBookmark(string, SelectArguments)"/>
569 /// <since_tizen> 4 </since_tizen>
570 public static class BookmarkColumns
573 /// Gets the column name for the offset of the bookmark.
575 /// <value>The column name for the offset of the bookmark.</value>
577 /// The value type is integer.
579 /// <seealso cref="Bookmark.Offset"/>
580 /// <since_tizen> 4 </since_tizen>
581 public static string Offset => "BOOKMARK_MARKED_TIME";
584 /// Gets the column name for the ID of the bookmark.
586 /// <value>The column name for the ID of the bookmark.</value>
588 /// The value type is integer.
590 /// <seealso cref="Bookmark.Id"/>
591 /// <since_tizen> 4 </since_tizen>
592 public static string Id => "BOOKMARK_ID";
595 /// Gets the column name for the name of the bookmark.
597 /// <value>The column name for the name of the bookmark.</value>
599 /// The value type is string.
601 /// <seealso cref="Bookmark.Name"/>
602 /// <since_tizen> 4 </since_tizen>
603 public static string Name => "BOOKMARK_NAME";
607 /// Provides the face info column names that can be used for Select and Count commands.
609 /// <seealso cref="SelectArguments"/>
610 /// <seealso cref="CountArguments"/>
611 /// <seealso cref="QueryArguments.FilterExpression"/>
612 /// <seealso cref="SelectArguments.SortOrder"/>
613 /// <seealso cref="FaceInfoCommand.Select(SelectArguments)"/>
614 /// <seealso cref="MediaInfoCommand.CountFaceInfo(string, CountArguments)"/>
615 /// <seealso cref="MediaInfoCommand.SelectFaceInfo(string, SelectArguments)"/>
616 /// <since_tizen> 4 </since_tizen>
617 [Obsolete("Deprecated since API11; Will be removed in API13.")]
618 public static class FaceInfoColumns
621 /// Gets the column name for the tag of face information.
623 /// <value>The column name for the tag of face information.</value>
625 /// The value type is string.
627 /// <seealso cref="FaceInfo.Tag"/>
628 /// <since_tizen> 4 </since_tizen>
629 [Obsolete("Deprecated since API11; Will be removed in API13.")]
630 public static string Tag => "MEDIA_FACE_TAG";
633 /// Gets the column name for the ID of face information.
635 /// <value>The column name for the ID of face information.</value>
637 /// The value type is string.
639 /// <seealso cref="FaceInfo.Id"/>
640 /// <since_tizen> 4 </since_tizen>
641 [Obsolete("Deprecated since API11; Will be removed in API13.")]
642 public static string Id => "MEDIA_FACE_ID";