Added in API level Baklava

TvAdManager

---

Kotlin |Java

class TvAdManager

kotlin.Any
↳	android.media.tv.ad.TvAdManager

Central system API to the overall client-side TV AD architecture, which arbitrates interaction between applications and AD services.

Summary

Nested classes
abstract	TvAdServiceCallback Callback used to monitor status of the TV advertisement service.

Constants
static String	ACTION_APP_LINK_COMMAND Broadcast intent action to send app command to TV app.
static String	APP_LINK_KEY_BACK_URI Key for back URI in app link command.
static String	APP_LINK_KEY_CLASS_NAME Key for class name in app link.
static String	APP_LINK_KEY_COMMAND_TYPE Key for command type in app link command.
static String	APP_LINK_KEY_PACKAGE_NAME Key for package name in app link.
static String	APP_LINK_KEY_SERVICE_ID Key for service ID in app link command.
static Int	ERROR_BLOCKED Error code for blocked contents.
static Int	ERROR_ENCRYPTED Error code when the key or module is missing for the encrypted channel.
static Int	ERROR_NONE No error.
static Int	ERROR_NOT_SUPPORTED Error code for an unsupported channel.
static Int	ERROR_RESOURCE_UNAVAILABLE Error code when resource (e.g. tuner) is unavailable.
static Int	ERROR_UNKNOWN Unknown error code.
static Int	ERROR_UNKNOWN_CHANNEL Error code when the current channel is an unknown channel.
static Int	ERROR_WEAK_SIGNAL Error code for weak signal.
static String	INTENT_KEY_AD_SERVICE_ID Intent key for TV AD service ID.
static String	INTENT_KEY_CHANNEL_URI Intent key for TV channel URI.
static String	INTENT_KEY_COMMAND_TYPE Intent key for command type.
static String	INTENT_KEY_TV_INPUT_ID Intent key for TV input ID.
static String	SESSION_DATA_KEY_AD_BUFFER An object of AdBuffer.
static String	SESSION_DATA_KEY_AD_REQUEST An object of android.media.tv.AdRequest.
static String	SESSION_DATA_KEY_BROADCAST_INFO_REQUEST An object of android.media.tv.BroadcastInfoRequest.
static String	SESSION_DATA_KEY_REQUEST_ID The ID of android.media.tv.BroadcastInfoRequest.
static String	SESSION_DATA_TYPE_AD_BUFFER_READY Notifies the advertisement buffer is ready.
static String	SESSION_DATA_TYPE_AD_REQUEST Sends an advertisement request to be processed by the related TV input.
static String	SESSION_DATA_TYPE_BROADCAST_INFO_REQUEST Sends request for broadcast info.
static String	SESSION_DATA_TYPE_REMOVE_BROADCAST_INFO_REQUEST Removes request for broadcast info.
static Int	SESSION_STATE_ERROR Error state of AD service session.
static Int	SESSION_STATE_RUNNING Running state of AD service session.
static Int	SESSION_STATE_STOPPED Stopped (or not started) state of AD service session.

Public methods
MutableList<TvAdServiceInfo!>	getTvAdServiceList() Returns the complete list of TV AD services on the system.
Unit	registerCallback(executor: Executor, callback: TvAdManager.TvAdServiceCallback) Registers a TvAdServiceCallback.
Unit	sendAppLinkCommand(serviceId: String, command: Bundle) Sends app link command.
Unit	unregisterCallback(callback: TvAdManager.TvAdServiceCallback) Unregisters the existing TvAdServiceCallback.

Constants

ACTION_APP_LINK_COMMAND

Added in API level Baklava

static val ACTION_APP_LINK_COMMAND: String

Broadcast intent action to send app command to TV app.

Value: "android.media.tv.ad.action.APP_LINK_COMMAND"

See Also

• #sendAppLinkCommand(String, Bundle)

APP_LINK_KEY_BACK_URI

Added in API level Baklava

static val APP_LINK_KEY_BACK_URI: String

Key for back URI in app link command.

Type: String

Value: "back_uri"

See Also

• #sendAppLinkCommand(String, Bundle)

APP_LINK_KEY_CLASS_NAME

Added in API level Baklava

static val APP_LINK_KEY_CLASS_NAME: String

Key for class name in app link.

Type: String

Value: "class_name"

See Also

• #sendAppLinkCommand(String, Bundle)

APP_LINK_KEY_COMMAND_TYPE

Added in API level Baklava

