Package 

Class Frame

    • Method Summary

      Modifier and Type Method Description
      boolean equals(Object obj)
      Frame freeze() Clones the frame, returning a frozen content that will not be overwritten.This can be kept or safely passed to other threads.
      void release() Disposes the contents of this frame.
      <T> T getData() Returns the frame data.
      Class<out Object> getDataClass() Returns the class returned by getData.This class depends on the engine that produced this frame.
      long getTime() Returns the milliseconds epoch for this frame,in the currentTimeMillis reference.
      int getRotation()
      int getRotationToUser() Returns the clock-wise rotation that should be applied on the dataarray, such that the resulting frame matches what the user is seeingon screen.
      int getRotationToView() Returns the clock-wise rotation that should be applied on the dataarray, such that the resulting frame matches the View / Activity orientation.Knowing this can help in the drawing / rendering phase.
      Size getSize() Returns the frame size.
      int getFormat() Returns the data format, in one of the android.graphics.ImageFormat constants.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • freeze

        @NonNull() Frame freeze()

        Clones the frame, returning a frozen content that will not be overwritten.This can be kept or safely passed to other threads.Using freeze without clearing with release can result in memory leaks.

      • release

         void release()

        Disposes the contents of this frame. Can be useful for frozen framesthat are not useful anymore.

      • getRotationToUser

         int getRotationToUser()

        Returns the clock-wise rotation that should be applied on the dataarray, such that the resulting frame matches what the user is seeingon screen. Knowing this can help in the processing phase.

      • getRotationToView

         int getRotationToView()

        Returns the clock-wise rotation that should be applied on the dataarray, such that the resulting frame matches the View / Activity orientation.Knowing this can help in the drawing / rendering phase.