MediaItemMetadata.java revision 43f79f79a5117550a7dfedf9c65124afd163ea43 
1/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
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
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
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.
15 */
16
17package android.support.v7.media;
18
19import android.os.Bundle;
20
21/**
22 * Constants for specifying metadata about a media item as a {@link Bundle}.
23 */
24public final class MediaItemMetadata {
25    /*
26     * Note: MediaMetadataRetriever also defines a collection of metadata keys that can be
27     * retrieved from a content stream although the representation is somewhat different here
28     * since we are sending the data to a remote endpoint.
29     */
30
31    private MediaItemMetadata() {
32    }
33
34    /**
35     * Metadata key: Album artist name.
36     * <p>
37     * The value is a string suitable for display.
38     * </p>
39     */
40    public static final String KEY_ALBUM_ARTIST = "ALBUM_ARTIST";
41
42    /**
43     * Metadata key: Album title.
44     * <p>
45     * The value is a string suitable for display.
46     * </p>
47     */
48    public static final String KEY_ALBUM_TITLE = "ALBUM_TITLE";
49
50    /**
51     * Metadata key: Artwork Uri.
52     * <p>
53     * The value is a string URI for an image file associated with the media item,
54     * such as album or cover art.
55     * </p>
56     *
57     * @see #KEY_ARTWORK_BITMAP
58     */
59    public static final String KEY_ARTWORK_URI = "ARTWORK_URI";
60
61    /**
62     * Metadata key: Artwork Bitmap.
63     * <p>
64     * The value is a {@link Bitmap} for an image file associated with the media item,
65     * such as album or cover art.
66     * </p><p>
67     * Because bitmaps can be large, use {@link #KEY_ARTWORK_URI} instead if the artwork can
68     * be downloaded from the network.
69     * </p>
70     *
71     * @see #KEY_ARTWORK_URI
72     */
73    public static final String KEY_ARTWORK_BITMAP = "ARTWORK_BITMAP";
74
75    /**
76     * Metadata key: Artist name.
77     * <p>
78     * The value is a string suitable for display.
79     * </p>
80     */
81    public static final String KEY_ARTIST = "ARTIST";
82
83    /**
84     * Metadata key: Author name.
85     * <p>
86     * The value is a string suitable for display.
87     * </p>
88     */
89    public static final String KEY_AUTHOR = "AUTHOR";
90
91    /**
92     * Metadata key: Composer name.
93     * <p>
94     * The value is a string suitable for display.
95     * </p>
96     */
97    public static final String KEY_COMPOSER = "COMPOSER";
98
99    /**
100     * Metadata key: Track title.
101     * <p>
102     * The value is a string suitable for display.
103     * </p>
104     */
105    public static final String KEY_TITLE = "TITLE";
106
107    /**
108     * Metadata key: Year of publication.
109     * <p>
110     * The value is an integer year number.
111     * </p>
112     */
113    public static final String KEY_YEAR = "YEAR";
114
115    /**
116     * Metadata key: Track number (such as a track on a CD).
117     * <p>
118     * The value is a one-based integer track number.
119     * </p>
120     */
121    public static final String KEY_TRACK_NUMBER = "TRACK_NUMBER";
122
123    /**
124     * Metadata key: Disc number within a collection.
125     * <p>
126     * The value is a one-based integer disc number.
127     * </p>
128     */
129    public static final String KEY_DISC_NUMBER = "DISC_NUMBER";
130}
131