Peertube
/
NewPipe-app-android
mirror of https://github.com/TeamNewPipe/NewPipe/
1
0
Fork 0
Code Issues Releases Wiki Activity

Improve javadoc for `getAudioStreamFor`

This commit is contained in:
Stypox 2023-12-07 16:40:32 +01:00 committed by GitHub
parent 77bbbc88f8
commit ce30108efc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
app/src/main/java/org/schabi/newpipe/util/SecondaryStreamHelper.java
View File

@ -28,12 +28,15 @@ public class SecondaryStreamHelper<T extends Stream> {
} }
/** /**
* Find the correct audio stream for the desired video stream. * Finds an audio stream compatible with the provided video-only stream, so that the two streams
* can be combined in a single file by the downloader. If there are multiple available audio
* streams, chooses either the highest or the lowest quality one based on
* {@link ListHelper#isLimitingDataUsage(Context)}.
* *
* @param context Android context * @param context Android context
* @param audioStreams list of audio streams * @param audioStreams list of audio streams
* @param videoStream desired video ONLY stream * @param videoStream desired video-ONLY stream
* @return selected audio stream or null if a candidate was not found * @return the selected audio stream or null if a candidate was not found
*/ */
@Nullable @Nullable
public static AudioStream getAudioStreamFor(@NonNull final Context context, public static AudioStream getAudioStreamFor(@NonNull final Context context,