Skip to content
This repository has been archived by the owner on Jan 6, 2025. It is now read-only.

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tanersener committed Mar 3, 2021
1 parent 33acf34 commit 2cf5f9f
Show file tree
Hide file tree
Showing 1,204 changed files with 284,248 additions and 638 deletions.
582 changes: 81 additions & 501 deletions README.md

Large diffs are not rendered by default.

169 changes: 118 additions & 51 deletions android/ffmpeg-kit-android-lib/Doxyfile

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions android/ffmpeg-kit-android-lib/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ task javadoc(type: Javadoc) {
destinationDir = file("${projectDir}/../../docs/android/javadoc")
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
source = android.sourceSets.main.java.srcDirs
configurations.implementation.setCanBeResolved(true)
classpath += configurations.implementation
}

dependencies {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@
import java.util.concurrent.atomic.AtomicReference;

/**
* <p>Configuration class of <code>FFmpegKit</code> library. Allows customizing the global library
* options. Provides helper methods to support additional resources.
* <p>Configuration class of <code>FFmpegKit</code> library.
*/
public class FFmpegKitConfig {

Expand Down Expand Up @@ -488,7 +487,7 @@ public static void closeFFmpegPipe(final String ffmpegPipePath) {
* Returns the list of camera ids supported. These devices can be used in <code>FFmpeg</code>
* commands.
*
* <p>Note that this method requires API Level >= 24. On older API levels it returns an empty
* <p>Note that this method requires API Level &ge; 24. On older API levels it returns an empty
* list.
*
* @param context application context
Expand Down Expand Up @@ -878,8 +877,10 @@ private static String getSafParameter(final Context context, final Uri uri, fina
* <p>Converts the given Structured Access Framework Uri (<code>"content:…"</code>) into an
* input url that can be used in FFmpeg and FFprobe commands.
*
* <p>Requires API Level >= 19. On older API levels it returns an empty url.
* <p>Requires API Level &ge; 19. On older API levels it returns an empty url.
*
* @param context application context
* @param uri saf uri
* @return input url that can be passed to FFmpegKit or FFprobeKit
*/
public static String getSafParameterForRead(final Context context, final Uri uri) {
Expand All @@ -890,8 +891,10 @@ public static String getSafParameterForRead(final Context context, final Uri uri
* <p>Converts the given Structured Access Framework Uri (<code>"content:…"</code>) into an
* output url that can be used in FFmpeg and FFprobe commands.
*
* <p>Requires API Level >= 19. On older API levels it returns an empty url.
* <p>Requires API Level &ge; 19. On older API levels it returns an empty url.
*
* @param context application context
* @param uri saf uri
* @return output url that can be passed to FFmpegKit or FFprobeKit
*/
public static String getSafParameterForWrite(final Context context, final Uri uri) {
Expand Down Expand Up @@ -1065,6 +1068,7 @@ static List<FFprobeSession> getFFprobeSessions() {
/**
* <p>Returns sessions that have the given state.
*
* @param state session state
* @return sessions that have the given state from the session history
*/
public static List<Session> getSessionsByState(final SessionState state) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* </pre>
* <p>It can extract media information for a file or a url, using {@link #getMediaInformation(String)} method.
* <pre>
* MediaInformationSession session = FFprobeKit.getMediaInformation("file1.mp4");
* MediaInformationSession session = FFprobeKit.getMediaInformation("file1.mp4");
* </pre>
*/
public class FFprobeKit {
Expand Down
6 changes: 3 additions & 3 deletions apple.sh
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,9 @@ if [[ -f ${XCODE_FOR_FFMPEG_KIT} ]]; then
fi

# DETECT SDK VERSIONS
DETECTED_IOS_SDK_VERSION="$(xcrun --sdk iphoneos --show-sdk-version)"
DETECTED_TVOS_SDK_VERSION="$(xcrun --sdk appletvos --show-sdk-version)"
DETECTED_MACOS_SDK_VERSION="$(xcrun --sdk macosx --show-sdk-version)"
DETECTED_IOS_SDK_VERSION="$(xcrun --sdk iphoneos --show-sdk-version 2>>"${BASEDIR}"/build.log)"
DETECTED_TVOS_SDK_VERSION="$(xcrun --sdk appletvos --show-sdk-version 2>>"${BASEDIR}"/build.log)"
DETECTED_MACOS_SDK_VERSION="$(xcrun --sdk macosx --show-sdk-version 2>>"${BASEDIR}"/build.log)"
echo -e "INFO: Using iOS SDK: ${DETECTED_IOS_SDK_VERSION}, tvOS SDK: ${DETECTED_TVOS_SDK_VERSION}, macOS SDK: ${DETECTED_MACOS_SDK_VERSION} by Xcode provided at $(xcode-select -p)\n" 1>>"${BASEDIR}"/build.log 2>&1
echo -e "INFO: Build options: $*\n" 1>>"${BASEDIR}"/build.log 2>&1

Expand Down
Loading

0 comments on commit 2cf5f9f

Please sign in to comment.