document internal native methods that must not be called by applications

ohmp · Nov 7, 2021 · 3f8ec5d · 3f8ec5d
1 parent f52f6a1
commit 3f8ec5d
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
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
@@ -167,6 +167,9 @@ public Statistics getLastReceivedStatistics() {
     /**
      * Adds a new statistics entry for this session.
      *
+     * It is invoked internally by <code>FFmpegKit</code> 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
@@ -199,6 +199,9 @@ public interface Session {
     /**
      * Adds a new log entry for this session.
      *
+     * It is invoked internally by <code>FFmpegKit</code> 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
@@ -110,6 +110,9 @@
 /**
  * Adds a new statistics entry for this session.
  *
+ * It is invoked internally by <code>FFmpegKit</code> 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
@@ -206,6 +206,9 @@
 /**
  * Adds a new log entry for this session.
  *
+ * It is invoked internally by <code>FFmpegKit</code> library methods. Must not be used by user
+ * applications.
+ *
  * @param log log entry
  */
 - (void)addLog:(Log*)log;