Index

A B C D E F G H I L M O P R S T U V

A

ai.deepar.ar - package ai.deepar.ar
animationTransitionedTo(String) - Method in interface ai.deepar.ar.DeepAR.AnimationTransitionedCallback: Called when the animation player transitions to a new state.
ARErrorType - Enum in ai.deepar.ar: DeepAR error types.
AREventListener - Interface in ai.deepar.ar: Listener for asynchronous actions returned from the DeepAR class like receiving screenshot results etc.
ARTouchInfo - Class in ai.deepar.ar: Class containing touch-related data.
ARTouchInfo() - Constructor for class ai.deepar.ar.ARTouchInfo: Default class constructor.
ARTouchInfo(float, float, ARTouchType) - Constructor for class ai.deepar.ar.ARTouchInfo: Constructor that specifies the position and type of touch.
ARTouchType - Enum in ai.deepar.ar: Types of touch events.

B

backgroundBlur(boolean, int) - Method in class ai.deepar.ar.DeepAR: Enable background blur.
backgroundReplacement(boolean, Bitmap) - Method in class ai.deepar.ar.DeepAR: Enable background replacement (also known as background removal or green screen effect).

C

CameraOrientation - Enum in ai.deepar.ar: Camera orientations.
CameraResolutionPreset - Enum in ai.deepar.ar: Camera resolution presets.
changeLiveMode(boolean) - Method in class ai.deepar.ar.DeepAR: An optimization method and it allows the user to indicate the DeepAR in which mode it should operate.
changeParameterBool(String, String, String, boolean) - Method in class ai.deepar.ar.DeepAR: Changes a node or component boolean parameter.
changeParameterFloat(String, String, String, float) - Method in class ai.deepar.ar.DeepAR: Changes a node or component float parameter.
changeParameterTexture(String, String, String, Bitmap) - Method in class ai.deepar.ar.DeepAR: Changes a node or component texture parameter.
changeParameterVec3(String, String, String, float, float, float) - Method in class ai.deepar.ar.DeepAR: Changes a node or component 3D vector parameter.
changeParameterVec4(String, String, String, float, float, float, float) - Method in class ai.deepar.ar.DeepAR: Changes a node or component 4D vector parameter.
clearVars(String) - Method in class ai.deepar.ar.DeepAR: Clear all variables or variables from the specified effect.
clearVars() - Method in class ai.deepar.ar.DeepAR: Clear all variables.

D

DeepAR - Class in ai.deepar.ar: Main class for interacting with DeepAR engine.
DeepAR(Context) - Constructor for class ai.deepar.ar.DeepAR: Creates a new DeepAR object.
DeepAR.AnimationTransitionedCallback - Interface in ai.deepar.ar: Animation transitioned callback interface.
DeepAR.FaceData - Class in ai.deepar.ar: Represents data structure containing all the information available about the detected face.
DeepAR.FaceTrackedCallback - Interface in ai.deepar.ar: Face tracked callback interface.
DeepAR.FaceTrackingInitParameters - Class in ai.deepar.ar: Face tracking parameters that will determine how the face tracking is initialized.
DeepAR.FrameRenderedCallback - Interface in ai.deepar.ar: Frame rendered callback interface.
DeepAR.ToneMapping - Enum in ai.deepar.ar
DeepARImageFormat - Enum in ai.deepar.ar: Image format used in receiveFrame method of DeepAR to tell DeepAR how to interpret the frame.
DeepARPixelFormat - Enum in ai.deepar.ar: Pixel format used to specify the pixel output format of the Image frame of frameAvailable callback method.
deleteVar(String, String) - Method in class ai.deepar.ar.DeepAR: Delete the variable with the given name.
deleteVar(String) - Method in class ai.deepar.ar.DeepAR: Delete the variable with the given name.

E

