4 <name>Tizen.Multimedia.Metadata</name>
7 <member name="T:Tizen.Multimedia.MetadataEditor">
9 Provides a means to edit the metadata of the media file.
12 If you want to access only internal storage,
13 you should add privilege http://tizen.org/privilege/mediastorage. \n
14 Or if you want to access only external storage,
15 you should add privilege http://tizen.org/privilege/externalstorage. \n
18 <member name="M:Tizen.Multimedia.MetadataEditor.#ctor(System.String)">
20 Initializes a new instance of the <see cref="T:Tizen.Multimedia.MetadataEditor"/> class with the specified path.
22 <since_tizen> 3 </since_tizen>
23 <param name="path">The path of the media file to edit metadata.</param>
24 <exception cref="T:System.ArgumentNullException"><paramref name="path"/> is null.</exception>
25 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space.</exception>
26 <exception cref="T:Tizen.Multimedia.FileFormatException">The file is not supported.</exception>
27 <exception cref="T:System.IO.FileNotFoundException">File does not exist.</exception>
28 <exception cref="T:System.UnauthorizedAccessException">Caller does not have required privilege to access the file.</exception>
30 <member name="P:Tizen.Multimedia.MetadataEditor.Artist">
32 Gets or sets the artist of media.
34 <since_tizen> 3 </since_tizen>
35 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
36 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
38 <member name="P:Tizen.Multimedia.MetadataEditor.Title">
40 Gets or sets the title of media.
42 <since_tizen> 3 </since_tizen>
43 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
44 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
46 <member name="P:Tizen.Multimedia.MetadataEditor.Album">
48 Gets or sets the album name of media.
50 <since_tizen> 3 </since_tizen>
51 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
52 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
54 <member name="P:Tizen.Multimedia.MetadataEditor.Genre">
56 Gets or sets the genre of media.
58 <since_tizen> 3 </since_tizen>
59 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
60 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
62 <member name="P:Tizen.Multimedia.MetadataEditor.Author">
64 Gets or sets the author of media.
66 <since_tizen> 3 </since_tizen>
67 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
68 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
70 <member name="P:Tizen.Multimedia.MetadataEditor.Copyright">
72 Gets or sets the copyright of media.
74 <since_tizen> 3 </since_tizen>
75 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
76 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
78 <member name="P:Tizen.Multimedia.MetadataEditor.Date">
80 Gets or sets the date of media.
82 <since_tizen> 3 </since_tizen>
84 If the media contains ID3 tag, this refers to the recorded date.
85 If the media is a mp4 format, this refers to the year and the value to set will be converted into integer.
87 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
88 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
90 <member name="P:Tizen.Multimedia.MetadataEditor.Description">
92 Gets or sets the description of media.
94 <since_tizen> 3 </since_tizen>
95 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
96 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
98 <member name="P:Tizen.Multimedia.MetadataEditor.Comment">
100 Gets or sets the comment of media.
102 <since_tizen> 3 </since_tizen>
103 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
104 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
106 <member name="P:Tizen.Multimedia.MetadataEditor.TrackNumber">
108 Gets or sets the track number of media.
110 <since_tizen> 3 </since_tizen>
111 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
112 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
114 <member name="P:Tizen.Multimedia.MetadataEditor.PictureCount">
116 Gets the count of album arts of media.
118 <since_tizen> 3 </since_tizen>
119 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
121 <member name="P:Tizen.Multimedia.MetadataEditor.Conductor">
123 Gets or sets the conductor of media.
125 <since_tizen> 3 </since_tizen>
126 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
127 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
129 <member name="P:Tizen.Multimedia.MetadataEditor.UnsyncLyrics">
131 Gets or sets the unsynchronized lyrics of media.
133 <since_tizen> 3 </since_tizen>
134 <exception cref="T:System.InvalidOperationException">The file is read-only.</exception>
135 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
137 <member name="M:Tizen.Multimedia.MetadataEditor.Commit">
139 Writes the modified metadata to the media file.
141 <exception cref="T:System.InvalidOperationException">
142 An internal error occurs.\n
144 The file is read-only.
146 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
148 <member name="M:Tizen.Multimedia.MetadataEditor.GetPicture(System.Int32)">
150 Gets the artwork image in the media file.
152 <since_tizen> 3 </since_tizen>
153 <param name="index">The index of picture to import.</param>
154 <returns> Artwork included in the media file.</returns>
155 <returns>Artwork included in the media file.</returns>
156 <exception cref="T:System.InvalidOperationException">An internal error occurs.</exception>
157 <exception cref="T:System.ArgumentOutOfRangeException">
158 <paramref name="index"/> is less than zero.\n
160 <paramref name="index"/> is greater than or equal to <see cref="P:Tizen.Multimedia.MetadataEditor.PictureCount"/>.\n
162 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
164 <member name="M:Tizen.Multimedia.MetadataEditor.AddPicture(System.String)">
166 Appends the picture to the media file.
168 <since_tizen> 3 </since_tizen>
169 <param name="path">The path of picture for adding to the metadata.</param>
170 <exception cref="T:System.InvalidOperationException">
171 An internal error occurs.\n
173 The media file is read-only.
175 <exception cref="T:System.ArgumentNullException"> Picture path is null</exception>
176 <exception cref="T:System.IO.FileNotFoundException">File does not exist.</exception>
177 <exception cref="T:System.UnauthorizedAccessException">Caller does not have required privilege to access the file.</exception>
178 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
179 <exception cref="T:Tizen.Multimedia.FileFormatException">The specified file is not supported.</exception>
181 <member name="M:Tizen.Multimedia.MetadataEditor.RemovePicture(System.Int32)">
183 Removes the picture from the media file.
185 <since_tizen> 3 </since_tizen>
186 <param name="index">The index of picture to remove.</param>
187 <exception cref="T:System.InvalidOperationException">
188 An internal error occurs.\n
190 The media file is read-only.
192 <exception cref="T:System.ArgumentOutOfRangeException">
193 <paramref name="index"/> is less than zero.\n
195 <paramref name="index"/> is greater than or equal to <see cref="P:Tizen.Multimedia.MetadataEditor.PictureCount"/>.\n
197 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataEditor"/> has already been disposed.</exception>
199 <member name="M:Tizen.Multimedia.MetadataEditor.Dispose">
201 Releases all resources used by the <see cref="T:Tizen.Multimedia.MetadataEditor"/> object.
204 <member name="T:Tizen.Multimedia.MetadataEditorError">
206 Enumeration for metadata extractor's error codes.
209 <member name="T:Tizen.Multimedia.Artwork">
211 Represents artwork information of media.
214 <member name="M:Tizen.Multimedia.Artwork.#ctor(System.Byte[],System.String)">
216 Initializes a new instance of the Artwork class with the specified data and mime type.
218 <since_tizen> 3 </since_tizen>
219 <param name="data">The data of the artwork to set metadata.</param>
220 <param name="mimeType">The mime type of the data of the artwork.</param>
222 <member name="P:Tizen.Multimedia.Artwork.Data">
224 Gets the encoded artwork image.
226 <since_tizen> 3 </since_tizen>
228 <member name="P:Tizen.Multimedia.Artwork.MimeType">
230 Gets the mime type of artwork.
232 <since_tizen> 3 </since_tizen>
234 <member name="T:Tizen.Multimedia.VideoMetadata">
236 Represents video metadata information.
239 <member name="P:Tizen.Multimedia.VideoMetadata.BitRate">
243 <since_tizen> 3 </since_tizen>
244 <value>The bitrate value, or null if the information does not exist.</value>
246 <member name="P:Tizen.Multimedia.VideoMetadata.Fps">
250 <since_tizen> 3 </since_tizen>
251 <value>The fps value, or null if the information does not exist.</value>
253 <member name="P:Tizen.Multimedia.VideoMetadata.Width">
255 Gets the width of the video.
257 <since_tizen> 3 </since_tizen>
258 <value>The width value, or null if the information does not exist.</value>
260 <member name="P:Tizen.Multimedia.VideoMetadata.Height">
262 Gets the height of the video.
264 <since_tizen> 3 </since_tizen>
265 <value>The height value, or null if the information does not exist.</value>
267 <member name="P:Tizen.Multimedia.VideoMetadata.Codec">
269 Get the codec type of the video.
271 <since_tizen> 3 </since_tizen>
272 <value>A string representing the codec type, or null if the information does not exist.</value>
274 <member name="P:Tizen.Multimedia.VideoMetadata.StreamCount">
276 Gets the video stream count.
278 <since_tizen> 3 </since_tizen>
279 <value>The number of video streams.</value>
281 <member name="T:Tizen.Multimedia.AudioMetadata">
283 Represents audio metadata information.
286 <member name="P:Tizen.Multimedia.AudioMetadata.BitRate">
288 Gets the audio bitrate.
290 <since_tizen> 3 </since_tizen>
291 <value>The bit rate value, or null if the information does not exist.</value>
293 <member name="P:Tizen.Multimedia.AudioMetadata.Channels">
295 Gets the audio channels.
297 <since_tizen> 3 </since_tizen>
298 <value>The number of the audio channels, or null if the information does not exist.</value>
300 <member name="P:Tizen.Multimedia.AudioMetadata.SampleRate">
302 Gets the audio sample rate.
304 <since_tizen> 3 </since_tizen>
305 <value>The sample rate, or null if the information does not exist.</value>
307 <member name="P:Tizen.Multimedia.AudioMetadata.BitPerSample">
309 Gets the bit per sample of the audio.
311 <since_tizen> 3 </since_tizen>
312 <value>The bit per sample, or null if the information does not exist.</value>
314 <member name="P:Tizen.Multimedia.AudioMetadata.StreamCount">
316 Gets the audio stream count.
318 <since_tizen> 3 </since_tizen>
319 <value>The number of audio streams.</value>
321 <member name="P:Tizen.Multimedia.AudioMetadata.Codec">
323 Gets the audio codec type.
325 <since_tizen> 3 </since_tizen>
327 <member name="T:Tizen.Multimedia.Metadata">
329 Represents metadata information of a media.
332 <member name="P:Tizen.Multimedia.Metadata.Duration">
334 Gets the duration of the media.
336 <since_tizen> 3 </since_tizen>
337 <value>The duration value, or null if the information does not exist.</value>
339 <member name="P:Tizen.Multimedia.Metadata.Video">
341 Gets the video metadata.
343 <since_tizen> 3 </since_tizen>
344 <value>The video metadata, or null if the information does not exist.</value>
346 <member name="P:Tizen.Multimedia.Metadata.Audio">
348 Gets the audio metadata.
350 <since_tizen> 3 </since_tizen>
351 <value>The audio metadata, or null if the information does not exist.</value>
353 <member name="P:Tizen.Multimedia.Metadata.Artist">
355 Gets the artist of the media.
357 <since_tizen> 3 </since_tizen>
358 <value>A string representing the artist, or null if the information does not exist.</value>
360 <member name="P:Tizen.Multimedia.Metadata.Title">
362 Gets the title of the media.
364 <since_tizen> 3 </since_tizen>
365 <value>A string representing the title, or null if the information does not exist.</value>
367 <member name="P:Tizen.Multimedia.Metadata.Album">
369 Gets the album name of the media.
371 <since_tizen> 3 </since_tizen>
372 <value>A string representing the album name, or null if the information does not exist.</value>
374 <member name="P:Tizen.Multimedia.Metadata.AlbumArtist">
376 Gets the album artist of the media.
378 <since_tizen> 3 </since_tizen>
379 <value>A string representing the album artist, or null if the information does not exist.</value>
381 <member name="P:Tizen.Multimedia.Metadata.Genre">
383 Gets the genre of the media.
385 <since_tizen> 3 </since_tizen>
386 <value>A string representing the genre, or null if the information does not exist.</value>
388 <member name="P:Tizen.Multimedia.Metadata.Author">
390 Gets the author of the media.
392 <since_tizen> 3 </since_tizen>
393 <value>A string representing the author, or null if the information does not exist.</value>
395 <member name="P:Tizen.Multimedia.Metadata.Copyright">
397 Gets the copyright of the media.
399 <since_tizen> 3 </since_tizen>
400 <value>A string representing the copyright, or null if the information does not exist.</value>
402 <member name="P:Tizen.Multimedia.Metadata.DateReleased">
404 Gets the release date of the media.
406 <since_tizen> 3 </since_tizen>
407 <value>A string representing the release date, or null if the information does not exist.</value>
409 <member name="P:Tizen.Multimedia.Metadata.Description">
411 Gets the description of the media.
413 <since_tizen> 3 </since_tizen>
414 <value>A string representing the description, or null if the information does not exist.</value>
416 <member name="P:Tizen.Multimedia.Metadata.Comment">
418 Gets the comment of the media.
420 <since_tizen> 3 </since_tizen>
421 <value>A string representing the comment, or null if the information does not exist.</value>
423 <member name="P:Tizen.Multimedia.Metadata.TrackNumber">
425 Gets the track number of the media.
427 <since_tizen> 3 </since_tizen>
428 <value>A string representing the track number, or null if the information does not exist.</value>
430 <member name="P:Tizen.Multimedia.Metadata.Classification">
432 Gets the classification of the media.
434 <since_tizen> 3 </since_tizen>
435 <value>A string representing the classification, or null if the information does not exist.</value>
437 <member name="P:Tizen.Multimedia.Metadata.Rating">
439 Gets the rating of the media.
441 <since_tizen> 3 </since_tizen>
442 <value>A string representing the rating, or null if the information does not exist.</value>
444 <member name="P:Tizen.Multimedia.Metadata.Longitude">
446 Gets the longitude of the media.
448 <since_tizen> 3 </since_tizen>
449 <value>The longitude value, or null if the information does not exist.</value>
451 <member name="P:Tizen.Multimedia.Metadata.Latitude">
453 Gets the latitude of the media.
455 <since_tizen> 3 </since_tizen>
456 <value>The latitude value, or null if the information does not exist.</value>
458 <member name="P:Tizen.Multimedia.Metadata.Altitude">
460 Gets the altitude of the media.
462 <since_tizen> 3 </since_tizen>
463 <value>The altitude value, or null if the information does not exist.</value>
465 <member name="P:Tizen.Multimedia.Metadata.Conductor">
467 Gets the conductor of the media.
469 <since_tizen> 3 </since_tizen>
470 <value>A string representing the conductor, or null if the information does not exist.</value>
472 <member name="P:Tizen.Multimedia.Metadata.UnsyncLyrics">
474 Gets the unsynchronized lyrics of the media.
476 <since_tizen> 3 </since_tizen>
477 <value>A string representing the unsynchronized lyrics, or null if the information does not exist.</value>
479 <member name="P:Tizen.Multimedia.Metadata.SyncLyricsCount">
481 Gets the number of synchronized lyrics of the media.
483 <since_tizen> 3 </since_tizen>
484 <value>The number of the synchronized lyrics.</value>
486 <member name="P:Tizen.Multimedia.Metadata.DateRecorded">
488 Gets the recording date of the media.
490 <since_tizen> 3 </since_tizen>
491 <value>A string representing the recording date, or null if the information does not exist.</value>
493 <member name="P:Tizen.Multimedia.Metadata.Rotation">
495 Gets the rotate(orientation) information of the media.
497 <since_tizen> 3 </since_tizen>
498 <value>A string representing the rotation information, or null if the information does not exist.</value>
500 <member name="P:Tizen.Multimedia.Metadata.Content360">
502 Gets the information for 360 content of the media.
504 <since_tizen> 3 </since_tizen>
505 <value>A string representing the information for 360 content, or null if the information does not exist.</value>
507 <member name="T:Tizen.Multimedia.MetadataExtractor">
509 Provides a set of functions to get the metadata from a media file.
512 <member name="M:Tizen.Multimedia.MetadataExtractor.#ctor(System.String)">
514 Initializes a new instance of the MetadataExtractor class with the specified path.
516 <since_tizen> 3 </since_tizen>
517 <param name="path">The path for the file to extract metadata.</param>
518 <exception cref="T:System.ArgumentNullException"><paramref name="path"/> is null.</exception>
519 <exception cref="!:FileNotFoundException"><paramref name="path"/> is not exist.</exception>
521 <member name="M:Tizen.Multimedia.MetadataExtractor.#ctor(System.Byte[])">
523 Initializes a new instance of the MetadataExtractor class with the specified buffer.
525 <since_tizen> 3 </since_tizen>
526 <param name="buffer">The buffer to extract metadata.</param>
527 <exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is null.</exception>
528 <exception cref="T:System.ArgumentException">The length of <paramref name="buffer"/> is zero.</exception>
530 <member name="M:Tizen.Multimedia.MetadataExtractor.GetMetadata">
532 Retrieves the <see cref="T:Tizen.Multimedia.Metadata"/>.
534 <since_tizen> 3 </since_tizen>
535 <returns>A <see cref="T:Tizen.Multimedia.Metadata"/> for the given source.</returns>
536 <exception cref="T:System.InvalidOperationException">Internal process error is occurred.</exception>
537 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataExtractor"/> has been already disposed of.</exception>
539 <member name="M:Tizen.Multimedia.MetadataExtractor.GetArtwork">
541 Gets the artwork image in the source.
543 <since_tizen> 3 </since_tizen>
544 <returns>A <see cref="T:Tizen.Multimedia.Artwork"/> if it exists, otherwise null.</returns>
545 <exception cref="T:System.InvalidOperationException">Internal process error is occurred.</exception>
546 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataExtractor"/> has been already disposed of.</exception>
548 <member name="M:Tizen.Multimedia.MetadataExtractor.GetSyncLyrics(System.Int32)">
550 Gets the sync lyrics of the source.
552 <since_tizen> 3 </since_tizen>
553 <param name="index">The index of lyrics to retrieve.</param>
554 <returns>A <see cref="T:Tizen.Multimedia.SyncLyrics"/> object if <paramref name="index"/> is valid, otherwise null.</returns>
555 <exception cref="T:System.InvalidOperationException">Internal process error is occurred.</exception>
556 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataExtractor"/> has been already disposed of.</exception>
558 <member name="M:Tizen.Multimedia.MetadataExtractor.GetVideoThumbnail">
560 Gets the frame of a video media.
562 <since_tizen> 3 </since_tizen>
563 <returns>The raw thumbnail data in RGB888 if it exists, otherwise null.</returns>
564 <exception cref="T:System.InvalidOperationException">Internal process error is occurred.</exception>
565 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataExtractor"/> has been already disposed of.</exception>
567 <member name="M:Tizen.Multimedia.MetadataExtractor.GetFrameAt(System.UInt32,System.Boolean)">
569 Gets the frame of a video media.
571 <since_tizen> 3 </since_tizen>
572 <param name="timeStamp">The timestamp in milliseconds.</param>
573 <param name="accurate">true to get an accurate frame for the given timestamp,
574 otherwise false to get the nearest i-frame of the video rapidly.</param>
575 <returns>The raw frame data in RGB888 if a frame at specified time exists, otherwise null.</returns>
576 <exception cref="T:System.InvalidOperationException">An internal error occurs.</exception>
577 <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.MetadataExtractor"/> has been already disposed of.</exception>
579 <member name="M:Tizen.Multimedia.MetadataExtractor.Finalize">
581 Metadata Extractor destructor
583 <since_tizen> 3 </since_tizen>
585 <member name="M:Tizen.Multimedia.MetadataExtractor.Dispose">
587 Releases all resources used by the <see cref="T:Tizen.Multimedia.MetadataExtractor"/> object.
590 <member name="T:Tizen.Multimedia.MetadataExtractorError">
592 Enumeration for metadata extractor's error codes.
595 <member name="T:Tizen.Multimedia.SyncLyrics">
597 Represents synchronized lyrics information of media.
600 <member name="M:Tizen.Multimedia.SyncLyrics.#ctor(System.String,System.UInt32)">
602 Initialize a new instance of the MetadataExtractor class with the specified lyrics and timestamp.
604 <since_tizen> 3 </since_tizen>
605 <param name="lyrics">The text of synchronized lyrics.</param>
606 <param name="timestamp">The timestamp of synchronized lyrics.</param>
608 <member name="P:Tizen.Multimedia.SyncLyrics.Lyrics">
610 Gets the text representation of the lyrics.
612 <since_tizen> 3 </since_tizen>
614 <member name="P:Tizen.Multimedia.SyncLyrics.Timestamp">
616 Gets the time information of the lyrics.
618 <since_tizen> 3 </since_tizen>
620 <member name="T:Tizen.Multimedia.ObjectDescriptionBuilder">
622 Represents a point in 2D space.