ChannelLogoUtils

Artifact: androidx.tvprovider:tvprovider

Kotlin |Java

@WorkerThread
public class ChannelLogoUtils

A utility class for conveniently storing and loading channel logos.

Summary

Public constructors
`ChannelLogoUtils()` This method is deprecated. This type should not be instantiated as it contains only static methods.

Public constructors

ChannelLogoUtils()

This method is deprecated.

This type should not be instantiated as it contains only static methods.

Public methods
`static Bitmap`	`@WorkerThread loadChannelLogo(@NonNull Context context, long channelId)` A convenient helper method to get the channel logo associated to the given channel ID from the system content provider.
`static boolean`	`@WorkerThread storeChannelLogo( @NonNull Context context, long channelId, @NonNull Bitmap logo )` Stores the given channel logo `Bitmap` in the system content provider and associate it with the given channel ID.
`static boolean`	`storeChannelLogo( @NonNull Context context, long channelId, @NonNull Uri logoUri )` Stores channel logo in the system content provider from the given URI.

Public constructors

ChannelLogoUtils

Added in 1.1.0-alpha02

Deprecated in 1.1.0-alpha02

public ChannelLogoUtils()

Public methods

loadChannelLogo

Added in 1.1.0-alpha02

@WorkerThread
public static Bitmap loadChannelLogo(@NonNull Context context, long channelId)

A convenient helper method to get the channel logo associated to the given channel ID from the system content provider.

Parameters
`@NonNull Context context`	the context used to access the system content provider
`long channelId`	the ID of the channel whose logo is supposed to be loaded

Returns
`Bitmap`	the requested channel logo in `Bitmap`, or `null` if not available.

See also
`storeChannelLogo`
`storeChannelLogo`

storeChannelLogo

Added in 1.1.0-alpha02

@WorkerThread
public static boolean storeChannelLogo(
    @NonNull Context context,
    long channelId,
    @NonNull Bitmap logo
)

Stores the given channel logo Bitmap in the system content provider and associate it with the given channel ID.

Parameters
`@NonNull Context context`	the context used to access the system content provider
`long channelId`	the ID of the target channel with which the given logo should be associated
`@NonNull Bitmap logo`	the logo image to be stored

Returns
`boolean`	`true` if successfully stored the logo in the system content provider, otherwise `false`.

See also
`loadChannelLogo`

storeChannelLogo

Added in 1.1.0-alpha02

public static boolean storeChannelLogo(
    @NonNull Context context,
    long channelId,
    @NonNull Uri logoUri
)

Stores channel logo in the system content provider from the given URI. The method will try to fetch the image file and decode it into Bitmap. Once the image is successfully fetched, it will be stored in the system content provider and associated with the given channel ID.

The URI provided to this method can be a URL referring to a image file residing in some remote site/server, or a URI in one of the following formats:

content (SCHEME_CONTENT)
android.resource (#SCHEME_ANDROID_RESOURCE)
file (SCHEME_FILE)

This method should be run in a worker thread since it may require network connection, which will raise an exception if it's running in the main thread.

Parameters
`@NonNull Context context`	the context used to access the system content provider
`long channelId`	the ID of the target channel with which the fetched logo should be associated
`@NonNull Uri logoUri`	the `Uri` of the logo file to be fetched and stored in the system provider

Returns
`boolean`	`true` if successfully fetched the image file referred by the give logo URI and stored it in the system content provider, or `false` if failed.

See also
`loadChannelLogo`