Updated documentation of MPPImageEmbedder

This commit is contained in:
Prianka Liz Kariat 2023-12-22 21:44:38 +05:30
parent efbd33f058
commit 8b7564b4fd

View File

@ -71,11 +71,9 @@ NS_SWIFT_NAME(ImageEmbedder)
* interest. Rotation will be applied according to the `orientation` property of the provided * interest. Rotation will be applied according to the `orientation` property of the provided
* `MPImage`. Only use this method when the `ImageEmbedder` is created with running mode, `.image`. * `MPImage`. Only use this method when the `ImageEmbedder` is created with running mode, `.image`.
* *
* This method supports embedding extraction on RGBA images. If your `MPImage` has a source type of * This method supports embedding extraction on RGBA images. If your `MPImage` has a
* `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must have one of the following * source type of `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must use
* pixel format types: * `kCVPixelFormatType_32BGRA` as its pixel format.
* 1. kCVPixelFormatType_32BGRA
* 2. kCVPixelFormatType_32RGBA
* *
* If your `MPImage` has a source type of `.image` ensure that the color space is RGB with an Alpha * If your `MPImage` has a source type of `.image` ensure that the color space is RGB with an Alpha
* channel. * channel.
@ -93,11 +91,9 @@ NS_SWIFT_NAME(ImageEmbedder)
* of the provided `MPImage`. Only use this method when the `ImageEmbedder` is created with running * of the provided `MPImage`. Only use this method when the `ImageEmbedder` is created with running
* mode, `.image`. * mode, `.image`.
* *
* This method supports embedding extraction on RGBA images. If your `MPImage` has a source type of * This method supports embedding extraction on RGBA images. If your `MPImage` has a
* `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must have one of the following * source type of `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must use
* pixel format types: * `kCVPixelFormatType_32BGRA` as its pixel format.
* 1. kCVPixelFormatType_32BGRA
* 2. kCVPixelFormatType_32RGBA
* *
* If your `MPImage` has a source type of `.image` ensure that the color space is RGB with an Alpha * If your `MPImage` has a source type of `.image` ensure that the color space is RGB with an Alpha
* channel. * channel.
@ -122,11 +118,9 @@ NS_SWIFT_NAME(ImageEmbedder)
* It's required to provide the video frame's timestamp (in milliseconds). The input timestamps must * It's required to provide the video frame's timestamp (in milliseconds). The input timestamps must
* be monotonically increasing. * be monotonically increasing.
* *
* This method supports embedding extraction on RGBA images. If your `MPImage` has a source type of * This method supports embedding extraction on RGBA images. If your `MPImage` has a
* `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must have one of the following * source type of `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must use
* pixel format types: * `kCVPixelFormatType_32BGRA` as its pixel format.
* 1. kCVPixelFormatType_32BGRA
* 2. kCVPixelFormatType_32RGBA
* *
* If your `MPImage` has a source type of `.image` ensure that the color space is RGB with an Alpha * If your `MPImage` has a source type of `.image` ensure that the color space is RGB with an Alpha
* channel. * channel.
@ -150,11 +144,9 @@ NS_SWIFT_NAME(ImageEmbedder)
* It's required to provide the video frame's timestamp (in milliseconds). The input timestamps must * It's required to provide the video frame's timestamp (in milliseconds). The input timestamps must
* be monotonically increasing. * be monotonically increasing.
* *
* This method supports embedding extraction on RGBA images. If your `MPImage` has a source type of * This method supports embedding extraction on RGBA images. If your `MPImage` has a
* `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must have one of the following * source type of `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must use
* pixel format types: * `kCVPixelFormatType_32BGRA` as its pixel format.
* 1. kCVPixelFormatType_32BGRA
* 2. kCVPixelFormatType_32RGBA
* *
* If your `MPImage` has a source type of `.image` ensure that the color space is RGB with an Alpha * If your `MPImage` has a source type of `.image` ensure that the color space is RGB with an Alpha
* channel. * channel.
@ -188,11 +180,9 @@ NS_SWIFT_NAME(ImageEmbedder)
* It's required to provide a timestamp (in milliseconds) to indicate when the input image is sent * It's required to provide a timestamp (in milliseconds) to indicate when the input image is sent
* to the image embedder. The input timestamps must be monotonically increasing. * to the image embedder. The input timestamps must be monotonically increasing.
* *
* This method supports embedding extraction on RGBA images. If your `MPImage` has a source type of * This method supports embedding extraction on RGBA images. If your `MPImage` has a
* .pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must have one of the following * source type of `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must use
* pixel format types: * `kCVPixelFormatType_32BGRA` as its pixel format.
* 1. kCVPixelFormatType_32BGRA
* 2. kCVPixelFormatType_32RGBA
* *
* If the input `MPImage` has a source type of `.image` ensure that the color space is RGB with an * If the input `MPImage` has a source type of `.image` ensure that the color space is RGB with an
* Alpha channel. * Alpha channel.
@ -227,11 +217,9 @@ NS_SWIFT_NAME(ImageEmbedder)
* It's required to provide a timestamp (in milliseconds) to indicate when the input image is sent * It's required to provide a timestamp (in milliseconds) to indicate when the input image is sent
* to the image embedder. The input timestamps must be monotonically increasing. * to the image embedder. The input timestamps must be monotonically increasing.
* *
* This method supports embedding extraction on RGBA images. If your `MPImage` has a source type of * This method supports embedding extraction on RGBA images. If your `MPImage` has a
* `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must have one of the following * source type of `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must use
* pixel format types: * `kCVPixelFormatType_32BGRA` as its pixel format.
* 1. kCVPixelFormatType_32BGRA
* 2. kCVPixelFormatType_32RGBA
* *
* If the input `MPImage` has a source type of `.image` ensure that the color space is RGB with an * If the input `MPImage` has a source type of `.image` ensure that the color space is RGB with an
* Alpha channel. * Alpha channel.