Interface AMImageConfigurationEntry


public interface AMImageConfigurationEntry
Represents a single configuration entry used by Adaptive Media to generate adaptive media images. Image configuration entries are company scoped.

It is recommended that you use AMImageConfigurationHelper to manage and fetch image configuration entries.

  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the image configuration entry's description.
    Returns the image configuration entry's name.
    Returns a set of properties that communicate how adaptive media images should be generated for the image configuration entry.
    Returns the image configuration entry's unique identifier.
    boolean
    Returns true if the image configuration entry is enabled and used to generate adaptive media images.
  • Method Details

    • getDescription

      String getDescription()
      Returns the image configuration entry's description.
      Returns:
      the image configuration entry's description
    • getName

      String getName()
      Returns the image configuration entry's name.
      Returns:
      the image configuration entry's name
    • getProperties

      Map<String,String> getProperties()
      Returns a set of properties that communicate how adaptive media images should be generated for the image configuration entry.
      Returns:
      a set of properties for the image configuration entry
    • getUUID

      String getUUID()
      Returns the image configuration entry's unique identifier.
      Returns:
      the image configuration entry's unique identifier
    • isEnabled

      boolean isEnabled()
      Returns true if the image configuration entry is enabled and used to generate adaptive media images.
      Returns:
      true if the image configuration entry is enabled and used to generate adaptive media images; false otherwise