From aa61d163908eb5c46a806dd2b7186c0c68fa3111 Mon Sep 17 00:00:00 2001 From: Robert Wu Date: Fri, 21 Jul 2023 17:57:01 +0000 Subject: [PATCH] MIDI: Update MidiDeviceService docs We recently added MidiUmpDeviceService. This CL updates MidiDeviceService docs to match the new service. Bug: 292252557 Test: presubmit Change-Id: Ibe19f1bfa35ceb3c5212814320c562b83acc1010 --- .../android/media/midi/MidiDeviceService.java | 19 ++++++++++--------- .../media/midi/MidiUmpDeviceService.java | 4 ++-- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/media/java/android/media/midi/MidiDeviceService.java b/media/java/android/media/midi/MidiDeviceService.java index 388d95bba16b1..96540a22c9785 100644 --- a/media/java/android/media/midi/MidiDeviceService.java +++ b/media/java/android/media/midi/MidiDeviceService.java @@ -34,15 +34,15 @@ import android.util.Log; *

To extend this class, you must declare the service in your manifest file with * an intent filter with the {@link #SERVICE_INTERFACE} action * and meta-data to describe the virtual device. - For example:

+ * For example:

*
  * <service android:name=".VirtualDeviceService"
- *          android:label="@string/service_name">
+ *         android:label="@string/service_name">
  *     <intent-filter>
- *         <action android:name="android.media.midi.MidiDeviceService" />
+ *             <action android:name="android.media.midi.MidiDeviceService" />
  *     </intent-filter>
- *           <meta-data android:name="android.media.midi.MidiDeviceService"
-                android:resource="@xml/device_info" />
+ *     <meta-data android:name="android.media.midi.MidiDeviceService"
+ *             android:resource="@xml/device_info" />
  * </service>
*/ abstract public class MidiDeviceService extends Service { @@ -114,8 +114,8 @@ abstract public class MidiDeviceService extends Service { } /** - * returns the {@link MidiDeviceInfo} instance for this service - * @return our MidiDeviceInfo + * Returns the {@link MidiDeviceInfo} instance for this service + * @return the MidiDeviceInfo of the virtual MIDI device */ public final MidiDeviceInfo getDeviceInfo() { return mDeviceInfo; @@ -123,13 +123,14 @@ abstract public class MidiDeviceService extends Service { /** * Called to notify when an our {@link MidiDeviceStatus} has changed - * @param status the number of the port that was opened + * @param status the current status of the MIDI device */ public void onDeviceStatusChanged(MidiDeviceStatus status) { } /** - * Called to notify when our device has been closed by all its clients + * Called to notify when the virtual MIDI device running in this service has been closed by + * all its clients */ public void onClose() { } diff --git a/media/java/android/media/midi/MidiUmpDeviceService.java b/media/java/android/media/midi/MidiUmpDeviceService.java index d189e3a88f032..0c6096ecad4dc 100644 --- a/media/java/android/media/midi/MidiUmpDeviceService.java +++ b/media/java/android/media/midi/MidiUmpDeviceService.java @@ -48,9 +48,9 @@ import java.util.List; * <service android:name=".VirtualDeviceService" * android:label="@string/service_name"> * <intent-filter> - * <action android:name="android.media.midi.MidiUmpDeviceService" /> + * <action android:name="android.media.midi.MidiUmpDeviceService" /> * </intent-filter> - * <property android:name="android.media.midi.MidiUmpDeviceService" + * <property android:name="android.media.midi.MidiUmpDeviceService" * android:resource="@xml/device_info" /> * </service> */