Skip to content

Commit

Permalink
Clarify setVideoEffect() javadoc
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 611147963
  • Loading branch information
claincly authored and copybara-github committed Feb 28, 2024
1 parent 87c4d60 commit 27d78e6
Showing 1 changed file with 6 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1566,9 +1566,10 @@ void setMediaSources(
* frame.
*
* <p>If {@linkplain #setVideoSurface passing a surface to the player directly}, the output
* resolution needs to be signaled by passing a renderer message with type {@link
* Renderer#MSG_SET_VIDEO_OUTPUT_RESOLUTION} after calling this method. For {@link SurfaceView},
* {@link TextureView} and {@link SurfaceHolder} output this happens automatically.
* resolution needs to be signaled by passing a {@linkplain #createMessage(PlayerMessage.Target)
* message} to the {@linkplain Renderer video renderer} with type {@link
* Renderer#MSG_SET_VIDEO_OUTPUT_RESOLUTION} after calling this method. For {@link SurfaceView}
* and {@link SurfaceHolder} output this happens automatically.
*
* <p>The following limitations exist for using {@linkplain Effect video effects}:
*
Expand All @@ -1579,7 +1580,8 @@ void setMediaSources(
* version as the rest of the {@code androidx.media3} modules being used by the app.
* <li>This feature works only with the default {@link MediaCodecVideoRenderer} and not custom
* or extension {@linkplain Renderer video renderers}.
* <li>This feature does not work with {@linkplain Effect effects} updating the timestamps.
* <li>This feature does not work with {@linkplain Effect effects} that update the frame
* timestamps.
* <li>This feature does not work with DRM-protected content.
* <li>This method should be called before calling {@link #prepare()}.
* </ul>
Expand Down

0 comments on commit 27d78e6

Please sign in to comment.