effectSwitched(String) - Method in interface ai.deepar.ar.AREventListener: Called when an effect has been switched on a slot.
EMOTION_IDX_ANGER - Static variable in class ai.deepar.ar.DeepAR.FaceData: Detected anger on face.
EMOTION_IDX_HAPPINESS - Static variable in class ai.deepar.ar.DeepAR.FaceData: Detected happiness on face.
EMOTION_IDX_NEUTRAL - Static variable in class ai.deepar.ar.DeepAR.FaceData: Detected neutral face emotion.
EMOTION_IDX_SADNESS - Static variable in class ai.deepar.ar.DeepAR.FaceData: Detected sadness on face.
EMOTION_IDX_SURPRISE - Static variable in class ai.deepar.ar.DeepAR.FaceData: Detected surprise on face.
emotions - Variable in class ai.deepar.ar.DeepAR.FaceData: Estimated emotions for the face.
error(ARErrorType, String) - Method in interface ai.deepar.ar.AREventListener: Called when an error occurs, for example, if the model path is not found or the effect file has failed to load.
ERROR_EFFECT_FILE_LOAD_FAILED - Static variable in class ai.deepar.ar.DeepAR: Effect file load failed error name.
ERROR_MODEL_FILE_NOT_FOUND - Static variable in class ai.deepar.ar.DeepAR: Model file not found error name.

F

FaceData() - Constructor for class ai.deepar.ar.DeepAR.FaceData: Creates an empty face data.
faceDetected - Variable in class ai.deepar.ar.DeepAR.FaceData: Determines whether the face is detected or not.
faceRect - Variable in class ai.deepar.ar.DeepAR.FaceData: A rectangle containing the face in screen coordinates (X, Y, Width, Height).
faceTracked(DeepAR.FaceData[]) - Method in interface ai.deepar.ar.DeepAR.FaceTrackedCallback: Face tracked callback method.
FaceTrackingInitParameters() - Constructor for class ai.deepar.ar.DeepAR.FaceTrackingInitParameters: Constructor with default parameters.
FaceTrackingInitParameters(boolean, boolean) - Constructor for class ai.deepar.ar.DeepAR.FaceTrackingInitParameters: Construct face tracking init parameters.
faceVisibilityChanged(boolean) - Method in interface ai.deepar.ar.AREventListener: Called when the user's face becomes visible or invisible.
fireTrigger(String) - Method in class ai.deepar.ar.DeepAR: Fire named trigger of an fbx animation set on the currently loaded effect.
frameAvailable(Image) - Method in interface ai.deepar.ar.AREventListener: Each processed frame will be available here as an Image object.
frameRendered() - Method in interface ai.deepar.ar.DeepAR.FrameRenderedCallback: Frame rendered callback method.
fromString(String) - Static method in enum ai.deepar.ar.DeepARPixelFormat: Gets DeepAR pixel format from string.

G

