Type Definitions

The following type definitions are available globally.

  • Deprecated

    Use the Player API instead

    Undocumented

    See more

    Declaration

    Objective-C

    typedef struct
    {
        /**
         * the size of the input image
         */
        CGSize imageSize;
        /**
         * Image orientation, Angles0 means head at the top, other angles mean counterlockwise rotation
         */
        EPOrientation orientation;
        /**
         * Resulting image orientation. If it matches the orientation then image will be returned in the same orientation.
         * Set to EPOrientationAngles0 to keep OEP default orientation.
         */
        EPOrientation resultedImageOrientation;
        /**
         * If YES, then the resulted image will be mirrored
         */
        BOOL isMirrored;
        /**
         * TODO: Add support to return YUV with Alpha. Returns BGRA since YUV-Alpha is not supported yet
         * Used for the cases when the returned image should include valid alpha channel
         */
        BOOL needAlphaInOutput;
        /**
         * Input image format determines output image format, conversion takes time. EffectPlayer produces images in RGBA, if you request BGRA the time to get BGRA is minimal.
         */
        BOOL overrideOutputToBGRA;
        /**
         * Omit conversion, returned pixel buffer is the CVPixelBuffer which is associated with Rendered Texture. The buffer type is BGRA, but texture is RGBA, so if such buffer is drawn without additional processing its colors will look unpredictably.
         */
        BOOL outputTexture;
    } EpImageFormat
  • Deprecated

    Use the Player API instead

    Invoked with true if effect was succesfully loaded.

    Declaration

    Objective-C

    typedef void (^BNBEffectStatusBlock)(_Bool)

    Swift

    typealias BNBEffectStatusBlock = (Bool) -> Void
  • Deprecated

    Use the Player API instead

    block to return resulting image after processing NOTE: pixelBuffer can be null if the frame is dropped because of queue or because it passed unsupported image format for the target image

    Declaration

    Objective-C

    typedef void (^BNBOEPImageReadyBlock)(CVPixelBufferRef _Nullable,
                                          NSNumber *_Nonnull)

    Swift

    typealias BNBOEPImageReadyBlock = (CVPixelBuffer?, NSNumber) -> Void
  • Deprecated

    Use the Player API instead

    block to return result of execution of JS script in method evalJs

    Declaration

    Objective-C

    typedef void (^BNBOEPEvalJsResult)(NSString *_Nonnull)

    Swift

    typealias BNBOEPEvalJsResult = (String) -> Void