Finding Adapted Images

If you need more control than the Adaptive Media taglib offers for finding adapted images to display in your app, you can query Adaptive Media’s finder API directly. The steps here show you how for these scenarios:

Getting Adapted Images for File Versions
Getting the Adapted Images for a Specific Image Resolution
Getting Adapted Images in a Specific Order
Using Approximate Attributes
Using the Adaptive Media Stream

For background information on these topics, see Adaptive Media’s Finder API.

Getting Adapted Images for File Versions

Follow these steps to get adapted images for file versions. Note that the method calls here only return adapted images for enabled image resolutions:

Get an AMImageFinder reference:

@Reference
private AMImageFinder _amImageFinder;

To get adapted images for a specific file version, call the AMImageQueryBuilder method forFileVersion with a FileVersion object as an argument:

Stream<AdaptiveMedia<AMImageProcessor>> adaptiveMediaStream =
    _amImageFinder.getAdaptiveMediaStream(
        amImageQueryBuilder -> amImageQueryBuilder.forFileVersion(fileVersion).done());

To get the adapted images for the latest approved file version, use the forFileEntry method with a FileEntry object:

Stream<AdaptiveMedia<AMImageProcessor>> adaptiveMediaStream =
    _amImageFinder.getAdaptiveMediaStream(
        amImageQueryBuilder -> amImageQueryBuilder.forFileEntry(fileEntry).done());

To get adapted images regardless of status (enabled/disabled image resolutions), invoke the withConfigurationStatus method with the constant AMImageQueryBuilder.ConfigurationStatus.ANY:

Stream<AdaptiveMedia<AMImageProcessor>> adaptiveMediaStream =
    _amImageFinder.getAdaptiveMediaStream(
        amImageQueryBuilder -> amImageQueryBuilder.forFileVersion(fileVersion)
            .withConfigurationStatus(AMImageQueryBuilder.ConfigurationStatus.ANY).done());

Use the constant AMImageQueryBuilder.ConfigurationStatus.DISABLED to get adapted images for only disabled image resolutions.

Getting the Adapted Images for a Specific Image Resolution

By providing an image resolution’s UUID to AMImageFinder, you can get that resolution’s adapted images. This UUID is defined when adding the resolution in the Adaptive Media app. To get a resolution’s adapted images, you must pass that resolution’s UUID to the forConfiguration method.

Follow these steps to get adapted images for an image resolution:

Get an AMImageFinder reference:

@Reference
private AMImageFinder _amImageFinder;

Call the AMImageQueryBuilder.ConfigurationStep method forConfiguration with the image resolution’s UUID. For example, this code gets the adapted images that match a file version, and belong to an image resolution with the UUID hd-resolution. It returns the adapted images regardless of whether the resolution is enabled or disabled:
```
Stream<AdaptiveMedia<AMImageProcessor>> adaptiveMediaStream =
    _amImageFinder.getAdaptiveMediaStream(
        amImageQueryBuilder -> amImageQueryBuilder.forFileVersion(fileVersion)
            .forConfiguration("hd-resolution").done());
```

Getting Adapted Images in a Specific Order

It’s also possible to define the order in which getAdaptiveMediaStream returns adapted images. Follow these steps to do so:

Get an AMImageFinder reference:

@Reference
private AMImageFinder _amImageFinder;

Call the orderBy method with your sort criteria just before calling the done() method. The orderBy method takes two arguments: the first specifies the image attribute to sort by (e.g., width/height), while the second specifies the sort order (e.g., ascending/descending). The Adaptive Media API provides constants that you can use for these arguments.

For example, this code gets all the adapted images regardless of whether the image resolution is enabled, and puts them in ascending order by image width:
```
Stream<AdaptiveMedia<AMImageProcessor>> adaptiveMediaStream =
    _amImageFinder.getAdaptiveMediaStream(
        amImageQueryBuilder -> amImageQueryBuilder.forFileVersion(_fileVersion)
            .withConfigurationStatus(AMImageQueryBuilder.ConfigurationStatus.ANY)
            .orderBy(AMImageAttribute.AM_IMAGE_ATTRIBUTE_WIDTH, AMImageQueryBuilder.SortOrder.ASC)
            .done());
```

Using Approximate Attributes

You can use the API to get adapted images that match approximate attribute values. Follow these steps to do so:

Get an AMImageFinder reference:

@Reference
private AMImageFinder _amImageFinder;

Call the with method with your search criteria just before calling the done() method. The with method takes two arguments: the image attribute and that attribute’s approximate value. For example, this code gets adapted images whose height is approximately 400px:

Stream<AdaptiveMedia<AMImageProcessor>> adaptiveMediaStream =
    _amImageFinder.getAdaptiveMediaStream(
        amImageQueryBuilder -> amImageQueryBuilder.forFileVersion(_fileVersion)
            .with(AMImageAttribute.AM_IMAGE_ATTRIBUTE_HEIGHT, 400).done());

Using the Adaptive Media Stream

The Adaptive Media stream flows like a babbling brook through the sands of time. Just kidding; it’s not like that at all. Once you have the AdaptiveMedia stream, you can get the information you need from it. For example, this code prints the URI for each adapted image:

adaptiveMediaStream.forEach(
    adaptiveMedia -> {
        System.out.println(adaptiveMedia.getURI());
    }
);

You can also get other values and attributes from the AdaptiveMedia stream. Here are a few examples:

// Get the InputStream 
adaptiveMedia.getInputStream()

// Get the content length
adaptiveMedia.getValueOptional(AMAttribute.getContentLengthAMAttribute())

// Get the image height
adaptiveMedia.getValueOptional(AMImageAttribute.AM_IMAGE_ATTRIBUTE_HEIGHT)

Adaptive Media

Displaying Adapted Images in Your App

Creating an Image Scaler

« Displaying Adapted Images in Your AppCreating an Image Scaler »