From 3f8ec5d2f797f7c610b6de8084d599f47c3c7a3e Mon Sep 17 00:00:00 2001 From: Taner Sener Date: Sun, 7 Nov 2021 14:06:20 +0000 Subject: [PATCH] document internal native methods that must not be called by applications --- .../src/main/java/com/arthenica/ffmpegkit/FFmpegSession.java | 3 +++ .../src/main/java/com/arthenica/ffmpegkit/Session.java | 3 +++ apple/src/FFmpegSession.h | 3 +++ apple/src/Session.h | 3 +++ 4 files changed, 12 insertions(+) diff --git a/android/ffmpeg-kit-android-lib/src/main/java/com/arthenica/ffmpegkit/FFmpegSession.java b/android/ffmpeg-kit-android-lib/src/main/java/com/arthenica/ffmpegkit/FFmpegSession.java index 28e7ada..2a897fe 100644 --- a/android/ffmpeg-kit-android-lib/src/main/java/com/arthenica/ffmpegkit/FFmpegSession.java +++ b/android/ffmpeg-kit-android-lib/src/main/java/com/arthenica/ffmpegkit/FFmpegSession.java @@ -167,6 +167,9 @@ public class FFmpegSession extends AbstractSession implements Session { /** * Adds a new statistics entry for this session. * + * It is invoked internally by FFmpegKit library methods. Must not be used by user + * applications. + * * @param statistics statistics entry */ public void addStatistics(final Statistics statistics) { diff --git a/android/ffmpeg-kit-android-lib/src/main/java/com/arthenica/ffmpegkit/Session.java b/android/ffmpeg-kit-android-lib/src/main/java/com/arthenica/ffmpegkit/Session.java index 2dc73fa..c12c9a6 100644 --- a/android/ffmpeg-kit-android-lib/src/main/java/com/arthenica/ffmpegkit/Session.java +++ b/android/ffmpeg-kit-android-lib/src/main/java/com/arthenica/ffmpegkit/Session.java @@ -199,6 +199,9 @@ public interface Session { /** * Adds a new log entry for this session. * + * It is invoked internally by FFmpegKit library methods. Must not be used by user + * applications. + * * @param log log entry */ void addLog(final Log log); diff --git a/apple/src/FFmpegSession.h b/apple/src/FFmpegSession.h index f63d225..da376aa 100644 --- a/apple/src/FFmpegSession.h +++ b/apple/src/FFmpegSession.h @@ -110,6 +110,9 @@ /** * Adds a new statistics entry for this session. * + * It is invoked internally by FFmpegKit library methods. Must not be used by user + * applications. + * * @param statistics statistics entry */ - (void)addStatistics:(Statistics*)statistics; diff --git a/apple/src/Session.h b/apple/src/Session.h index 6be9665..17ea178 100644 --- a/apple/src/Session.h +++ b/apple/src/Session.h @@ -206,6 +206,9 @@ /** * Adds a new log entry for this session. * + * It is invoked internally by FFmpegKit library methods. Must not be used by user + * applications. + * * @param log log entry */ - (void)addLog:(Log*)log;