Enumerations

The following enumerations are available globally.

  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBActionUnitsIndices)
    {
        /**0 */
        BNBActionUnitsIndicesBrowDownLeft,
        BNBActionUnitsIndicesBrowDownRight,
        BNBActionUnitsIndicesBrowInnerUp,
        BNBActionUnitsIndicesBrowOuterUpLeft,
        BNBActionUnitsIndicesBrowOuterUpRight,
        BNBActionUnitsIndicesCheekPuff,
        BNBActionUnitsIndicesCheekSquintLeft,
        BNBActionUnitsIndicesCheekSquintRight,
        BNBActionUnitsIndicesJawForward,
        /**9 */
        BNBActionUnitsIndicesJawLeft,
        BNBActionUnitsIndicesJawRight,
        BNBActionUnitsIndicesJawOpen,
        BNBActionUnitsIndicesMouthClose,
        BNBActionUnitsIndicesMouthFunnel,
        BNBActionUnitsIndicesMouthPucker,
        BNBActionUnitsIndicesMouthLeft,
        BNBActionUnitsIndicesMouthRight,
        BNBActionUnitsIndicesMouthSmileLeft,
        BNBActionUnitsIndicesMouthSmileRight,
        /**19 */
        BNBActionUnitsIndicesMouthDimpleLeft,
        BNBActionUnitsIndicesMouthDimpleRight,
        BNBActionUnitsIndicesMouthRollUpper,
        BNBActionUnitsIndicesMouthShrugUpper,
        BNBActionUnitsIndicesMouthShrugLower,
        BNBActionUnitsIndicesMouthRollLower,
        BNBActionUnitsIndicesMouthFrownLeft,
        BNBActionUnitsIndicesMouthFrownRight,
        BNBActionUnitsIndicesMouthUpperUpLeft,
        BNBActionUnitsIndicesMouthUpperUpRight,
        /**29 */
        BNBActionUnitsIndicesMouthLowerDownLeft,
        BNBActionUnitsIndicesMouthLowerDownRight,
        BNBActionUnitsIndicesNoseSneerLeft,
        BNBActionUnitsIndicesNoseSneerRight,
        BNBActionUnitsIndicesMouthPressLeft,
        BNBActionUnitsIndicesMouthPressRight,
        BNBActionUnitsIndicesMouthStretchLeft,
        BNBActionUnitsIndicesMouthStretchRight,
        BNBActionUnitsIndicesEyeBlinkLeft,
        BNBActionUnitsIndicesEyeBlinkRight,
        /**39 */
        BNBActionUnitsIndicesEyeWideLeft,
        BNBActionUnitsIndicesEyeWideRight,
        BNBActionUnitsIndicesEyeSquintLeft,
        BNBActionUnitsIndicesEyeSquintRight,
        BNBActionUnitsIndicesEyeLookDownLeft,
        BNBActionUnitsIndicesEyeLookInLeft,
        BNBActionUnitsIndicesEyeLookOutLeft,
        BNBActionUnitsIndicesEyeLookUpLeft,
        BNBActionUnitsIndicesEyeLookDownRight,
        BNBActionUnitsIndicesEyeLookInRight,
        BNBActionUnitsIndicesEyeLookOutRight,
        /**50 */
        BNBActionUnitsIndicesEyeLookUpRight,
        /**51 */
        BNBActionUnitsIndicesTotalAuCount,
    }

    Swift

    enum BNBActionUnitsIndices : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBCameraOrientation)
    {
        BNBCameraOrientationDeg0,
        BNBCameraOrientationDeg90,
        BNBCameraOrientationDeg180,
        BNBCameraOrientationDeg270,
    }

    Swift

    enum BNBCameraOrientation : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBColorRange)
    {
        BNBColorRangeVideo,
        BNBColorRangeFull,
    }

    Swift

    enum BNBColorRange : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBColorStd)
    {
        BNBColorStdBt601,
        BNBColorStdBt709,
    }

    Swift

    enum BNBColorStd : Int, @unchecked Sendable
  • These modes describe the relationship between processing loop and render loop frames

    Synchronous - Asynchronous:


    - Synchronous means to output (render) a frame only once after a new frame was fully processed
    - Asynchronous may render multiple (not waiting for frx), further divided into Consistent and Inconsistent sub-modes. (note: Synchronous mode by definition is always Consistent.)

    Consistent - Inconsistent:


    - Consistent renders the processed frames as-is, the only change being in the advancement of time (e.g. animations, videos), while
    - Inconsistent changes the camera image for that frame to the latest available (not yet processed), resulting in smoother rendering in case frx is slow or unsteady.

    “Smart” modes:


    There are modes with the “when effect loaded” suffix. These modes behave exactly the same as corresponding modes without such suffix, but only with one difference - they are activated only when the effect was completely loaded.
    These modes can be used to avoid image freeze during effect activation.

    See more

    Declaration

    Objective-C

    enum BNBConsistencyMode : NSInteger {}

    Swift

    enum BNBConsistencyMode : Int, @unchecked Sendable
  • The EffectPlayerPlaybackState enum values are available states of effect player playback life cycle

    See more

    Declaration

    Objective-C

    enum BNBEffectPlayerPlaybackState : NSInteger {}

    Swift

    enum BNBEffectPlayerPlaybackState : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBEffectStatus)
    {
        BNBEffectStatusInactive,
        BNBEffectStatusLoading,
        BNBEffectStatusActive,
        BNBEffectStatusError,
    }

    Swift

    enum BNBEffectStatus : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBFaceDataSource)
    {
        BNBFaceDataSourceRnd,
    }

    Swift

    enum BNBFaceDataSource : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBFeatureId)
    {
        BNBFeatureIdFrx,
        BNBFeatureIdPulse,
        BNBFeatureIdActionUnits,
        BNBFeatureIdBackground,
        BNBFeatureIdHair,
        BNBFeatureIdEyes,
        BNBFeatureIdBrows,
        BNBFeatureIdSkin,
        BNBFeatureIdFace,
        BNBFeatureIdLips,
        BNBFeatureIdLipsShine,
        BNBFeatureIdOcclussion,
        BNBFeatureIdGlasses,
        BNBFeatureIdAcne,
        BNBFeatureIdHandSkelet,
        BNBFeatureIdEyeBags,
        BNBFeatureIdFaceAcne,
        BNBFeatureIdRuler,
        BNBFeatureIdHairStrand,
        BNBFeatureIdRing,
        BNBFeatureIdNeck,
        BNBFeatureIdPoseEstimation,
        /** Body segmentation. I.e. bodies detection on the frame. */
        BNBFeatureIdBody,
        /** Nails segmentation and recoloring  */
        BNBFeatureIdNails,
        /** Combined face acne and eyebags removal */
        BNBFeatureIdAcneEyebags,
        BNBFeatureIdHandGestures,
        BNBFeatureIdTexturedNails,
        /** Activates eyes corrector */
        BNBFeatureIdEyesCorrection,
        /** Activates lips corrector */
        BNBFeatureIdLipsCorrection,
        /** Computes coefficient for light correction */
        BNBFeatureIdLightCorrection,
        /** Watch try-on */
        BNBFeatureIdWatch,
        BNBFeatureIdFaceMatch,
        /** Ears detection */
        BNBFeatureIdEars,
        /** Enable latents filtration for AU, affects FRX face mesh */
        BNBFeatureIdActionUnitsAntijitter,
        /** Face skin segmentation */
        BNBFeatureIdFaceSkin,
        BNBFeatureIdFaceAttributes,
        BNBFeatureIdPupillaryDistance,
        BNBFeatureIdFrownDetection,
        BNBFeatureIdGenderDetect,
        BNBFeatureIdTeethTone,
        BNBFeatureIdLightSource,
    }

    Swift

    enum BNBFeatureId : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBGender)
    {
        BNBGenderUndefined,
        BNBGenderMale,
        BNBGenderFemale,
    }

    Swift

    enum BNBGender : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBHardwareClass)
    {
        BNBHardwareClassLow,
        BNBHardwareClassMedium,
        BNBHardwareClassHigh,
    }

    Swift

    enum BNBHardwareClass : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBLicenseStatus)
    {
        /** everything is ok */
        BNBLicenseStatusValid,
        /** canceled by Banuba */
        BNBLicenseStatusRevoked,
        /** before begin time or expired */
        BNBLicenseStatusTimeBombed,
    }

    Swift

    enum BNBLicenseStatus : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBPixelFormat)
    {
        BNBPixelFormatRgb,
        BNBPixelFormatRgba,
        BNBPixelFormatBgr,
        BNBPixelFormatBgra,
        BNBPixelFormatArgb,
        BNBPixelFormatUndefined,
    }

    Swift

    enum BNBPixelFormat : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBProcessorStatus)
    {
        /** Processed frame data */
        BNBProcessorStatusOk,
        /** Processor output buffer is empty */
        BNBProcessorStatusEmpty,
        /** Processing is skipped */
        BNBProcessorStatusSkip,
        /** Error happen, check log */
        BNBProcessorStatusError,
    }

    Swift

    enum BNBProcessorStatus : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBProcessorType)
    {
        /** Live feed processor */
        BNBProcessorTypeRealtime,
        /** Photo processor */
        BNBProcessorTypePhoto,
        /** Video stream processor */
        BNBProcessorTypeVideo,
    }

    Swift

    enum BNBProcessorType : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBRealtimeProcessorMode)
    {
        /** Synchronous mode. Frame drop not allowed, `pop` will block on processing. */
        BNBRealtimeProcessorModeSync,
        /**
         * Synchronous mode when effect loaded. Frame drop not allowed.
         * During effect loading `push` will forward frames to `pop`, `pop` will return SKIP.
         * When effect loaded, `pop` will block on processing.
         */
        BNBRealtimeProcessorModeSyncWhenEffectLoaded,
        /**
         * Asynchronous mode. Frame drop is allowed. `push` and `pop` do not block on processing.
         * `push` can drop frames, if processor busy,
         * `pop` can return EMPTY, if no processed frame data for now.
         */
        BNBRealtimeProcessorModeAsync,
        /**
         * Asynchronous mode. Frame drop is allowed. `push` and `pop` do not block on processing.
         * During effect loading `push` will forward frames to `pop`, `pop` will return SKIP.
         * When effect loaded, `push` can drop frames, if processor busy,
         * `pop` can return EMPTY, if no processed frame data for now.
         */
        BNBRealtimeProcessorModeAsyncWhenEffectLoaded,
    }

    Swift

    enum BNBRealtimeProcessorMode : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBRecognizerMode)
    {
        /** Frame is processed only when pop_frame method called */
        BNBRecognizerModeSynchronous,
        /** Frame processing begins on push_frame method call */
        BNBRecognizerModeAsynchronous,
    }

    Swift

    enum BNBRecognizerMode : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBRenderBackendType)
    {
        BNBRenderBackendTypeOpengl,
        BNBRenderBackendTypeMetal,
    }

    Swift

    enum BNBRenderBackendType : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBRotation)
    {
        BNBRotationDeg0,
        BNBRotationDeg90,
        BNBRotationDeg180,
        BNBRotationDeg270,
    }

    Swift

    enum BNBRotation : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, BNBSeverityLevel)
    {
        BNBSeverityLevelDebug,
        BNBSeverityLevelInfo,
        BNBSeverityLevelWarning,
        BNBSeverityLevelError,
        BNBSeverityLevelNone,
    }

    Swift

    enum BNBSeverityLevel : Int, @unchecked Sendable
  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSUInteger, EPOrientation) {
        EPOrientationAngles0,
        EPOrientationAngles90,
        EPOrientationAngles180,
        EPOrientationAngles270
    }

    Swift

    enum EPOrientation : UInt, @unchecked Sendable