Add ExoPlayer.setVirtualDeviceId

This allows to dynamically override the virtual device id after
the player is created. The initial value is obtained from the
Context passed to the player.

PiperOrigin-RevId: 819770420

Author: tonihei

RELEASENOTES.md

@@ -40,6 +40,8 @@
     *   Enable wake lock handling by default to fix issues with buffering during
         background playback. This is equivalent to setting
         `ExoPlayer.Builder.setWakeMode` to `C.WAKE_MODE_LOCAL`.
+    *   Add `ExoPlayer.setVirtualDeviceId` to update the virtual device ID
+        originally obtained from the `Context` passed to `ExoPlayer.Builder`.
     *   Ensure renderers don't consume data from the next playlist item more
         than 10 seconds before the end of the current item.
     *   Add `setSeekBackIncrementMs`, `setSeekForwardIncrementMs` and

libraries/exoplayer/src/main/java/androidx/media3/exoplayer/ExoPlayer.java

@@ -21,6 +21,7 @@
 import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.base.Preconditions.checkState;
 
+import android.companion.virtual.VirtualDevice;
 import android.content.Context;
 import android.media.AudioDeviceInfo;
 import android.media.AudioTrack;
@@ -1597,6 +1598,18 @@ void setMediaSources(
   @UnstableApi
   void setPreferredAudioDevice(@Nullable AudioDeviceInfo audioDeviceInfo);
 
+  /**
+   * Sets the virtual device id to be used for playback.
+   *
+   * <p>Note that the initial value is obtained from {@link Context#getDeviceId()} from the {@link
+   * Context} passed to {@link Builder#Builder(Context)}.
+   *
+   * @param virtualDeviceId The {@linkplain VirtualDevice#getDeviceId() virtual device id}, or
+   *     {@link C#INDEX_UNSET} if unspecified.
+   */
+  @UnstableApi
+  void setVirtualDeviceId(int virtualDeviceId);
+
   /**
    * Sets whether skipping silences in the audio stream is enabled.
    *

libraries/exoplayer/src/main/java/androidx/media3/exoplayer/ExoPlayerImpl.java

@@ -34,6 +34,7 @@
 import static androidx.media3.exoplayer.Renderer.MSG_SET_SKIP_SILENCE_ENABLED;
 import static androidx.media3.exoplayer.Renderer.MSG_SET_VIDEO_EFFECTS;
 import static androidx.media3.exoplayer.Renderer.MSG_SET_VIDEO_OUTPUT_RESOLUTION;
+import static androidx.media3.exoplayer.Renderer.MSG_SET_VIRTUAL_DEVICE_ID;
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.base.Preconditions.checkState;
@@ -1612,6 +1613,12 @@ public void setPreferredAudioDevice(@Nullable AudioDeviceInfo audioDeviceInfo) {
     sendRendererMessage(TRACK_TYPE_AUDIO, MSG_SET_PREFERRED_AUDIO_DEVICE, audioDeviceInfo);
   }
 
+  @Override
+  public void setVirtualDeviceId(int virtualDeviceId) {
+    verifyApplicationThread();
+    sendRendererMessage(TRACK_TYPE_AUDIO, MSG_SET_VIRTUAL_DEVICE_ID, virtualDeviceId);
+  }
+
   @Override
   public void setVolume(float volume) {
     verifyApplicationThread();

libraries/exoplayer/src/main/java/androidx/media3/exoplayer/Renderer.java

@@ -372,6 +372,13 @@ interface WakeupListener {
    */
   int MSG_SET_SCRUBBING_MODE = 18;
 
+  /**
+   * The type of a message that can be passed to audio renderers via {@link
+   * ExoPlayer#createMessage(PlayerMessage.Target)}. The message payload should be an {@link
+   * Integer} instance representing the virtual device id, or {@link C#INDEX_UNSET} if unspecified.
+   */
+  int MSG_SET_VIRTUAL_DEVICE_ID = 19;
+
   /**
    * Applications or extensions may define custom {@code MSG_*} constants that can be passed to
    * renderers. These custom constants must be greater than or equal to this value.

libraries/exoplayer/src/main/java/androidx/media3/exoplayer/SimpleExoPlayer.java

@@ -590,6 +590,12 @@ public void setPreferredAudioDevice(@Nullable AudioDeviceInfo audioDeviceInfo) {
     player.setPreferredAudioDevice(audioDeviceInfo);
   }
 
+  @Override
+  public void setVirtualDeviceId(int virtualDeviceId) {
+    blockUntilConstructorFinished();
+    player.setVirtualDeviceId(virtualDeviceId);
+  }
+
   @Override
   public void setVolume(float volume) {
     blockUntilConstructorFinished();

libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/AudioSink.java

@@ -17,6 +17,7 @@
 
 import static java.lang.annotation.ElementType.TYPE_USE;
 
+import android.companion.virtual.VirtualDevice;
 import android.media.AudioDeviceInfo;
 import android.media.AudioTrack;
 import androidx.annotation.IntDef;
@@ -604,6 +605,14 @@ boolean handleBuffer(ByteBuffer buffer, long presentationTimeUs, int encodedAcce
    */
   default void setPreferredDevice(@Nullable AudioDeviceInfo audioDeviceInfo) {}
 
+  /**
+   * Sets the virtual device id.
+   *
+   * @param virtualDeviceId The {@linkplain VirtualDevice#getDeviceId() virtual device id}, or
+   *     {@link C#INDEX_UNSET} if unspecified.
+   */
+  default void setVirtualDeviceId(int virtualDeviceId) {}
+
   /**
    * Sets the offset that is added to the media timestamp before it is passed as {@code
    * presentationTimeUs} in {@link #handleBuffer(ByteBuffer, long, int)}.

libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/DecoderAudioRenderer.java

@@ -84,6 +84,11 @@
  *   <li>Message with type {@link #MSG_SET_AUX_EFFECT_INFO} to set the auxiliary effect. The message
  *       payload should be an {@link AuxEffectInfo} instance that will configure the underlying
  *       audio track.
+ *   <li>Message with type {@link #MSG_SET_PREFERRED_AUDIO_DEVICE} to set the preferred audio output
+ *       device. The message payload should be an {@link AudioDeviceInfo} instance.
+ *   <li>Message with type {@link #MSG_SET_VIRTUAL_DEVICE_ID} to set the virtual device id. The
+ *       message payload should be an {@link Integer} for the virtual device id or {@link
+ *       C#INDEX_UNSET} if unspecified.
  *   <li>Message with type {@link #MSG_SET_SKIP_SILENCE_ENABLED} to enable or disable skipping
  *       silences. The message payload should be a {@link Boolean}.
  *   <li>Message with type {@link #MSG_SET_AUDIO_SESSION_ID} to set the audio session ID. The
@@ -760,6 +765,9 @@ public void handleMessage(@MessageType int messageType, @Nullable Object message
       case MSG_SET_PREFERRED_AUDIO_DEVICE:
         audioSink.setPreferredDevice((AudioDeviceInfo) message);
         break;
+      case MSG_SET_VIRTUAL_DEVICE_ID:
+        audioSink.setVirtualDeviceId((Integer) checkNotNull(message));
+        break;
       case MSG_SET_CAMERA_MOTION_LISTENER:
       case MSG_SET_CHANGE_FRAME_RATE_STRATEGY:
       case MSG_SET_SCALING_MODE:

libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/DefaultAudioSink.java

@@ -508,7 +508,6 @@ public DefaultAudioSink build() {
       initializationExceptionPendingExceptionHolder;
   private final PendingExceptionHolder<WriteException> writeExceptionPendingExceptionHolder;
   @Nullable private final AudioOffloadListener audioOffloadListener;
-  private final int virtualDeviceId;
 
   @Nullable private PlayerId playerId;
   @Nullable private Listener listener;
@@ -547,6 +546,7 @@ public DefaultAudioSink build() {
   private boolean pendingAudioSessionIdChangeConfirmation;
   private AuxEffectInfo auxEffectInfo;
   @Nullable private AudioDeviceInfo preferredDevice;
+  private int virtualDeviceId;
   private boolean tunneling;
   private long lastFeedElapsedRealtimeMs;
   private boolean offloadDisabledUntilNextConfiguration;
@@ -1296,6 +1296,16 @@ public void setPreferredDevice(@Nullable AudioDeviceInfo audioDeviceInfo) {
     }
   }
 
+  @Override
+  public void setVirtualDeviceId(int virtualDeviceId) {
+    virtualDeviceId = resolveDefaultVirtualDeviceIds(virtualDeviceId);
+    if (this.virtualDeviceId == virtualDeviceId) {
+      return;
+    }
+    this.virtualDeviceId = virtualDeviceId;
+    reconfigureAndFlush();
+  }
+
   @Override
   public long getAudioTrackBufferSizeUs() {
     if (!isAudioOutputInitialized()) {
@@ -1763,7 +1773,10 @@ private static boolean hasPendingAudioOutputReleases() {
 
   @RequiresApi(34)
   private static int getDeviceIdFromContext(Context context) {
-    int deviceId = context.getDeviceId();
+    return resolveDefaultVirtualDeviceIds(context.getDeviceId());
+  }
+
+  private static int resolveDefaultVirtualDeviceIds(int deviceId) {
     return deviceId != Context.DEVICE_ID_DEFAULT && deviceId != Context.DEVICE_ID_INVALID
         ? deviceId
         : C.INDEX_UNSET;

libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/ForwardingAudioSink.java

@@ -156,6 +156,11 @@ public void setPreferredDevice(@Nullable AudioDeviceInfo audioDeviceInfo) {
     sink.setPreferredDevice(audioDeviceInfo);
   }
 
+  @Override
+  public void setVirtualDeviceId(int virtualDeviceId) {
+    sink.setVirtualDeviceId(virtualDeviceId);
+  }
+
   @Override
   public void setOutputStreamOffsetUs(long outputStreamOffsetUs) {
     sink.setOutputStreamOffsetUs(outputStreamOffsetUs);

libraries/exoplayer/src/main/java/androidx/media3/exoplayer/audio/MediaCodecAudioRenderer.java

@@ -92,6 +92,9 @@
  *       audio track.
  *   <li>Message with type {@link #MSG_SET_PREFERRED_AUDIO_DEVICE} to set the preferred audio output
  *       device. The message payload should be an {@link AudioDeviceInfo} instance.
+ *   <li>Message with type {@link #MSG_SET_VIRTUAL_DEVICE_ID} to set the virtual device id. The
+ *       message payload should be an {@link Integer} for the virtual device id or {@link
+ *       C#INDEX_UNSET} if unspecified.
  *   <li>Message with type {@link #MSG_SET_SKIP_SILENCE_ENABLED} to enable or disable skipping
  *       silences. The message payload should be a {@link Boolean}.
  *   <li>Message with type {@link #MSG_SET_AUDIO_SESSION_ID} to set the audio session ID. The
@@ -930,6 +933,9 @@ public void handleMessage(@MessageType int messageType, @Nullable Object message
       case MSG_SET_PREFERRED_AUDIO_DEVICE:
         audioSink.setPreferredDevice((AudioDeviceInfo) message);
         break;
+      case MSG_SET_VIRTUAL_DEVICE_ID:
+        audioSink.setVirtualDeviceId((Integer) checkNotNull(message));
+        break;
       case MSG_SET_SKIP_SILENCE_ENABLED:
         audioSink.setSkipSilenceEnabled((Boolean) checkNotNull(message));
         break;