Điều khiển nội dung nghe nhìn

Các nút điều khiển nội dung nghe nhìn trong Android nằm gần trình đơn Cài đặt nhanh. Các phiên hoạt động trong nhiều ứng dụng được sắp xếp trong một băng chuyền có thể vuốt. Băng chuyền liệt kê các phiên theo thứ tự sau:

• Các luồng phát trên điện thoại
• Luồng từ xa, chẳng hạn như luồng phát hiện thấy trên thiết bị bên ngoài hoặc phiên truyền
• Các phiên có thể tiếp tục trước đó, theo thứ tự phát lần gần đây nhất

Kể từ Android 13 (API cấp 33), để đảm bảo rằng người dùng có thể truy cập vào tập hợp nhiều chế độ điều khiển nội dung nghe nhìn cho các ứng dụng phát nội dung nghe nhìn, các nút hành động trên chế độ điều khiển nội dung nghe nhìn được lấy từ trạng thái Player.

Bằng cách này, bạn có thể trình bày một bộ chế độ điều khiển nội dung nghe nhìn nhất quán và trải nghiệm điều khiển nội dung nghe nhìn chỉn chu hơn trên các thiết bị.

Hình 1 cho thấy một ví dụ về giao diện tương ứng trên điện thoại và máy tính bảng.

Hệ thống sẽ hiển thị tối đa 5 nút hành động dựa trên trạng thái Player như mô tả trong bảng sau. Ở chế độ thu gọn, chỉ hiển thị 3 ô hành động đầu tiên. Điều này phù hợp với cách hiển thị các chế độ điều khiển nội dung nghe nhìn trong các nền tảng Android khác, chẳng hạn như Auto, Trợ lý và Wear OS.

Các lệnh tuỳ chỉnh được đặt theo thứ tự mà chúng được thêm vào bố cục tuỳ chỉnh.

Tuỳ chỉnh nút lệnh

Để tuỳ chỉnh các chế độ điều khiển nội dung nghe nhìn của hệ thống bằng Jetpack Media3, bạn có thể đặt bố cục tuỳ chỉnh của phiên và các lệnh có sẵn của bộ điều khiển cho phù hợp, khi triển khai MediaSessionService:

1. Trong onCreate(), hãy tạo một MediaSession và xác định bố cục tuỳ chỉnh của các nút lệnh.

2. Trong MediaSession.Callback.onConnect(), hãy uỷ quyền cho các đơn vị kiểm soát bằng cách xác định các lệnh có sẵn (bao gồm cả lệnh tuỳ chỉnh) trong ConnectionResult.

3. Trong MediaSession.Callback.onCustomCommand(), hãy phản hồi lệnh tuỳ chỉnh mà người dùng chọn.

class PlaybackService : MediaSessionService() {
  private val customCommandFavorites = SessionCommand(ACTION_FAVORITES, Bundle.EMPTY)
  private var mediaSession: MediaSession? = null

  override fun onCreate() {
    super.onCreate()
    val favoriteButton =
      CommandButton.Builder()
        .setDisplayName("Save to favorites")
        .setIconResId(R.drawable.favorite_icon)
        .setSessionCommand(customCommandFavorites)
        .build()
    val player = ExoPlayer.Builder(this).build()
    // Build the session with a custom layout.
    mediaSession =
      MediaSession.Builder(this, player)
        .setCallback(MyCallback())
        .setCustomLayout(ImmutableList.of(favoriteButton))
        .build()
  }

  private inner class MyCallback : MediaSession.Callback {
    override fun onConnect(
      session: MediaSession,
      controller: MediaSession.ControllerInfo
    ): ConnectionResult {
    // Set available player and session commands.
    return AcceptedResultBuilder(session)
      .setAvailablePlayerCommands(
        ConnectionResult.DEFAULT_PLAYER_COMMANDS.buildUpon()
          .remove(COMMAND_SEEK_TO_NEXT)
          .remove(COMMAND_SEEK_TO_NEXT_MEDIA_ITEM)
          .remove(COMMAND_SEEK_TO_PREVIOUS)
          .remove(COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM)
          .build()
      )
      .setAvailableSessionCommands(
        ConnectionResult.DEFAULT_SESSION_COMMANDS.buildUpon()
          .add(customCommandFavorites)
          .build()
      )
      .build()
    }

    override fun onCustomCommand(
      session: MediaSession,
      controller: MediaSession.ControllerInfo,
      customCommand: SessionCommand,
      args: Bundle
    ): ListenableFuture {
      if (customCommand.customAction == ACTION_FAVORITES) {
        // Do custom logic here
        saveToFavorites(session.player.currentMediaItem)
        return Futures.immediateFuture(SessionResult(SessionResult.RESULT_SUCCESS))
      }
      return super.onCustomCommand(session, controller, customCommand, args)
    }
  }
}

public class PlaybackService extends MediaSessionService {
  private static final SessionCommand CUSTOM_COMMAND_FAVORITES =
      new SessionCommand("ACTION_FAVORITES", Bundle.EMPTY);
  @Nullable private MediaSession mediaSession;

  public void onCreate() {
    super.onCreate();
    CommandButton favoriteButton =
        new CommandButton.Builder()
            .setDisplayName("Save to favorites")
            .setIconResId(R.drawable.favorite_icon)
            .setSessionCommand(CUSTOM_COMMAND_FAVORITES)
            .build();
    Player player = new ExoPlayer.Builder(this).build();
    // Build the session with a custom layout.
    mediaSession =
        new MediaSession.Builder(this, player)
            .setCallback(new MyCallback())
            .setCustomLayout(ImmutableList.of(favoriteButton))
            .build();
  }

  private static class MyCallback implements MediaSession.Callback {
    @Override
    public ConnectionResult onConnect(
        MediaSession session, MediaSession.ControllerInfo controller) {
      // Set available player and session commands.
      return new AcceptedResultBuilder(session)
          .setAvailablePlayerCommands(
              ConnectionResult.DEFAULT_PLAYER_COMMANDS.buildUpon()
                .remove(COMMAND_SEEK_TO_NEXT)
                .remove(COMMAND_SEEK_TO_NEXT_MEDIA_ITEM)
                .remove(COMMAND_SEEK_TO_PREVIOUS)
                .remove(COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM)
                .build())
          .setAvailableSessionCommands(
              ConnectionResult.DEFAULT_SESSION_COMMANDS.buildUpon()
                .add(CUSTOM_COMMAND_FAVORITES)
                .build())
          .build();
    }

    public ListenableFuture onCustomCommand(
        MediaSession session,
        MediaSession.ControllerInfo controller,
        SessionCommand customCommand,
        Bundle args) {
      if (customCommand.customAction.equals(CUSTOM_COMMAND_FAVORITES.customAction)) {
        // Do custom logic here
        saveToFavorites(session.getPlayer().getCurrentMediaItem());
        return Futures.immediateFuture(new SessionResult(SessionResult.RESULT_SUCCESS));
      }
      return MediaSession.Callback.super.onCustomCommand(
          session, controller, customCommand, args);
    }
  }
}

Để tìm hiểu thêm về cách định cấu hình MediaSession để các ứng dụng như hệ thống có thể kết nối với ứng dụng đa phương tiện của bạn, hãy xem bài viết Cấp quyền kiểm soát cho các ứng dụng khác.

Với Jetpack Media3, khi bạn triển khai MediaSession, PlaybackState của bạn sẽ tự động được cập nhật bằng trình phát nội dung nghe nhìn. Tương tự, khi bạn triển khai một MediaSessionService, thư viện sẽ tự động phát hành một thông báo MediaStyle cho bạn và luôn cập nhật thông báo đó.

Nút phản hồi hành động

Khi người dùng nhấn vào một nút hành động trong các nút điều khiển nội dung nghe nhìn của hệ thống, MediaController của hệ thống sẽ gửi một lệnh phát đến MediaSession. Sau đó, MediaSession uỷ quyền các lệnh đó cho người chơi. Các lệnh được xác định trong giao diện Player của Media3 sẽ được phiên phát nội dung đa phương tiện tự động xử lý.

Hãy tham khảo bài viết Thêm lệnh tuỳ chỉnh để biết hướng dẫn về cách phản hồi một lệnh tuỳ chỉnh.

Hành vi trước Android 13

Để có khả năng tương thích ngược, giao diện người dùng hệ thống tiếp tục cung cấp một bố cục thay thế sử dụng thao tác thông báo cho những ứng dụng không cập nhật để nhắm đến Android 13 hoặc không bao gồm thông tin PlaybackState. Các nút hành động được lấy từ danh sách Notification.Action đính kèm với thông báo MediaStyle. Hệ thống sẽ hiển thị tối đa 5 thao tác theo thứ tự thêm vào. Ở chế độ thu gọn, tối đa 3 nút sẽ hiển thị, được xác định bởi các giá trị được truyền vào setShowActionsInCompactView().

Các thao tác tuỳ chỉnh được sắp xếp theo thứ tự mà chúng được thêm vào PlaybackState.

Ví dụ về mã sau đây minh hoạ cách thêm thao tác vào thông báo MediaStyle :

import androidx.core.app.NotificationCompat
import androidx.media3.session.MediaStyleNotificationHelper

var notification = NotificationCompat.Builder(context, CHANNEL_ID)
        // Show controls on lock screen even when user hides sensitive content.
        .setVisibility(NotificationCompat.VISIBILITY_PUBLIC)
        .setSmallIcon(R.drawable.ic_stat_player)
        // Add media control buttons that invoke intents in your media service
        .addAction(R.drawable.ic_prev, "Previous", prevPendingIntent) // #0
        .addAction(R.drawable.ic_pause, "Pause", pausePendingIntent) // #1
        .addAction(R.drawable.ic_next, "Next", nextPendingIntent) // #2
        // Apply the media style template
        .setStyle(MediaStyleNotificationHelper.MediaStyle(mediaSession)
                .setShowActionsInCompactView(1 /* #1: pause button */))
        .setContentTitle("Wonderful music")
        .setContentText("My Awesome Band")
        .setLargeIcon(albumArtBitmap)
        .build()

import androidx.core.app.NotificationCompat;
import androidx.media3.session.MediaStyleNotificationHelper;

NotificationCompat.Builder notification = new NotificationCompat.Builder(context, CHANNEL_ID)
        .setVisibility(NotificationCompat.VISIBILITY_PUBLIC)
        .setSmallIcon(R.drawable.ic_stat_player)
        .addAction(R.drawable.ic_prev, "Previous", prevPendingIntent)
        .addAction(R.drawable.ic_pause, "Pause", pausePendingIntent)
        .addAction(R.drawable.ic_next, "Next", nextPendingIntent)
        .setStyle(new MediaStyleNotificationHelper.MediaStyle(mediaSession)
                .setShowActionsInCompactView(1 /* #1: pause button */))
        .setContentTitle("Wonderful music")
        .setContentText("My Awesome Band")
        .setLargeIcon(albumArtBitmap)
        .build();

Hỗ trợ tiếp tục phát nội dung nghe nhìn

Việc tiếp tục phát nội dung nghe nhìn cho phép người dùng khởi động lại các phiên trước đó từ băng chuyền mà không cần phải khởi động ứng dụng. Khi quá trình phát bắt đầu, người dùng sẽ tương tác với các chế độ điều khiển nội dung nghe nhìn theo cách thông thường.

Bạn có thể bật và tắt tính năng tiếp tục phát bằng ứng dụng Cài đặt trong phần Âm thanh > Nội dung nghe nhìn. Người dùng cũng có thể truy cập vào phần Cài đặt bằng cách nhấn vào biểu tượng bánh răng xuất hiện sau khi vuốt trên băng chuyền mở rộng.

Media3 cung cấp các API để hỗ trợ việc tiếp tục phát nội dung nghe nhìn dễ dàng hơn. Hãy xem tài liệu về Tiếp tục phát với Media3 để được hướng dẫn về cách triển khai tính năng này.

Sử dụng API đa phương tiện cũ

Phần này giải thích cách tích hợp với các chế độ điều khiển nội dung nghe nhìn của hệ thống bằng các API MediaCompat cũ.

