Add TvIAppManagerCallback (c524b1f3) · Commits · e / os / android_frameworks_base

media/java/android/media/tv/interactive/ITvIAppManager.aidl

+6 −0

Original line number	Diff line number	Diff line
		@@ -17,6 +17,8 @@
		package android.media.tv.interactive;

		import android.media.tv.interactive.ITvIAppClient;
		import android.media.tv.interactive.ITvIAppManagerCallback;
		import android.media.tv.interactive.TvIAppInfo;
		import android.view.Surface;

		/**
		@@ -24,6 +26,7 @@ import android.view.Surface;
		* @hide
		*/
		interface ITvIAppManager {
		List<TvIAppInfo> getTvIAppServiceList(int userId);
		void startIApp(in IBinder sessionToken, int userId);
		void createSession(
		in ITvIAppClient client, in String iAppServiceId, int type, int seq, int userId);
		@@ -31,4 +34,7 @@ interface ITvIAppManager {
		void setSurface(in IBinder sessionToken, in Surface surface, int userId);
		void dispatchSurfaceChanged(in IBinder sessionToken, int format, int width, int height,
		int userId);

		void registerCallback(in ITvIAppManagerCallback callback, int userId);
		void unregisterCallback(in ITvIAppManagerCallback callback, int userId);
		}
		No newline at end of file

media/java/android/media/tv/interactive/ITvIAppManagerCallback.aidl

0 → 100644

+30 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2021 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License.
		*/

		package android.media.tv.interactive;

		import android.media.tv.interactive.TvIAppInfo;

		/**
		* Interface to receive callbacks from ITvIAppManager regardless of sessions.
		* @hide
		*/
		interface ITvIAppManagerCallback {
		void onIAppServiceAdded(in String iAppServiceId);
		void onIAppServiceRemoved(in String iAppServiceId);
		void onIAppServiceUpdated(in String iAppServiceId);
		void onTvIAppInfoUpdated(in TvIAppInfo tvIAppInfo);
		}
		No newline at end of file

media/java/android/media/tv/interactive/TvIAppInfo.aidl

0 → 100644

+19 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2021 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License.
		*/

		package android.media.tv.interactive;

		parcelable TvIAppInfo;
		No newline at end of file

media/java/android/media/tv/interactive/TvIAppInfo.java

+8 −0

Original line number	Diff line number	Diff line
		@@ -89,6 +89,14 @@ public final class TvIAppInfo implements Parcelable {
		return mId;
		}

		/**
		* Returns the component of the TV IApp service.
		* @hide
		*/
		public ComponentName getComponent() {
		return new ComponentName(mService.serviceInfo.packageName, mService.serviceInfo.name);
		}

		/**
		* Returns the information of the service that implements this TV IApp service.
		*/

media/java/android/media/tv/interactive/TvIAppManager.java

+207 −0

Original line number	Diff line number	Diff line
		@@ -29,6 +29,10 @@ import android.view.Surface;

		import com.android.internal.util.Preconditions;

		import java.util.Iterator;
		import java.util.LinkedList;
		import java.util.List;

		/**
		* Central system API to the overall TV interactive application framework (TIAF) architecture, which
		* arbitrates interaction between applications and interactive apps.
		@@ -45,10 +49,15 @@ public final class TvIAppManager {
		private final SparseArray<SessionCallbackRecord> mSessionCallbackRecordMap =
		new SparseArray<>();

		// @GuardedBy("mLock")
		private final List<TvIAppCallbackRecord> mCallbackRecords = new LinkedList<>();

		// A sequence number for the next session to be created. Should be protected by a lock
		// {@code mSessionCallbackRecordMap}.
		private int mNextSeq;

		private final Object mLock = new Object();

		private final ITvIAppClient mClient;

		/** @hide */
		@@ -102,6 +111,154 @@ public final class TvIAppManager {
		}
		}
		};
		ITvIAppManagerCallback managerCallback = new ITvIAppManagerCallback.Stub() {
		// TODO: handle IApp service state changes
		@Override
		public void onIAppServiceAdded(String iAppServiceId) {
		synchronized (mLock) {
		for (TvIAppCallbackRecord record : mCallbackRecords) {
		record.postIAppServiceAdded(iAppServiceId);
		}
		}
		}

		@Override
		public void onIAppServiceRemoved(String iAppServiceId) {
		synchronized (mLock) {
		for (TvIAppCallbackRecord record : mCallbackRecords) {
		record.postIAppServiceRemoved(iAppServiceId);
		}
		}
		}

		@Override
		public void onIAppServiceUpdated(String iAppServiceId) {
		synchronized (mLock) {
		for (TvIAppCallbackRecord record : mCallbackRecords) {
		record.postIAppServiceUpdated(iAppServiceId);
		}
		}
		}

		@Override
		public void onTvIAppInfoUpdated(TvIAppInfo iAppInfo) {
		// TODO: add public API updateIAppInfo()
		synchronized (mLock) {
		for (TvIAppCallbackRecord record : mCallbackRecords) {
		record.postTvIAppInfoUpdated(iAppInfo);
		}
		}
		}
		};
		try {
		if (mService != null) {
		mService.registerCallback(managerCallback, mUserId);
		}
		} catch (RemoteException e) {
		throw e.rethrowFromSystemServer();
		}
		}

		/**
		* Callback used to monitor status of the TV IApp.
		* @hide
		*/
		public abstract static class TvIAppCallback {
		/**
		* This is called when a TV IApp service is added to the system.
		*
		* <p>Normally it happens when the user installs a new TV IApp service package that
		* implements {@link TvIAppService} interface.
		*
		* @param iAppServiceId The ID of the TV IApp service.
		*/
		public void onIAppServiceAdded(String iAppServiceId) {
		}

		/**
		* This is called when a TV IApp service is removed from the system.
		*
		* <p>Normally it happens when the user uninstalls the previously installed TV IApp service
		* package.
		*
		* @param iAppServiceId The ID of the TV IApp service.
		*/
		public void onIAppServiceRemoved(String iAppServiceId) {
		}

		/**
		* This is called when a TV IApp service is updated on the system.
		*
		* <p>Normally it happens when a previously installed TV IApp service package is
		* re-installed or a newer version of the package exists becomes available/unavailable.
		*
		* @param iAppServiceId The ID of the TV IApp service.
		*/
		public void onIAppServiceUpdated(String iAppServiceId) {
		}

		/**
		* This is called when the information about an existing TV IApp service has been updated.
		*
		* <p>Because the system automatically creates a <code>TvIAppInfo</code> object for each TV
		* IApp service based on the information collected from the
		* <code>AndroidManifest.xml</code>, this method is only called back when such information
		* has changed dynamically.
		*
		* @param iAppInfo The <code>TvIAppInfo</code> object that contains new information.
		*/
		public void onTvIAppInfoUpdated(TvIAppInfo iAppInfo) {
		}
		}

		private static final class TvIAppCallbackRecord {
		private final TvIAppCallback mCallback;
		private final Handler mHandler;

		TvIAppCallbackRecord(TvIAppCallback callback, Handler handler) {
		mCallback = callback;
		mHandler = handler;
		}

		public TvIAppCallback getCallback() {
		return mCallback;
		}

		public void postIAppServiceAdded(final String iAppServiceId) {
		mHandler.post(new Runnable() {
		@Override
		public void run() {
		mCallback.onIAppServiceAdded(iAppServiceId);
		}
		});
		}

		public void postIAppServiceRemoved(final String iAppServiceId) {
		mHandler.post(new Runnable() {
		@Override
		public void run() {
		mCallback.onIAppServiceRemoved(iAppServiceId);
		}
		});
		}

		public void postIAppServiceUpdated(final String iAppServiceId) {
		mHandler.post(new Runnable() {
		@Override
		public void run() {
		mCallback.onIAppServiceUpdated(iAppServiceId);
		}
		});
		}

		public void postTvIAppInfoUpdated(final TvIAppInfo iAppInfo) {
		mHandler.post(new Runnable() {
		@Override
		public void run() {
		mCallback.onTvIAppInfoUpdated(iAppInfo);
		}
		});
		}
		}

		/**
		@@ -138,6 +295,56 @@ public final class TvIAppManager {
		}
		}

		/**
		* Returns the complete list of TV IApp service on the system.
		*
		* @return List of {@link TvIAppInfo} for each TV IApp service that describes its meta
		* information.
		* @hide
		*/
		public List<TvIAppInfo> getTvIAppServiceList() {
		try {
		return mService.getTvIAppServiceList(mUserId);
		} catch (RemoteException e) {
		throw e.rethrowFromSystemServer();
		}
		}

		/**
		* Registers a {@link TvIAppManager.TvIAppCallback}.
		*
		* @param callback A callback used to monitor status of the TV IApp services.
		* @param handler A {@link Handler} that the status change will be delivered to.
		* @hide
		*/
		public void registerCallback(@NonNull TvIAppCallback callback, @NonNull Handler handler) {
		Preconditions.checkNotNull(callback);
		Preconditions.checkNotNull(handler);
		synchronized (mLock) {
		mCallbackRecords.add(new TvIAppCallbackRecord(callback, handler));
		}
		}

		/**
		* Unregisters the existing {@link TvIAppManager.TvIAppCallback}.
		*
		* @param callback The existing callback to remove.
		* @hide
		*/
		public void unregisterCallback(@NonNull final TvIAppCallback callback) {
		Preconditions.checkNotNull(callback);
		synchronized (mLock) {
		for (Iterator<TvIAppCallbackRecord> it = mCallbackRecords.iterator();
		it.hasNext(); ) {
		TvIAppCallbackRecord record = it.next();
		if (record.getCallback() == callback) {
		it.remove();
		break;
		}
		}
		}
		}

		/**
		* The Session provides the per-session functionality of interactive app.
		* @hide