Android Studio
Added in API level 30

RouteDiscoveryPreference


public final class RouteDiscoveryPreference
extends Object implements Parcelable

java.lang.Object
   ↳ android.media.RouteDiscoveryPreference


A media route discovery preference describing the features of routes that media router would like to discover and whether to perform active scanning.

When MediaRouter2 instances set discovery preferences by calling MediaRouter2.registerRouteCallback, they are merged into a single discovery preference and it is delivered to call MediaRoute2ProviderService.onDiscoveryPreferenceChanged.

According to the given discovery preference, MediaRoute2ProviderService discovers routes and publishes them.

See also:

Summary

Nested classes

class RouteDiscoveryPreference.Builder

Builder for RouteDiscoveryPreference

Inherited constants

Fields

public static final Creator<RouteDiscoveryPreference> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

List<String> getPreferredFeatures()

Gets the features of routes that media router would like to discover.

int hashCode()

Returns a hash code value for the object.

boolean shouldPerformActiveScan()

Gets whether active scanning should be performed.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 30
public static final Creator<RouteDiscoveryPreference> CREATOR

Public methods

describeContents

Added in API level 30
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 30
public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getPreferredFeatures

Added in API level 30
public List<String> getPreferredFeatures ()

Gets the features of routes that media router would like to discover.

Routes that have at least one of the features will be discovered. They may include predefined features such as MediaRoute2Info.FEATURE_LIVE_AUDIO, MediaRoute2Info.FEATURE_LIVE_VIDEO, or MediaRoute2Info.FEATURE_REMOTE_PLAYBACK or custom features defined by a provider.

Returns
List<String> This value cannot be null.

hashCode

Added in API level 30
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Returns
int a hash code value for this object.

shouldPerformActiveScan

Added in API level 30
public boolean shouldPerformActiveScan ()

Gets whether active scanning should be performed.

If any of discovery preferences sets this as true, active scanning will be performed regardless of other discovery preferences.

Returns
boolean

toString

Added in API level 30
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 30
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters dest Parcel: This value cannot be null. flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following: