Package org.jitsi.impl.neomedia.control

Class AbstractFormatControl

  • All Implemented Interfaces:
    javax.media.Control, javax.media.control.FormatControl
    public abstract class AbstractFormatControl
extends Object
implements javax.media.control.FormatControl
    Provides an abstract implementation of FormatControl which facilitates implementers by requiring them to implement just FormatControl.getSupportedFormats() and FormatControl.getFormat().
    Author:
    Lyubomir Marinov

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Component getControlComponent()
      Implements Control.getControlComponent().
      static javax.media.control.FormatControl[] getFormatControls​(javax.media.Controls controlsImpl)
      Gets an array of FormatControl instances from the list of controls available for a specific Controls implementation.
      boolean isEnabled()
      Implements FormatControl.isEnabled().
      void setEnabled​(boolean enabled)
      Implements FormatControl.setEnabled(boolean).
      static javax.media.Format setFormat​(javax.media.control.FormatControl formatControl, javax.media.Format format)
      Implements setting the Format of a specific FormatControl as documented for FormatControl.setFormat(Format) in the case of not supporting Format setting.
      javax.media.Format setFormat​(javax.media.Format format)
      Implements FormatControl.setFormat(Format).

      • Methods inherited from interface javax.media.control.FormatControl

        getFormat, getSupportedFormats

    • Constructor Detail

      • AbstractFormatControl

        public AbstractFormatControl()

    • Method Detail

      • getControlComponent

        public Component getControlComponent()
        Implements Control.getControlComponent(). Returns null.
        Specified by:
        getControlComponent in interface javax.media.Control
        Returns:
        a Component which represents UI associated with this instance if any; otherwise, null

      • getFormatControls

        public static javax.media.control.FormatControl[] getFormatControls​(javax.media.Controls controlsImpl)
        Gets an array of FormatControl instances from the list of controls available for a specific Controls implementation.
        Parameters:
        controlsImpl - the Controls implementation from which the FormatControl instances are to be retrieved
        Returns:
        an array of FormatControl instances from the list of controls available for the specified Controls implementation

      • isEnabled

        public boolean isEnabled()
        Implements FormatControl.isEnabled().
        Specified by:
        isEnabled in interface javax.media.control.FormatControl
        Returns:
        true if this track is enabled; otherwise, false

      • setEnabled

        public void setEnabled​(boolean enabled)
        Implements FormatControl.setEnabled(boolean).
        Specified by:
        setEnabled in interface javax.media.control.FormatControl
        Parameters:
        enabled - true if this track is to be enabled; otherwise, false

      • setFormat

        public javax.media.Format setFormat​(javax.media.Format format)
        Implements FormatControl.setFormat(Format). Not supported and just returns the currently set format if the specified Format is supported and null if it is not supported.
        Specified by:
        setFormat in interface javax.media.control.FormatControl
        Parameters:
        format - the Format to be set on this instance
        Returns:
        the currently set Format after the attempt to set it on this instance if format is supported by this instance and regardless of whether it was actually set; null if format is not supported by this instance

      • setFormat

        public static javax.media.Format setFormat​(javax.media.control.FormatControl formatControl,
                                           javax.media.Format format)
        Implements setting the Format of a specific FormatControl as documented for FormatControl.setFormat(Format) in the case of not supporting Format setting.
        Parameters:
        formatControl - the FormatControl for which the functionality is implemented
        format - the Format specified to be set to formatControl and which will be ignored in accord with the documentation of FormatControl#setFormat(Format)
        Returns:
        the currently set Format of formatControl if format is supported by formatControl; null if format is not supported by formatControl