Hệ thống sẽ truy xuất thông tin sau đây từ MediaMetadata của MediaSession và hiển thị thông tin này khi có:

• METADATA_KEY_ALBUM_ART_URI
• METADATA_KEY_TITLE
• METADATA_KEY_DISPLAY_TITLE
• METADATA_KEY_ARTIST
• METADATA_KEY_DURATION (Nếu bạn không đặt thời lượng, thì thanh tua sẽ không hiển thị tiến trình)

Để đảm bảo bạn nhận được thông báo hợp lệ và chính xác về chế độ kiểm soát nội dung nghe nhìn, hãy đặt giá trị của siêu dữ liệu METADATA_KEY_TITLE hoặc METADATA_KEY_DISPLAY_TITLE thành tiêu đề của nội dung nghe nhìn đang phát.

Trình phát nội dung đa phương tiện hiển thị thời gian đã trôi qua cho nội dung nghe nhìn đang phát, cùng với thanh tìm kiếm được liên kết với MediaSession PlaybackState.

Trình phát nội dung đa phương tiện hiển thị tiến trình của nội dung nghe nhìn đang phát, cùng với thanh tua được liên kết với MediaSession PlaybackState. Thanh tìm kiếm cho phép người dùng thay đổi vị trí và hiển thị thời gian đã trôi qua cho mục nội dung đa phương tiện. Để bật thanh tua, bạn phải triển khai PlaybackState.Builder#setActions và đưa ACTION_SEEK_TO vào.

Thêm các thao tác chuẩn

Các ví dụ về mã sau đây minh hoạ cách thêm các thao tác tiêu chuẩn và tuỳ chỉnh PlaybackState.

Để phát, tạm dừng, trước đó và tiếp theo, hãy đặt các hành động này trong PlaybackState cho phiên phát nội dung đa phương tiện.

val session = MediaSessionCompat(context, TAG)
val playbackStateBuilder = PlaybackStateCompat.Builder()
val style = NotificationCompat.MediaStyle()

// For this example, the media is currently paused:
val state = PlaybackStateCompat.STATE_PAUSED
val position = 0L
val playbackSpeed = 1f
playbackStateBuilder.setState(state, position, playbackSpeed)

// And the user can play, skip to next or previous, and seek
val stateActions = PlaybackStateCompat.ACTION_PLAY
    or PlaybackStateCompat.ACTION_PLAY_PAUSE
    or PlaybackStateCompat.ACTION_SKIP_TO_PREVIOUS
    or PlaybackStateCompat.ACTION_SKIP_TO_NEXT
    or PlaybackStateCompat.ACTION_SEEK_TO // adding the seek action enables seeking with the seekbar
playbackStateBuilder.setActions(stateActions)

// ... do more setup here ...

session.setPlaybackState(playbackStateBuilder.build())
style.setMediaSession(session.sessionToken)
notificationBuilder.setStyle(style)

MediaSessionCompat session = new MediaSessionCompat(context, TAG);
PlaybackStateCompat.Builder playbackStateBuilder = new PlaybackStateCompat.Builder();
NotificationCompat.MediaStyle style = new NotificationCompat.MediaStyle();

// For this example, the media is currently paused:
int state = PlaybackStateCompat.STATE_PAUSED;
long position = 0L;
float playbackSpeed = 1f;
playbackStateBuilder.setState(state, position, playbackSpeed);

// And the user can play, skip to next or previous, and seek
long stateActions = PlaybackStateCompat.ACTION_PLAY
    | PlaybackStateCompat.ACTION_PLAY_PAUSE
    | PlaybackStateCompat.ACTION_SKIP_TO_PREVIOUS
    | PlaybackStateCompat.ACTION_SKIP_TO_NEXT
    | PlaybackStateCompat.ACTION_SEEK_TO; // adding this enables the seekbar thumb
playbackStateBuilder.setActions(stateActions);

// ... do more setup here ...

session.setPlaybackState(playbackStateBuilder.build());
style.setMediaSession(session.getSessionToken());
notificationBuilder.setStyle(style);