getBitRate() - Method in class ai.deepar.ar.DeepAR: Gets the video bitrate.
getBoolVar(String, String) - Method in class ai.deepar.ar.DeepAR: Get boolean variable with the given name.
getBoolVar(String) - Method in class ai.deepar.ar.DeepAR: Get boolean variable with the given name.
getDoubleVar(String, String) - Method in class ai.deepar.ar.DeepAR: Get double variable with the given name.
getDoubleVar(String) - Method in class ai.deepar.ar.DeepAR: Get double variable with the given name.
getExternalGlTexture() - Method in class ai.deepar.ar.DeepAR: Get Android External GL texture.
getFaceTrackedCallback() - Method in class ai.deepar.ar.DeepAR: Gets the face tracked callback.
getFrameRenderedCallback() - Method in class ai.deepar.ar.DeepAR: Gets the frame rendered callback.
getHeight() - Method in enum ai.deepar.ar.CameraResolutionPreset: Gets resolution preset height.
getIFrameInterval() - Method in class ai.deepar.ar.DeepAR: Gets the I frame interval (KEY_I_FRAME_INTERVAL).
getIntValue() - Method in enum ai.deepar.ar.DeepARPixelFormat: Gets DeepAR pixel format.
getIntVar(String, String) - Method in class ai.deepar.ar.DeepAR: Get int variable with the given name.
getIntVar(String) - Method in class ai.deepar.ar.DeepAR: Get int variable with the given name.
getKeyFrameRate() - Method in class ai.deepar.ar.DeepAR: Gets the key frame rate (KEY_FRAME_RATE).
getMaxSupportedVideoHeight() - Method in class ai.deepar.ar.DeepAR: Gets the maximum supported video height.
getMaxSupportedVideoWidth() - Method in class ai.deepar.ar.DeepAR: Gets the maximum supported video width.
getMinSupportedVideoHeight() - Method in class ai.deepar.ar.DeepAR: Gets the minimum supported video height.
getMinSupportedVideoWidth() - Method in class ai.deepar.ar.DeepAR: Gets the minimum supported video width.
getRenderHeight() - Method in class ai.deepar.ar.DeepAR: Gets the render height.
getRenderWidth() - Method in class ai.deepar.ar.DeepAR: Gets the render width.
getSdkVersion() - Static method in class ai.deepar.ar.DeepAR
getStringVar(String, String) - Method in class ai.deepar.ar.DeepAR: Get string variable with the given name.
getStringVar(String) - Method in class ai.deepar.ar.DeepAR: Get string variable with the given name.
getTouchType() - Method in class ai.deepar.ar.ARTouchInfo: Gets the type of touch.
getType() - Method in enum ai.deepar.ar.ARErrorType: Gets DeepAR error type.
getType() - Method in enum ai.deepar.ar.ARTouchType: Gets the internal numeric constant representation of the entry.
getVal() - Method in enum ai.deepar.ar.CameraOrientation: Gets camera orientation.
getVarType(String, String) - Method in class ai.deepar.ar.DeepAR: Get the type of the variable with the given name in the specified effect.
getVarType(String) - Method in class ai.deepar.ar.DeepAR: Get the type of the variable with the given name.
getWidth() - Method in enum ai.deepar.ar.CameraResolutionPreset: Gets resolution preset width.
getX() - Method in class ai.deepar.ar.ARTouchInfo: Gets the touch position's x-coordinate.
getY() - Method in class ai.deepar.ar.ARTouchInfo: Gets the touch position's y-coordinate.

H

hasVar(String, String) - Method in class ai.deepar.ar.DeepAR: Check if variable with the given name is already created.
hasVar(String) - Method in class ai.deepar.ar.DeepAR: Check if the variable with the given name is already created in at least one effect.

I

imageVisibilityChanged(String, boolean) - Method in interface ai.deepar.ar.AREventListener: Called when a natural image is being tracked and the visibility has changed.
initialize(Context, AREventListener, String) - Method in class ai.deepar.ar.DeepAR: Initializes the DeepAR engine.
initialize(Context, AREventListener) - Method in class ai.deepar.ar.DeepAR: Initializes the DeepAR engine.
initialized() - Method in interface ai.deepar.ar.AREventListener: Called when the DeepAR is initialized.
initializeEngineWithFaceTracking - Variable in class ai.deepar.ar.DeepAR.FaceTrackingInitParameters: Engine will initialize face tracking as soon as possible if true.
initializeFaceTrackingSynchronously - Variable in class ai.deepar.ar.DeepAR.FaceTrackingInitParameters: If true, face tracking will be initialized synchronously and will be blocking DeepAR rendering.
intValue - Variable in enum ai.deepar.ar.DeepAR.ToneMapping
intValue - Variable in enum ai.deepar.ar.DeepARImageFormat: DeepAR image format.

L

landmarks - Variable in class ai.deepar.ar.DeepAR.FaceData: Detected face feature points in 3D space (X, Y, Z).
landmarks2d - Variable in class ai.deepar.ar.DeepAR.FaceData: Detected face feature points in 2D screen space coordinates (X, Y).

M

moveGameObject(String, String) - Method in class ai.deepar.ar.DeepAR: Moves the selected game object from its current position in a tree and sets it as a direct child of a target game object.
muteSound(boolean) - Method in class ai.deepar.ar.DeepAR: Mutes or un-mutes all the sounds that are currently playing.

