ContextQMD
Back to Exoplayer

StarRating (ExoPlayer library)

docs/doc/reference/com/google/android/exoplayer2/StarRating.html

latest5.9 KB
Original Source

Package com.google.android.exoplayer2

Class StarRating

[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public final classStarRatingextends[Rating](Rating.html "class in com.google.android.exoplayer2")

Deprecated. com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.

A rating expressed as a fractional number of stars.

Nested Class Summary

-

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.Bundleable

Bundleable.Creator<T extends Bundleable>

Field Summary

Fields | Modifier and Type | Field | Description | | --- | --- | --- | | static Bundleable.Creator<StarRating> | CREATOR | Deprecated.

Object that can restore a StarRating from a Bundle. |

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | StarRating​(int maxStars) | Deprecated.

Creates a unrated instance with maxStars. | | StarRating​(int maxStars, float starRating) | Deprecated.

Creates a rated instance with maxStars and the given fractional number of stars. |

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | boolean | equals​(Object obj) | Deprecated. | | int | getMaxStars() | Deprecated.

Returns the maximum number of stars. | | float | getStarRating() | Deprecated.

Returns the fractional number of stars of this rating. | | int | hashCode() | Deprecated. | | boolean | isRated() | Deprecated.

Whether the rating exists or not. | | Bundle | toBundle() | Deprecated.

Returns a Bundle representing the information stored in this object. |

-

Methods inherited from class java.lang.Object

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

Field Detail

-

CREATOR

public static final[Bundleable.Creator](Bundleable.Creator.html "interface in com.google.android.exoplayer2")<[StarRating](StarRating.html "class in com.google.android.exoplayer2")> CREATOR

Deprecated.

Object that can restore a StarRating from a Bundle.

Constructor Detail

-

StarRating

public StarRating​(@IntRange(from=1L)
                  int maxStars)

Deprecated.

Creates a unrated instance with maxStars. If maxStars is not a positive integer, it will throw an IllegalArgumentException. Parameters:maxStars - The maximum number of stars this rating can have.

-

StarRating

public StarRating​(@IntRange(from=1L)
                  int maxStars,
                  @FloatRange(from=0.0)
                  float starRating)

Deprecated.

Creates a rated instance with maxStars and the given fractional number of stars. Non-integer values may be used to represent an average rating value. If maxStars is not a positive integer or starRating is out of range, it will throw an IllegalArgumentException. Parameters:maxStars - The maximum number of stars this rating can have.starRating - A fractional number of stars of this rating from 0f to maxStars.

Method Detail

-

isRated

public boolean isRated()

Deprecated.

Description copied from class: Rating

Whether the rating exists or not. Specified by:isRated in class Rating

-

getMaxStars

@IntRange(from=1L)
public int getMaxStars()

Deprecated.

Returns the maximum number of stars. Must be a positive number.

-

getStarRating

public float getStarRating()

Deprecated.

Returns the fractional number of stars of this rating. Will range from 0f to maxStars, or Rating.RATING_UNSET if unrated.

-

hashCode

public int hashCode()

Deprecated. Overrides:hashCode in class Object

-

equals

public boolean equals​(@Nullable[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")obj)

Deprecated. Overrides:equals in class Object

-

toBundle

public[Bundle](https://developer.android.com/reference/android/os/Bundle.html "class or interface in android.os")toBundle()

Deprecated.

Description copied from interface: Bundleable

Returns a Bundle representing the information stored in this object.