Nếu bạn không muốn thêm nút nào trong các ô trước đó hoặc tiếp theo, đừng thêm ACTION_SKIP_TO_PREVIOUS hoặc ACTION_SKIP_TO_NEXT mà thay vào đó hãy thêm các phần bổ sung vào phiên:

session.setExtras(Bundle().apply {
    putBoolean(SESSION_EXTRAS_KEY_SLOT_RESERVATION_SKIP_TO_PREV, true)
    putBoolean(SESSION_EXTRAS_KEY_SLOT_RESERVATION_SKIP_TO_NEXT, true)
})

Bundle extras = new Bundle();
extras.putBoolean(SESSION_EXTRAS_KEY_SLOT_RESERVATION_SKIP_TO_PREV, true);
extras.putBoolean(SESSION_EXTRAS_KEY_SLOT_RESERVATION_SKIP_TO_NEXT, true);
session.setExtras(extras);

Thêm thao tác tuỳ chỉnh

Đối với các thao tác khác mà bạn muốn hiện trên các chế độ điều khiển nội dung nghe nhìn, bạn có thể tạo PlaybackStateCompat.CustomAction rồi thêm biểu tượng đó vào PlaybackState. Những hành động này sẽ hiển thị theo thứ tự thêm vào.

val customAction = PlaybackStateCompat.CustomAction.Builder(
    "com.example.MY_CUSTOM_ACTION", // action ID
    "Custom Action", // title - used as content description for the button
    R.drawable.ic_custom_action
).build()

playbackStateBuilder.addCustomAction(customAction)

PlaybackStateCompat.CustomAction customAction = new PlaybackStateCompat.CustomAction.Builder(
        "com.example.MY_CUSTOM_ACTION", // action ID
        "Custom Action", // title - used as content description for the button
        R.drawable.ic_custom_action
).build();

playbackStateBuilder.addCustomAction(customAction);

Phản hồi các thao tác PlaybackState

Khi người dùng nhấn vào một nút, SystemUI sẽ sử dụng MediaController.TransportControls để gửi lệnh trở lại MediaSession. Bạn cần đăng ký một lệnh gọi lại có thể phản hồi đúng cách với những sự kiện này.

val callback = object: MediaSession.Callback() {
    override fun onPlay() {
        // start playback
    }

    override fun onPause() {
        // pause playback
    }

    override fun onSkipToPrevious() {
        // skip to previous
    }

    override fun onSkipToNext() {
        // skip to next
    }

    override fun onSeekTo(pos: Long) {
        // jump to position in track
    }

    override fun onCustomAction(action: String, extras: Bundle?) {
        when (action) {
            CUSTOM_ACTION_1 -> doCustomAction1(extras)
            CUSTOM_ACTION_2 -> doCustomAction2(extras)
            else -> {
                Log.w(TAG, "Unknown custom action $action")
            }
        }
    }

}

session.setCallback(callback)

MediaSession.Callback callback = new MediaSession.Callback() {
    @Override
    public void onPlay() {
        // start playback
    }

    @Override
    public void onPause() {
        // pause playback
    }

    @Override
    public void onSkipToPrevious() {
        // skip to previous
    }

    @Override
    public void onSkipToNext() {
        // skip to next
    }

    @Override
    public void onSeekTo(long pos) {
        // jump to position in track
    }

    @Override
    public void onCustomAction(String action, Bundle extras) {
        if (action.equals(CUSTOM_ACTION_1)) {
            doCustomAction1(extras);
        } else if (action.equals(CUSTOM_ACTION_2)) {
            doCustomAction2(extras);
        } else {
            Log.w(TAG, "Unknown custom action " + action);
        }
    }
};

Tiếp tục phát nội dung nghe nhìn

Để ứng dụng trình phát của bạn xuất hiện trong khu vực cài đặt nhanh, bạn phải tạo thông báo MediaStyle có mã thông báo MediaSession hợp lệ.

Để hiển thị tiêu đề cho thông báo MediaStyle, hãy sử dụng NotificationBuilder.setContentTitle().