O

onImageAvailable(ImageReader) - Method in class ai.deepar.ar.DeepAR: Callback that is called when a new image is available from ImageReader.

P

pauseVideoRecording() - Method in class ai.deepar.ar.DeepAR: Pauses the video recording.
poseMatrix - Variable in class ai.deepar.ar.DeepAR.FaceData: Translation and rotation in matrix form (D3D style, column-major order).

R

receiveFrame(ByteBuffer, int, int, int, boolean, DeepARImageFormat, int) - Method in class ai.deepar.ar.DeepAR: DeepAR can be used with Camera API, Camera2 API or CameraX API.
receiveFrameExternalTexture(int, int, int, boolean, int) - Method in class ai.deepar.ar.DeepAR: Notify DeepAR that new camera frame is available on the given external GL texture.
release() - Method in class ai.deepar.ar.DeepAR: Releases all resources required by DeepAR.
releaseExternalGlTexture(int) - Method in class ai.deepar.ar.DeepAR: Release the external texture aqured from DeepAR.getExternalGlTexture().
resumeVideoRecording() - Method in class ai.deepar.ar.DeepAR: Resumes the video recording.
rotation - Variable in class ai.deepar.ar.DeepAR.FaceData: The pitch, yaw and roll rotation values in euler angles (degrees) of the face in the scene.

S

