public interface

ImageProcessor

 androidx.camera.extensions.internal.sessionprocessor.ImageProcessor

Gradle dependencies

compile group: 'androidx.camera', name: 'camera-extensions', version: '1.2.0-alpha01'

  • groupId: androidx.camera
  • artifactId: camera-extensions
  • version: 1.2.0-alpha01

Artifact androidx.camera:camera-extensions:1.2.0-alpha01 it located at Google repository (https://maven.google.com/)

Overview

An interface to receive and process the upcoming next available Image.

Summary

Methods
public voidonNextImageAvailable(int outputStreamId, long timestampNs, ImageReference imageReference, java.lang.String physicalCameraId)

The reference count will be decremented when this method returns.

Methods

public void onNextImageAvailable(int outputStreamId, long timestampNs, ImageReference imageReference, java.lang.String physicalCameraId)

The reference count will be decremented when this method returns. If an extension wants to hold onto the image, it should increment the reference count in this method and decrement it when the image is no longer needed.

If OEM is not closing(decrement) the image fast enough, the imageReference passed in this method might contain null image meaning that the Image was closed to prevent preview from stalling.

Source

/*
 * Copyright 2021 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.camera.extensions.internal.sessionprocessor;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.RequiresApi;

/**
 * An interface to receive and process the upcoming next available Image.
 */
@RequiresApi(21) // TODO(b/200306659): Remove and replace with annotation on package-info.java
public interface ImageProcessor {
    /**
     * The reference count will be decremented when this method returns. If an extension wants
     * to hold onto the image, it should increment the reference count in this method and
     * decrement it when the image is no longer needed.
     *
     * <p>If OEM is not closing(decrement) the image fast enough, the imageReference passed
     * in this method might contain null image meaning that the Image was closed to prevent
     * preview from stalling.
     */
    void onNextImageAvailable(
            int outputStreamId,
            long timestampNs,
            @NonNull ImageReference imageReference,
            @Nullable String physicalCameraId);
}