Added in API level 36

Summary: Nested Classes | Constants | Methods | Inherited Methods

TvAdManager

Kotlin |Java

public final class TvAdManager
extends Object

java.lang.Object
↳	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
`class`	`TvAdManager.TvAdServiceCallback` Callback used to monitor status of the TV advertisement service.

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

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

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

ACTION_APP_LINK_COMMAND

Added in API level 36

public static final String ACTION_APP_LINK_COMMAND

Broadcast intent action to send app command to TV app.

See also:

sendAppLinkCommand(String, Bundle)

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

APP_LINK_KEY_BACK_URI

Added in API level 36

public static final String APP_LINK_KEY_BACK_URI

Key for back URI in app link command.

Type: String

See also:

sendAppLinkCommand(String, Bundle)

Constant Value: "back_uri"

APP_LINK_KEY_CLASS_NAME

Added in API level 36

public static final String APP_LINK_KEY_CLASS_NAME

Key for class name in app link.

Type: String

See also:

sendAppLinkCommand(String, Bundle)

Constant Value: "class_name"

APP_LINK_KEY_COMMAND_TYPE

Added in API level 36

public static final String APP_LINK_KEY_COMMAND_TYPE

Key for command type in app link command.

Type: String

See also:

sendAppLinkCommand(String, Bundle)

Constant Value: "command_type"

APP_LINK_KEY_PACKAGE_NAME

Added in API level 36

public static final String APP_LINK_KEY_PACKAGE_NAME

Key for package name in app link.

Type: String

See also:

sendAppLinkCommand(String, Bundle)

Constant Value: "package_name"

APP_LINK_KEY_SERVICE_ID

Added in API level 36

public static final String APP_LINK_KEY_SERVICE_ID

Key for service ID in app link command.

Type: String

See also:

sendAppLinkCommand(String, Bundle)

Constant Value: "service_id"

ERROR_BLOCKED

Added in API level 36

public static final int ERROR_BLOCKED

Error code for blocked contents.

Constant Value: 5 (0x00000005)

ERROR_ENCRYPTED

Added in API level 36

public static final int ERROR_ENCRYPTED

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

Constant Value: 6 (0x00000006)

ERROR_NONE

Added in API level 36

public static final int ERROR_NONE

No error.

Constant Value: 0 (0x00000000)

ERROR_NOT_SUPPORTED

Added in API level 36

public static final int ERROR_NOT_SUPPORTED

Error code for an unsupported channel.

Constant Value: 2 (0x00000002)

ERROR_RESOURCE_UNAVAILABLE

Added in API level 36

public static final int ERROR_RESOURCE_UNAVAILABLE

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

Constant Value: 4 (0x00000004)

ERROR_UNKNOWN

Added in API level 36

public static final int ERROR_UNKNOWN

Unknown error code.

Constant Value: 1 (0x00000001)

ERROR_UNKNOWN_CHANNEL

Added in API level 36

public static final int ERROR_UNKNOWN_CHANNEL

Error code when the current channel is an unknown channel.

Constant Value: 7 (0x00000007)

ERROR_WEAK_SIGNAL

Added in API level 36

public static final int ERROR_WEAK_SIGNAL

Error code for weak signal.

Constant Value: 3 (0x00000003)

INTENT_KEY_AD_SERVICE_ID

Added in API level 36

public static final String INTENT_KEY_AD_SERVICE_ID

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

Type: String

See also:

Constant Value: "ad_service_id"

INTENT_KEY_CHANNEL_URI

Added in API level 36

public static final String INTENT_KEY_CHANNEL_URI

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

Type: android.net.Uri

See also:

Constant Value: "channel_uri"

INTENT_KEY_COMMAND_TYPE

Added in API level 36

public static final String INTENT_KEY_COMMAND_TYPE

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

See also:

Constant Value: "command_type"

INTENT_KEY_TV_INPUT_ID

Added in API level 36

public static final String INTENT_KEY_TV_INPUT_ID

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

Type: String

See also:

Constant Value: "tv_input_id"

SESSION_DATA_KEY_AD_BUFFER

Added in API level 36

public static final String SESSION_DATA_KEY_AD_BUFFER

An object of AdBuffer.

Type: android.media.tv.AdBuffer

See also:

TvAdService.Session.sendTvAdSessionData(String, Bundle)

Constant Value: "ad_buffer"

SESSION_DATA_KEY_AD_REQUEST

Added in API level 36

public static final String SESSION_DATA_KEY_AD_REQUEST

An object of AdRequest.

Type: android.media.tv.AdRequest

See also:

TvAdService.Session.sendTvAdSessionData(String, Bundle)