screenshotTaken(Bitmap) - Method in interface ai.deepar.ar.AREventListener: Called when the screen capture is finished.
setAnimationTransitionedCallback(DeepAR.AnimationTransitionedCallback) - Method in class ai.deepar.ar.DeepAR: Sets the animation transitioned callback.
setAntialiasingLevel(int) - Method in class ai.deepar.ar.DeepAR: Sets the MSAA level.
setAREventListener(AREventListener) - Method in class ai.deepar.ar.DeepAR: Sets the AREventListener for DeepAR object.
setAudioMute(boolean) - Method in class ai.deepar.ar.DeepAR: Mutes or unmutes the audio while video recording.
setBitRate(int) - Method in class ai.deepar.ar.DeepAR: Sets the video bitrate.
setBloomEnabled(boolean) - Method in class ai.deepar.ar.DeepAR: Toggles bloom postprocessing.
setBloomRadius(float) - Method in class ai.deepar.ar.DeepAR: Sets bloom radius parameter.
setBloomStrength(float) - Method in class ai.deepar.ar.DeepAR: Sets bloom strength parameter.
setBloomThreshold(float) - Method in class ai.deepar.ar.DeepAR: Sets bloom threshold parameter.
setBoolVar(String, boolean, String) - Method in class ai.deepar.ar.DeepAR: Set the boolean variable with the given name.
setBoolVar(String, boolean) - Method in class ai.deepar.ar.DeepAR: Set the boolean variable with the given name.
setDiamondEnvironmentMap(Bitmap) - Method in class ai.deepar.ar.DeepAR: Sets new environment map that will be used for rendering materials with diamond shader.
setDoubleVar(String, double, String) - Method in class ai.deepar.ar.DeepAR: Set the double variable with the given name.
setDoubleVar(String, double) - Method in class ai.deepar.ar.DeepAR: Set the double variable with the given name.
setEnvironmentMap(Bitmap) - Method in class ai.deepar.ar.DeepAR: Sets a new environment map that will be used for rendering materials with new PBR glTF shader.
setEnvironmentMapIntensity(float) - Method in class ai.deepar.ar.DeepAR: Sets environment map intensity.
setExposure(float) - Method in class ai.deepar.ar.DeepAR: Sets tone mapping exposure.
setFaceDetectionSensitivity(int) - Method in class ai.deepar.ar.DeepAR: This method allows the user to change face detection sensitivity.
setFaceTrackedCallback(DeepAR.FaceTrackedCallback) - Method in class ai.deepar.ar.DeepAR: Sets the face tracked callback.
setFaceTrackingInitParameters(DeepAR.FaceTrackingInitParameters) - Method in class ai.deepar.ar.DeepAR: Sets parameters that will determine how the face tracking is initialized.
setFixedDeltaTime(boolean, float) - Method in class ai.deepar.ar.DeepAR
setFrameRenderedCallback(DeepAR.FrameRenderedCallback) - Method in class ai.deepar.ar.DeepAR: Sets the frame rendered callback.
setIFrameInterval(int) - Method in class ai.deepar.ar.DeepAR: Sets the I frame interval (KEY_I_FRAME_INTERVAL).
setIntVar(String, int, String) - Method in class ai.deepar.ar.DeepAR: Set the int variable with the given name.
setIntVar(String, int) - Method in class ai.deepar.ar.DeepAR: Set the int variable with the given name.
setKeyFrameRate(int) - Method in class ai.deepar.ar.DeepAR: Sets the key frame rate (KEY_FRAME_RATE).
setLicenseKey(String) - Method in class ai.deepar.ar.DeepAR: The method used to set the license key for your project.
setOffscreenRendering(int, int) - Method in class ai.deepar.ar.DeepAR: Calling this method sets the engine in off-screen rendering mode.
setOffscreenRendering(int, int, DeepARPixelFormat) - Method in class ai.deepar.ar.DeepAR: Calling this method sets the engine in off-screen rendering mode.
setPaused(boolean) - Method in class ai.deepar.ar.DeepAR: Pauses or unpauses the rendering.
setRenderSurface(Surface, int, int) - Method in class ai.deepar.ar.DeepAR: Calling this method sets the engine in on-screen rendering mode (cancels off-screen rendering if set before this call).
setStringVar(String, String, String) - Method in class ai.deepar.ar.DeepAR: Set the string variable with the given name.
setStringVar(String, String) - Method in class ai.deepar.ar.DeepAR: Set the string variable with the given name.
setToneMapping(DeepAR.ToneMapping) - Method in class ai.deepar.ar.DeepAR: Sets tone mapping.
setTouchType(ARTouchType) - Method in class ai.deepar.ar.ARTouchInfo: Sets the type of touch to the given value.
setVisionOnly() - Method in class ai.deepar.ar.DeepAR: Set DeepAR in the vision-only mode.
setX(float) - Method in class ai.deepar.ar.ARTouchInfo: Sets the touch position's x-coordinate to the given value.
setY(float) - Method in class ai.deepar.ar.ARTouchInfo: Sets the touch position's y-coordinate to the given value.
showColliders(boolean) - Method in class ai.deepar.ar.DeepAR: Display physics colliders preview on screen.
showStats(boolean) - Method in class ai.deepar.ar.DeepAR: Display debugging stats on screen.
shutdownFinished() - Method in interface ai.deepar.ar.AREventListener: Called when engine shutdown is finished after calling release.
simulatePhysics(boolean) - Method in class ai.deepar.ar.DeepAR: Enable or disable global physics simulation.
startCapture() - Method in class ai.deepar.ar.DeepAR: Starts capturing the DeepAR processing output in an off-screen buffer.
startCapture(DeepARPixelFormat) - Method in class ai.deepar.ar.DeepAR: Starts capturing the DeepAR processing output in an off-screen buffer.
startCapture(int, int, float, float, float, float, DeepARPixelFormat) - Method in class ai.deepar.ar.DeepAR: Starts capturing the DeepAR processing output in an off-screen buffer.
startPreparedVideoRecording() - Method in class ai.deepar.ar.DeepAR: Starts the prepared video recording.
startProfiling() - Method in class ai.deepar.ar.DeepAR
startVideoRecording(String) - Method in class ai.deepar.ar.DeepAR: Starts video recording of the camera preview.
startVideoRecording(FileDescriptor) - Method in class ai.deepar.ar.DeepAR: Starts video recording of the camera preview.
startVideoRecording(String, int, int) - Method in class ai.deepar.ar.DeepAR: Starts video recording of the camera preview.
startVideoRecording(FileDescriptor, int, int) - Method in class ai.deepar.ar.DeepAR: Starts video recording of the camera preview.
startVideoRecording(String, Rect, int, int) - Method in class ai.deepar.ar.DeepAR: Starts video recording of the camera preview.
startVideoRecording(FileDescriptor, Rect, int, int) - Method in class ai.deepar.ar.DeepAR: Starts video recording of the camera preview.
startVideoRecording(FileDescriptor, Rect, int, int, boolean) - Method in class ai.deepar.ar.DeepAR: Starts video recording of the camera preview.
startVideoRecording(FileDescriptor, Map<String, Object>) - Method in class ai.deepar.ar.DeepAR: Starts video recording of the camera preview.
startVideoRecording(String, Rect, int, int, boolean) - Method in class ai.deepar.ar.DeepAR: Starts video recording of the camera preview.
startVideoRecording(String, Map<String, Object>) - Method in class ai.deepar.ar.DeepAR: Starts video recording of the camera preview.
stopCapture() - Method in class ai.deepar.ar.DeepAR: Stops capturing the content of the DeepAR rendering process in the off-screen buffer.
stopProfiling() - Method in class ai.deepar.ar.DeepAR
stopVideoRecording() - Method in class ai.deepar.ar.DeepAR: Stops video recording and starts the process of saving the recorded video to the file system.
switchEffect(String, InputStream) - Method in class ai.deepar.ar.DeepAR: Same as switchEffect, but uses an InputStream instead of a file path.
switchEffect(String, InputStream, int) - Method in class ai.deepar.ar.DeepAR: Same as switchEffect, but uses an InputStream instead of a file path.
switchEffect(String, InputStream, int, String) - Method in class ai.deepar.ar.DeepAR: Same as switchEffect, but uses an InputStream instead of a file path.
switchEffect(String, String) - Method in class ai.deepar.ar.DeepAR: The method used to switch any effect in the scene.
switchEffect(String, String, int) - Method in class ai.deepar.ar.DeepAR: The method used to switch any effect in the scene.
switchEffect(String, String, int, String) - Method in class ai.deepar.ar.DeepAR: The method used to switch any effect in the scene.