static val APP_LINK_KEY_COMMAND_TYPE: String

Key for command type in app link command.

Type: String

Value: "command_type"

See Also

• #sendAppLinkCommand(String, Bundle)

APP_LINK_KEY_PACKAGE_NAME

Added in API level Baklava

static val APP_LINK_KEY_PACKAGE_NAME: String

Key for package name in app link.

Type: String

Value: "package_name"

See Also

• #sendAppLinkCommand(String, Bundle)

APP_LINK_KEY_SERVICE_ID

Added in API level Baklava

static val APP_LINK_KEY_SERVICE_ID: String

Key for service ID in app link command.

Type: String

Value: "service_id"

See Also

• #sendAppLinkCommand(String, Bundle)

ERROR_BLOCKED

Added in API level Baklava

static val ERROR_BLOCKED: Int

Error code for blocked contents.

Value: 5

ERROR_ENCRYPTED

Added in API level Baklava

static val ERROR_ENCRYPTED: Int

Error code when the key or module is missing for the encrypted channel.

Value: 6

ERROR_NONE

Added in API level Baklava

static val ERROR_NONE: Int

No error.

Value: 0

ERROR_NOT_SUPPORTED

Added in API level Baklava

static val ERROR_NOT_SUPPORTED: Int

Error code for an unsupported channel.

Value: 2

ERROR_RESOURCE_UNAVAILABLE

Added in API level Baklava

static val ERROR_RESOURCE_UNAVAILABLE: Int

Error code when resource (e.g. tuner) is unavailable.

Value: 4

ERROR_UNKNOWN

Added in API level Baklava

static val ERROR_UNKNOWN: Int

Unknown error code.

Value: 1

ERROR_UNKNOWN_CHANNEL

Added in API level Baklava

static val ERROR_UNKNOWN_CHANNEL: Int

Error code when the current channel is an unknown channel.

Value: 7

ERROR_WEAK_SIGNAL

Added in API level Baklava

static val ERROR_WEAK_SIGNAL: Int

Error code for weak signal.

Value: 3

INTENT_KEY_AD_SERVICE_ID

Added in API level Baklava

static val INTENT_KEY_AD_SERVICE_ID: String

Intent key for TV AD service ID. It's used to send app command to TV app.

Type: String

Value: "ad_service_id"

See Also

• #sendAppLinkCommand(String, Bundle)
• #ACTION_APP_LINK_COMMAND
• android.media.tv.ad.TvAdServiceInfo#getId()

INTENT_KEY_CHANNEL_URI

Added in API level Baklava

static val INTENT_KEY_CHANNEL_URI: String

Intent key for TV channel URI. It's used to send app command to TV app.

Type: android.net.Uri

Value: "channel_uri"

See Also

• #sendAppLinkCommand(String, Bundle)
• #ACTION_APP_LINK_COMMAND

INTENT_KEY_COMMAND_TYPE

Added in API level Baklava

static val INTENT_KEY_COMMAND_TYPE: String

Intent key for command type. It's used to send app command to TV app. The value of this key could vary according to TV apps.

Type: String

Value: "command_type"

See Also

• #sendAppLinkCommand(String, Bundle)
• #ACTION_APP_LINK_COMMAND

INTENT_KEY_TV_INPUT_ID

Added in API level Baklava

static val INTENT_KEY_TV_INPUT_ID: String

Intent key for TV input ID. It's used to send app command to TV app.

Type: String

Value: "tv_input_id"

See Also

• #sendAppLinkCommand(String, Bundle)
• #ACTION_APP_LINK_COMMAND

SESSION_DATA_KEY_AD_BUFFER

Added in API level Baklava

static val SESSION_DATA_KEY_AD_BUFFER: String

An object of AdBuffer.

Type: android.media.tv.AdBuffer

Value: "ad_buffer"

See Also

• android.media.tv.ad.TvAdService.Session#sendTvAdSessionData(String, Bundle)

SESSION_DATA_KEY_AD_REQUEST

Added in API level Baklava

static val SESSION_DATA_KEY_AD_REQUEST: String

An object of android.media.tv.AdRequest.

Type: android.media.tv.AdRequest

Value: "ad_request"

See Also

• android.media.tv.ad.TvAdService.Session#sendTvAdSessionData(String, Bundle)

SESSION_DATA_KEY_BROADCAST_INFO_REQUEST

Added in API level Baklava