Constant Value: "ad_request"

SESSION_DATA_KEY_BROADCAST_INFO_REQUEST

Added in API level 36

public static final String SESSION_DATA_KEY_BROADCAST_INFO_REQUEST

An object of BroadcastInfoRequest.

Type: android.media.tv.BroadcastInfoRequest

See also:

TvAdService.Session.sendTvAdSessionData(String, Bundle)

Constant Value: "broadcast_info_request"

SESSION_DATA_KEY_REQUEST_ID

Added in API level 36

public static final String SESSION_DATA_KEY_REQUEST_ID

The ID of BroadcastInfoRequest.

Type: Integer

See also:

TvAdService.Session.sendTvAdSessionData(String, Bundle)

Constant Value: "request_id"

SESSION_DATA_TYPE_AD_BUFFER_READY

Added in API level 36

public static final String SESSION_DATA_TYPE_AD_BUFFER_READY

Notifies the advertisement buffer is ready.

See also:

Constant Value: "ad_buffer_ready"

SESSION_DATA_TYPE_AD_REQUEST

Added in API level 36

public static final String SESSION_DATA_TYPE_AD_REQUEST

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

See also:

Constant Value: "ad_request"

SESSION_DATA_TYPE_BROADCAST_INFO_REQUEST

Added in API level 36

public static final String SESSION_DATA_TYPE_BROADCAST_INFO_REQUEST

Sends request for broadcast info.

See also:

Constant Value: "broadcast_info_request"

SESSION_DATA_TYPE_REMOVE_BROADCAST_INFO_REQUEST

Added in API level 36

public static final String SESSION_DATA_TYPE_REMOVE_BROADCAST_INFO_REQUEST

Removes request for broadcast info.

See also:

Constant Value: "remove_broadcast_info_request"

SESSION_STATE_ERROR

Added in API level 36

public static final int SESSION_STATE_ERROR

Error state of AD service session.

Constant Value: 3 (0x00000003)

SESSION_STATE_RUNNING

Added in API level 36

public static final int SESSION_STATE_RUNNING

Running state of AD service session.

Constant Value: 2 (0x00000002)

SESSION_STATE_STOPPED

Added in API level 36

public static final int SESSION_STATE_STOPPED

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

Constant Value: 1 (0x00000001)

Public methods

getTvAdServiceList

Added in API level 36

public List<TvAdServiceInfo> getTvAdServiceList ()

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

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

registerCallback

Added in API level 36

public void registerCallback (Executor executor, 
                TvAdManager.TvAdServiceCallback callback)

Registers a TvAdServiceCallback.

Parameters

Parameters
`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`.
`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.

callback

TvAdManager.TvAdServiceCallback: A callback used to monitor status of the TV AD services. This value cannot be null.

sendAppLinkCommand

Added in API level 36

public void sendAppLinkCommand (String serviceId, 
                Bundle command)

Sends app link command.

Parameters

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`.

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 36

public void unregisterCallback (TvAdManager.TvAdServiceCallback callback)

Unregisters the existing TvAdServiceCallback.

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

TvAdManager

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

ACTION_APP_LINK_COMMAND

APP_LINK_KEY_BACK_URI

APP_LINK_KEY_CLASS_NAME

APP_LINK_KEY_COMMAND_TYPE

APP_LINK_KEY_PACKAGE_NAME

APP_LINK_KEY_SERVICE_ID

ERROR_BLOCKED

ERROR_ENCRYPTED

ERROR_NONE

ERROR_NOT_SUPPORTED

ERROR_RESOURCE_UNAVAILABLE

ERROR_UNKNOWN

ERROR_UNKNOWN_CHANNEL

ERROR_WEAK_SIGNAL

INTENT_KEY_AD_SERVICE_ID

INTENT_KEY_CHANNEL_URI

INTENT_KEY_COMMAND_TYPE

INTENT_KEY_TV_INPUT_ID

SESSION_DATA_KEY_AD_BUFFER

SESSION_DATA_KEY_AD_REQUEST

SESSION_DATA_KEY_BROADCAST_INFO_REQUEST

SESSION_DATA_KEY_REQUEST_ID

SESSION_DATA_TYPE_AD_BUFFER_READY

SESSION_DATA_TYPE_AD_REQUEST

SESSION_DATA_TYPE_BROADCAST_INFO_REQUEST

SESSION_DATA_TYPE_REMOVE_BROADCAST_INFO_REQUEST

SESSION_STATE_ERROR

SESSION_STATE_RUNNING

SESSION_STATE_STOPPED

Public methods

getTvAdServiceList

registerCallback

sendAppLinkCommand

unregisterCallback