Class EncodedFrame

  • All Implemented Interfaces:

    public class EncodedFrame
    extends Inventor
    implements java.lang.Cloneable
    This class provides the features of an encoded frame that is sent to the client.
    • Constructor Detail

      • EncodedFrame

        public EncodedFrame​(EncodedFrame obj)
        Copy constructor.
      • EncodedFrame

        public EncodedFrame()
    • Method Detail

      • clone

        public java.lang.Object clone()
      • isInteractive

        public boolean isInteractive()
        Returns if an user interaction is in progress when the frame has been encoded. If the frame is interactive, the frame has been encoded with the interactive frame encoder and a quality adapted to the network bandwidth.
        Otherwise (the frame is still), the frame has been encoded with the still frame encoder and the best available quality.

        true if the frame is interactive

      • getEncodingFormat

        public EncodedFrame.EncodingFormats getEncodingFormat()
        Gets the frame encoding format.

        the encoding format of the encoded frame.

      • getMessage

        public java.lang.String getMessage()
        Gets the frame message.

        the message joint with the encoded frame.

      • getId

        public long getId()
        Gets the frame id.

        the frame id of the encoded frame.

      • getBufferSize

        public long getBufferSize()
        Gets the frame buffer size in bytes.

        the buffer size of the encoded frame.

      • isLossless

        public boolean isLossless()
        Returns if the frame is lossless.

        true if the frame is lossless