Class CameraKitParameterBuilder

    • Method Detail

      • fromParameter

        @NonNull
        public static CameraKitParameterBuilder fromParameter​(@NonNull
                                                              CameraKitParameter parameter)
        Creates a parameter builder initialized from an applied parameter snapshot. Unset values will fall back to the preset defaults for that parameter's current level.
        Returns:
        a builder initialized from the provided parameter values
      • getLevel

        @NonNull
        public CameraKitLevel getLevel()
        Returns the preset level associated with this builder.
        Returns:
        the preset level used as the base for these values
      • getFaceSizeRatio

        public float getFaceSizeRatio()
        Returns the lower bound of the face ratio. Face width should be between faceSizeRatio x frame width and 1.0 x frame width. Checks vertical ratio in landscape mode and horizontal ratio in portrait mode. Valid range: 0.55 ~ 1.0. Presets: STRICT 0.75, MODERATE 0.65, RELAXED 0.55.
        Returns:
        the configured lower bound of the face ratio
      • setFaceSizeRatio

        public void setFaceSizeRatio​(float faceSizeRatio)
        Sets the lower bound of the face ratio. Face width should be between faceSizeRatio x frame width and 1.0 x frame width. Checks vertical ratio in landscape mode and horizontal ratio in portrait mode. Valid range: 0.55 ~ 1.0. Presets: STRICT 0.75, MODERATE 0.65, RELAXED 0.55.
      • getFaceYaw

        public float getFaceYaw()
        Returns the absolute upper bound of head pose yaw. This value controls how far the head can look left or right. Valid range: 0.0 ~ 15.0. Presets: STRICT 5.0, MODERATE 10.0, RELAXED 15.0.
        Returns:
        the configured upper bound of head pose yaw
      • setFaceYaw

        public void setFaceYaw​(float faceYaw)
        Sets the absolute upper bound of head pose yaw. This value controls how far the head can look left or right. Valid range: 0.0 ~ 15.0. Presets: STRICT 5.0, MODERATE 10.0, RELAXED 15.0.
      • getFacePitchUpper

        public float getFacePitchUpper()
        Returns the upper bound of head pose pitch. This value controls the allowed upward head pose. Valid range: -20.0 ~ 10.0. Presets: STRICT 0.0, MODERATE 5.0, RELAXED 10.0.
        Returns:
        the configured upper bound of head pose pitch
      • setFacePitchUpper

        public void setFacePitchUpper​(float facePitchUpper)
        Sets the upper bound of head pose pitch. This value controls the allowed upward head pose. Valid range: -20.0 ~ 10.0. Presets: STRICT 0.0, MODERATE 5.0, RELAXED 10.0.
      • getFacePitchLower

        public float getFacePitchLower()
        Returns the lower bound of head pose pitch. This value controls the allowed downward head pose. Valid range: -20.0 ~ 10.0. Presets: STRICT -10.0, MODERATE -15.0, RELAXED -20.0.
        Returns:
        the configured lower bound of head pose pitch
      • setFacePitchLower

        public void setFacePitchLower​(float facePitchLower)
        Sets the lower bound of head pose pitch. This value controls the allowed downward head pose. Valid range: -20.0 ~ 10.0. Presets: STRICT -10.0, MODERATE -15.0, RELAXED -20.0.
      • getLightingUpper

        public float getLightingUpper()
        Returns the upper bound of the lighting condition. Valid range: 0.8 ~ 1.0. Presets: STRICT 0.9, MODERATE 0.85, RELAXED 0.8.
        Returns:
        the configured upper bound of the lighting condition
      • setLightingUpper

        public void setLightingUpper​(float lightingUpper)
        Sets the upper bound of the lighting condition. Valid range: 0.8 ~ 1.0. Presets: STRICT 0.9, MODERATE 0.85, RELAXED 0.8.
      • getLightingLower

        public float getLightingLower()
        Returns the lower bound of the lighting condition. Valid range: 0.55 ~ 1.0. Presets: STRICT 0.8, MODERATE 0.7, RELAXED 0.55.
        Returns:
        the configured lower bound of the lighting condition
      • setLightingLower

        public void setLightingLower​(float lightingLower)
        Sets the lower bound of the lighting condition. Valid range: 0.55 ~ 1.0. Presets: STRICT 0.8, MODERATE 0.7, RELAXED 0.55.