Merge "MediaBrowser2: Supplement javadoc for getItem/getChildren methods"
This commit is contained in:
committed by
Android (Google) Code Review
commit
5cb747992d
@@ -152,7 +152,7 @@ public class MediaBrowser2 extends MediaController2 {
|
||||
* Get the media item with the given media id. Result would be sent back asynchronously with the
|
||||
* {@link BrowserCallback#onItemLoaded(String, MediaItem2)}.
|
||||
*
|
||||
* @param mediaId media id
|
||||
* @param mediaId media id for specifying the item
|
||||
*/
|
||||
public void getItem(String mediaId) {
|
||||
mProvider.getItem_impl(mediaId);
|
||||
@@ -162,10 +162,10 @@ public class MediaBrowser2 extends MediaController2 {
|
||||
* Get list of children under the parent. Result would be sent back asynchronously with the
|
||||
* {@link BrowserCallback#onChildrenLoaded(String, int, int, Bundle, List)}.
|
||||
*
|
||||
* @param parentId
|
||||
* @param page
|
||||
* @param pageSize
|
||||
* @param options
|
||||
* @param parentId parent id for getting the children.
|
||||
* @param page page number to get the result. Starts from {@code 1}
|
||||
* @param pageSize page size. Should be greater or equal to {@code 1}
|
||||
* @param options optional bundle
|
||||
*/
|
||||
public void getChildren(String parentId, int page, int pageSize, @Nullable Bundle options) {
|
||||
mProvider.getChildren_impl(parentId, page, pageSize, options);
|
||||
|
||||
@@ -149,12 +149,12 @@ public abstract class MediaLibraryService2 extends MediaSessionService2 {
|
||||
}
|
||||
|
||||
/**
|
||||
* Called to get the search result . Return result here for the browser.
|
||||
* Called to get an item. Return result here for the browser.
|
||||
* <p>
|
||||
* Return an empty list for no search result, and return {@code null} for the error.
|
||||
* Return {@code null} for no result or error.
|
||||
*
|
||||
* @param itemId item id to get media item.
|
||||
* @return media item2. {@code null} for error.
|
||||
* @return a media item. {@code null} for no result or error.
|
||||
*/
|
||||
public @Nullable MediaItem2 onLoadItem(@NonNull ControllerInfo controllerInfo,
|
||||
@NonNull String itemId) {
|
||||
@@ -162,14 +162,14 @@ public abstract class MediaLibraryService2 extends MediaSessionService2 {
|
||||
}
|
||||
|
||||
/**
|
||||
* Called to get the search result. Return search result here for the browser.
|
||||
* Called to get children of given parent id. Return the children here for the browser.
|
||||
* <p>
|
||||
* Return an empty list for no search result, and return {@code null} for the error.
|
||||
* Return an empty list for no children, and return {@code null} for the error.
|
||||
*
|
||||
* @param parentId parent id to get children
|
||||
* @param page number of page
|
||||
* @param pageSize size of the page
|
||||
* @param options
|
||||
* @param options optional bundle
|
||||
* @return list of children. Can be {@code null}.
|
||||
*/
|
||||
public @Nullable List<MediaItem2> onLoadChildren(@NonNull ControllerInfo controller,
|
||||
|
||||
Reference in New Issue
Block a user