ChannelLogoUtils

Artifact: androidx.tvprovider:tvprovider

Kotlin |Java

@WorkerThread
class ChannelLogoUtils

A utility class for conveniently storing and loading channel logos.

Summary

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

Public constructors

ChannelLogoUtils()

This function is deprecated.

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

Public functions
`java-static Bitmap!`	`@WorkerThread loadChannelLogo(context: Context, channelId: Long)` A convenient helper method to get the channel logo associated to the given channel ID from the system content provider.
`java-static Boolean`	`@WorkerThread storeChannelLogo(context: Context, channelId: Long, logo: Bitmap)` Stores the given channel logo `Bitmap` in the system content provider and associate it with the given channel ID.
`java-static Boolean`	`storeChannelLogo(context: Context, channelId: Long, logoUri: Uri)` 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

ChannelLogoUtils()

Public functions

loadChannelLogo

Added in 1.1.0-alpha02

@WorkerThread
java-static fun loadChannelLogo(context: Context, channelId: Long): Bitmap!

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

Parameters
`context: Context`	the context used to access the system content provider
`channelId: Long`	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
java-static fun storeChannelLogo(context: Context, channelId: Long, logo: Bitmap): Boolean

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

Parameters
`context: Context`	the context used to access the system content provider
`channelId: Long`	the ID of the target channel with which the given logo should be associated
`logo: Bitmap`	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

java-static fun storeChannelLogo(context: Context, channelId: Long, logoUri: Uri): Boolean

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
`context: Context`	the context used to access the system content provider
`channelId: Long`	the ID of the target channel with which the fetched logo should be associated
`logoUri: Uri`	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`