static val SESSION_DATA_KEY_BROADCAST_INFO_REQUEST: String

An object of android.media.tv.BroadcastInfoRequest.

Type: android.media.tv.BroadcastInfoRequest

Value: "broadcast_info_request"

See Also

• android.media.tv.ad.TvAdService.Session#sendTvAdSessionData(String, Bundle)

SESSION_DATA_KEY_REQUEST_ID

Added in API level Baklava

static val SESSION_DATA_KEY_REQUEST_ID: String

The ID of android.media.tv.BroadcastInfoRequest.

Type: Integer

Value: "request_id"

See Also

• android.media.tv.ad.TvAdService.Session#sendTvAdSessionData(String, Bundle)

SESSION_DATA_TYPE_AD_BUFFER_READY

Added in API level Baklava

static val SESSION_DATA_TYPE_AD_BUFFER_READY: String

Notifies the advertisement buffer is ready.

Value: "ad_buffer_ready"

See Also

• android.media.tv.ad.TvAdService.Session#sendTvAdSessionData(String, Bundle)

SESSION_DATA_TYPE_AD_REQUEST

Added in API level Baklava

static val SESSION_DATA_TYPE_AD_REQUEST: String

Sends an advertisement request to be processed by the related TV input.

Value: "ad_request"

See Also

• android.media.tv.ad.TvAdService.Session#sendTvAdSessionData(String, Bundle)

SESSION_DATA_TYPE_BROADCAST_INFO_REQUEST

Added in API level Baklava

static val SESSION_DATA_TYPE_BROADCAST_INFO_REQUEST: String

Sends request for broadcast info.

Value: "broadcast_info_request"

See Also

• android.media.tv.ad.TvAdService.Session#sendTvAdSessionData(String, Bundle)

SESSION_DATA_TYPE_REMOVE_BROADCAST_INFO_REQUEST

Added in API level Baklava

static val SESSION_DATA_TYPE_REMOVE_BROADCAST_INFO_REQUEST: String

Removes request for broadcast info.

Value: "remove_broadcast_info_request"

See Also

• android.media.tv.ad.TvAdService.Session#sendTvAdSessionData(String, Bundle)

SESSION_STATE_ERROR

Added in API level Baklava

static val SESSION_STATE_ERROR: Int

Error state of AD service session.

Value: 3

SESSION_STATE_RUNNING

Added in API level Baklava

static val SESSION_STATE_RUNNING: Int

Running state of AD service session.

Value: 2

SESSION_STATE_STOPPED

Added in API level Baklava

static val SESSION_STATE_STOPPED: Int

Stopped (or not started) state of AD service session.

Value: 1

Public methods

getTvAdServiceList

Added in API level Baklava

fun getTvAdServiceList(): MutableList<TvAdServiceInfo!>

Returns the complete list of TV AD services on the system.

Return
MutableList<TvAdServiceInfo!>	List of TvAdServiceInfo for each TV AD service that describes its meta information. This value cannot be null.

registerCallback

Added in API level Baklava

fun registerCallback(
    executor: Executor, 
    callback: TvAdManager.TvAdServiceCallback
): Unit

Registers a TvAdServiceCallback.

Parameters
callback	TvAdManager.TvAdServiceCallback: A callback used to monitor status of the TV AD services. This value cannot be null.
executor	Executor: A Executor that the status change will be delivered to. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread. This value cannot be null.

sendAppLinkCommand

Added in API level Baklava

fun sendAppLinkCommand(
    serviceId: String, 
    command: Bundle
): Unit

Sends app link command.

Parameters
serviceId	String: The ID of TV AD service which the command to be sent to. The ID can be found in TvAdServiceInfo.getId(). This value cannot be null.
command	Bundle: The command to be sent. The command is a bundle with the following keys: APP_LINK_KEY_PACKAGE_NAME: The package name of the app to be launched. APP_LINK_KEY_CLASS_NAME: The class name of the app to be launched. APP_LINK_KEY_COMMAND_TYPE: The command type. APP_LINK_KEY_SERVICE_ID: The ID of the TV AD service. APP_LINK_KEY_BACK_URI: The URI to be used to return to the previous app. This value cannot be null.

unregisterCallback

Added in API level Baklava

fun unregisterCallback(callback: TvAdManager.TvAdServiceCallback): Unit

Unregisters the existing TvAdServiceCallback.

Parameters
callback	TvAdManager.TvAdServiceCallback: The existing callback to remove. This value cannot be null.