Để hiển thị biểu tượng thương hiệu cho trình phát nội dung đa phương tiện, hãy sử dụng NotificationBuilder.setSmallIcon().

Để hỗ trợ tiếp tục phát, các ứng dụng phải triển khai một MediaBrowserService và MediaSession. MediaSession của bạn phải triển khai lệnh gọi lại onPlay().

Cách triển khai MediaBrowserService

Sau khi thiết bị khởi động, hệ thống sẽ tìm 5 ứng dụng đa phương tiện được sử dụng gần đây nhất và cung cấp các chế độ điều khiển có thể dùng để bắt đầu lại quá trình phát từ mỗi ứng dụng.

Hệ thống sẽ cố gắng kết nối với MediaBrowserService của bạn bằng thông tin kết nối qua SystemUI. Ứng dụng của bạn phải cho phép các kết nối như vậy, nếu không, ứng dụng sẽ không thể hỗ trợ tiếp tục phát.

Bạn có thể xác định và xác minh các kết nối từ SystemUI bằng cách sử dụng tên gói com.android.systemui và chữ ký. SystemUI được ký bằng chữ ký của nền tảng. Bạn có thể xem ví dụ về cách kiểm tra chữ ký của nền tảng trong ứng dụng UAMP.

Để hỗ trợ việc tiếp tục phát, MediaBrowserService của bạn phải triển khai các hành vi sau:

• onGetRoot() phải nhanh chóng trả về một gốc khác rỗng. Logic phức tạp khác sẽ được xử lý trong onLoadChildren()

• Khi onLoadChildren() được gọi trên mã nhận dạng nội dung nghe nhìn gốc, kết quả phải chứa một phần tử con FLAG_PLAYABLE.

• MediaBrowserService sẽ trả về mục nội dung đa phương tiện được phát gần đây nhất khi nhận được truy vấn EXTRA_nội dung. Giá trị được trả về phải là một mục nội dung đa phương tiện thực tế thay vì hàm chung.

• MediaBrowserService phải cung cấp một MediaDescription thích hợp với một tiêu đề và phụ đề không để trống. Thao tác này cũng nên đặt URI biểu tượng hoặc Bitmap biểu tượng.

Các mã ví dụ sau đây minh hoạ cách triển khai onGetRoot().

override fun onGetRoot(
    clientPackageName: String,
    clientUid: Int,
    rootHints: Bundle?
): BrowserRoot? {
    ...
    // Verify that the specified package is SystemUI. You'll need to write your 
    // own logic to do this.
    if (isSystem(clientPackageName, clientUid)) {
        rootHints?.let {
            if (it.getBoolean(BrowserRoot.EXTRA_RECENT)) {
                // Return a tree with a single playable media item for resumption.
                val extras = Bundle().apply {
                    putBoolean(BrowserRoot.EXTRA_RECENT, true)
                }
                return BrowserRoot(MY_RECENTS_ROOT_ID, extras)
            }
        }
        // You can return your normal tree if the EXTRA_RECENT flag is not present.
        return BrowserRoot(MY_MEDIA_ROOT_ID, null)
    }
    // Return an empty tree to disallow browsing.
    return BrowserRoot(MY_EMPTY_ROOT_ID, null)

@Override
public BrowserRoot onGetRoot(String clientPackageName, int clientUid,
    Bundle rootHints) {
    ...
    // Verify that the specified package is SystemUI. You'll need to write your
    // own logic to do this.
    if (isSystem(clientPackageName, clientUid)) {
        if (rootHints != null) {
            if (rootHints.getBoolean(BrowserRoot.EXTRA_RECENT)) {
                // Return a tree with a single playable media item for resumption.
                Bundle extras = new Bundle();
                extras.putBoolean(BrowserRoot.EXTRA_RECENT, true);
                return new BrowserRoot(MY_RECENTS_ROOT_ID, extras);
            }
        }
        // You can return your normal tree if the EXTRA_RECENT flag is not present.
        return new BrowserRoot(MY_MEDIA_ROOT_ID, null);
    }
    // Return an empty tree to disallow browsing.
    return new BrowserRoot(MY_EMPTY_ROOT_ID, null);
}