T

takeScreenshot() - Method in class ai.deepar.ar.DeepAR: Captures a screenshot of the current screen.
touchOccurred(ARTouchInfo) - Method in class ai.deepar.ar.DeepAR: Informs DeepAR that the specified touch event occurred.
translation - Variable in class ai.deepar.ar.DeepAR.FaceData: The X, Y and Z translation values of the face in the scene.

U

useSingleThreadedMode(boolean) - Method in class ai.deepar.ar.DeepAR: This methods puts DeepAR in single-threaded mode.

V

valueOf(String) - Static method in enum ai.deepar.ar.ARErrorType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.deepar.ar.ARTouchType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.deepar.ar.CameraOrientation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.deepar.ar.CameraResolutionPreset: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.deepar.ar.DeepAR.ToneMapping: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.deepar.ar.DeepARImageFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.deepar.ar.DeepARPixelFormat: Returns the enum constant of this type with the specified name.
values() - Static method in enum ai.deepar.ar.ARErrorType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.deepar.ar.ARTouchType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.deepar.ar.CameraOrientation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.deepar.ar.CameraResolutionPreset: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.deepar.ar.DeepAR.ToneMapping: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.deepar.ar.DeepARImageFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.deepar.ar.DeepARPixelFormat: Returns an array containing the constants of this enum type, in the order they are declared.
videoRecordingFailed() - Method in interface ai.deepar.ar.AREventListener: Called if the video recording fails.
videoRecordingFinished() - Method in interface ai.deepar.ar.AREventListener: Called when the video recording is finished.
videoRecordingPrepared() - Method in interface ai.deepar.ar.AREventListener: Called when the video recording is prepared.
videoRecordingStarted() - Method in interface ai.deepar.ar.AREventListener: The start of the video recording process is not synchronous, so this method will be called when the video recording is started.

A B C D E F G H I L M O P R S T U V