Package com.avpkit.core

Class IProperty

  • public class IProperty
extends RefCounted
    Represents settable properties that effect how AVPKit objects
    operate.


    For example, setting the "b" property on an
    {IStreamCoder} sets the bit-rate the coder will attempt
    to encode at.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  IProperty.Flags  
      static class  IProperty.Search
      How to search options when looking for different values.
      static class  IProperty.Type
      The different type of options that are supported by AVPKit.

      Well, actually by FFMPEG, but you get the idea.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected IProperty​(long cPtr, boolean cMemoryOwn)
      Internal Only.
      protected IProperty​(long cPtr, boolean cMemoryOwn, java.util.concurrent.atomic.AtomicLong ref)
      Internal Only.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      IProperty copyReference()
      Create a new IProperty object that is actually referring to the exact same underlying native object.
      boolean equals​(java.lang.Object obj)
      Compares two values, returning true if the underlying objects in native code are the same object.
      static long getCPtr​(IProperty obj)
      Internal Only.
      long getDefault()
      Get the default setting this flag would have it not set.
      double getDefaultAsDouble()
      Get the default setting this flag would have it not set.
      IProperty getFlagConstant​(int position)
      If this IProperty is of the type {Type#PROPERTY_FLAGS}, this method will
      give you another IProperty representing a constant setting for that flag.
      IProperty getFlagConstant​(java.lang.String name)
      If this IProperty is of the type {Type#PROPERTY_FLAGS}, this method will
      give you another IProperty representing a constant setting for that flag.
      int getFlags()
      Get any set flags (a bitmask) for this option.
      java.lang.String getHelp()
      Get the (English) help string for this property.
      long getMyCPtr()
      Internal Only.
      java.lang.String getName()
      Get the name for this property.
      int getNumFlagSettings()
      If this IProperty is of the type {Type#PROPERTY_FLAGS}, this method will
      tell you how many different flag settings it takes.
      IProperty.Type getType()
      Get the underlying native type of this property.
      java.lang.String getUnit()
      Get any sub-unit this option or constant belongs to.
      int hashCode()
      Get a hashable value for this object.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • IProperty

        protected IProperty​(long cPtr,
                    boolean cMemoryOwn)
        Internal Only.

      • IProperty

        protected IProperty​(long cPtr,
                    boolean cMemoryOwn,
                    java.util.concurrent.atomic.AtomicLong ref)
        Internal Only.

    • Method Detail

      • getCPtr

        public static long getCPtr​(IProperty obj)
        Internal Only. Not part of public API. Get the raw value of the native object that obj is proxying for.
        Parameters:
        obj - The java proxy object for a native object.
        Returns:
        The raw pointer obj is proxying for.

      • getMyCPtr

        public long getMyCPtr()
        Internal Only. Not part of public API. Get the raw value of the native object that we're proxying for.
        Overrides:
        getMyCPtr in class RefCounted
        Returns:
        The raw pointer we're proxying for.

      • copyReference

        public IProperty copyReference()
        Create a new IProperty object that is actually referring to the exact same underlying native object.
        Overrides:
        copyReference in class RefCounted
        Returns:
        the new Java object.

      • equals

        public boolean equals​(java.lang.Object obj)
        Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.
        Overrides:
        equals in class java.lang.Object
        Returns:
        True if the underlying native object is the same. False otherwise.

      • hashCode

        public int hashCode()
        Get a hashable value for this object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hashable value.

      • getName

        public java.lang.String getName()
        Get the name for this property.

        Returns:
        the name.

      • getHelp

        public java.lang.String getHelp()
        Get the (English) help string for this property.

        Returns:
        the help string

      • getUnit

        public java.lang.String getUnit()
        Get any sub-unit this option or constant belongs to.

        Returns:
        the unit, or null if none.

      • getType

        public IProperty.Type getType()
        Get the underlying native type of this property.

        Returns:
        the type

      • getFlags

        public int getFlags()
        Get any set flags (a bitmask) for this option.

        Returns:
        the flags

      • getDefault

        public long getDefault()
        Get the default setting this flag would have it not set.

        Returns:
        the default

      • getDefaultAsDouble

        public double getDefaultAsDouble()
        Get the default setting this flag would have it not set.

        Returns:
        the default

      • getNumFlagSettings

        public int getNumFlagSettings()
        If this IProperty is of the type {Type#PROPERTY_FLAGS}, this method will
        tell you how many different flag settings it takes.

        Returns:
        Number of flag settings, or <0 if not a FLAGS value

      • getFlagConstant

        public IProperty getFlagConstant​(int position)
        If this IProperty is of the type {Type#PROPERTY_FLAGS}, this method will
        give you another IProperty representing a constant setting for that flag.

        Parameters:
        position - The position number for the flag; Must be in range 0 <= position <= #getNumFlagSettings().

        Returns:
        An IProperty object for the flag setting, or null if not available.

      • getFlagConstant

        public IProperty getFlagConstant​(java.lang.String name)
        If this IProperty is of the type {Type#PROPERTY_FLAGS}, this method will
        give you another IProperty representing a constant setting for that flag.

        Parameters:
        name - The name of the constant.

        Returns:
        An IProperty object for the flag setting, or null if not available.