程序包 ohos.media.sessioncore

类 AVBrowser

java.lang.Object

ohos.media.sessioncore.AVBrowser

public final class AVBrowser
extends Object

Browses media data provided by the AVBrowserService.

从以下版本开始:

3

SystemCapability

SystemCapability.Multimedia#MEDIA

构造器概要

构造器

构造器	说明
AVBrowser(Context context, ElementName name, AVConnectionCallback callback, PacMap options)	A constructor used to create an AVBrowser instance for media data provided by the media browser service.

方法概要

限定符和类型	方法	说明
void	connect()	Connects to the media browser service.
void	disconnect()	Disconnects from the media browser service.
void	getAVElement(String mediaId, AVElementCallback callback)	Obtains a AVElement instance based on the media item ID.
AVToken	getAVToken()	Obtains the media session token.
ElementName	getElementName()	Obtains the ElementName instance of the media browser service.
PacMap	getOptions()	Obtains the additional media data provided by the media browser service.
String	getRootMediaId()	Obtains the ID of the root media item.
boolean	isConnected()	Checks whether the media browser service is connected.
void	subscribeByParentMediaId(String parentMediaId, AVSubscriptionCallback callback)	Subscribes to a specified parent media item based on its ID to receive the update notifications about all its child media items.
void	subscribeByParentMediaId(String parentMediaId, PacMap options, AVSubscriptionCallback callback)	Subscribes to a specified parent media item based on its ID and the parameters sent to the media browser service to receive the update notifications about all its child media items.
void	unsubscribeByParentMediaId(String parentMediaId)	Unsubscribes from the specified parent media item.
void	unsubscribeByParentMediaId(String parentMediaId, AVSubscriptionCallback callback)	Unsubscribes from the notification of the specified parent media item based on the callback used for the subscription.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

AVBrowser

public AVBrowser(Context context,
                 ElementName name,
                 AVConnectionCallback callback,
                 PacMap options)

A constructor used to create an AVBrowser instance for media data provided by the media browser service.

This constructor must be called on main thread.

参数:

context - Indicates the application context.

name - Indicates the media item name consisted of the application bundle name and media browser service name.

callback - Indicates the callback that listens for the service connection status.

options - Indicates a group of parameters that will be sent to the media browser service. The parameters determine the data returned from the service. This parameter can be null.

从以下版本开始:

3

方法详细资料

connect

public void connect()

Connects to the media browser service.

This is an asynchronous method. The connection result will be returned through the callback passed to the constructor.

抛出:

IllegalStateException - Throws this exception if any of the following occurs:

• This AVBrowser has been connected to the service.
• This AVBrowser is connecting to the service.
• An unknown exception occurs.

从以下版本开始:

3

disconnect

public void disconnect()

Disconnects from the media browser service.

This is an asynchronous method.

从以下版本开始:

3

isConnected

public boolean isConnected()

Checks whether the media browser service is connected.

返回:

Returns true if the connection is successful; returns false otherwise.

从以下版本开始:

3

getElementName

public ElementName getElementName()

Obtains the ElementName instance of the media browser service.

返回:

Returns the ElementName instance if obtained; returns null otherwise.

从以下版本开始:

3

getRootMediaId

public String getRootMediaId()

Obtains the ID of the root media item.

返回:

Returns the ID if obtained; returns null otherwise.

从以下版本开始:

3

getOptions

public PacMap getOptions()

Obtains the additional media data provided by the media browser service.

返回:

Returns the PacMap instance if obtained; returns null otherwise.

从以下版本开始:

3

getAVToken

public AVToken getAVToken()

Obtains the media session token.

返回:

Returns the AVToken instance if obtained; returns null otherwise.

从以下版本开始:

3

getAVElement

public void getAVElement(String mediaId,
                         AVElementCallback callback)

Obtains a AVElement instance based on the media item ID. The execution result will be returned through the passed callback.

参数:

mediaId - Indicates the media item ID.

callback - Indicates the callback to receive the execution result.

抛出:

IllegalArgumentException - Throws this exception if mediaId or callback is null.

从以下版本开始:

3

subscribeByParentMediaId

public void subscribeByParentMediaId(String parentMediaId,
                                     AVSubscriptionCallback callback)

Subscribes to a specified parent media item based on its ID to receive the update notifications about all its child media items.

If this method is called after the media browser service is connected, this AVBrowser instance will subscribe to all child items of the parent media item.

If this method is called before the media browser service is connected, this AVBrowser instance will save the parent item ID and passed callback. After the service is connected, this AVBrowser will subscribe to all child items included in the parent media item.

If a parent media item ID is repeatedly used for subscriptions, the latest subscription will replace the previous one.

参数:

parentMediaId - Indicates the ID of the parent media item.

callback - Indicates the callback to receive the subscription result.

抛出:

IllegalArgumentException - Throws this exception if parentMediaId or callback is null.

从以下版本开始:

3

subscribeByParentMediaId

public void subscribeByParentMediaId(String parentMediaId,
                                     PacMap options,
                                     AVSubscriptionCallback callback)

Subscribes to a specified parent media item based on its ID and the parameters sent to the media browser service to receive the update notifications about all its child media items.

If this method is called after the service is connected, this AVBrowser instance will subscribe to all child items of the parent media item.

If this method is called before the service is connected, this AVBrowser instance will save the parent item ID and passed callback. After the service is connected, this AVBrowser will subscribe to all child items included in the parent media item.

If a parent media item ID is repeatedly used for subscriptions with the same options parameters, the latest subscription will replace the previous one.

参数:

parentMediaId - Indicates the ID of the parent media item.

options - Indicates a group of parameters that will be sent to the service. The parameters determine the data returned from the service.

callback - Indicates the callback to receive the subscription result.

抛出:

IllegalArgumentException - Throws this exception if parentMediaId, options, or callback is null.

从以下版本开始:

3

unsubscribeByParentMediaId

public void unsubscribeByParentMediaId(String parentMediaId)

Unsubscribes from the specified parent media item.

参数:

parentMediaId - Indicates the ID of the parent media item.

抛出:

IllegalArgumentException - Throws this exception if parentMediaId is null.

从以下版本开始:

3

unsubscribeByParentMediaId

public void unsubscribeByParentMediaId(String parentMediaId,
                                       AVSubscriptionCallback callback)

Unsubscribes from the notification of the specified parent media item based on the callback used for the subscription.

This method cancels only the notification associated with the specified callback, but will not cancel other callbacks even if you have set multiple callbacks for the subscription.

参数:

parentMediaId - Indicates the ID of the parent media item.

callback - Indicates the callback based on which the notification will be canceled.

抛出:

IllegalArgumentException - Throws this exception if parentMediaId or callback is null.

从以下版本开始:

3