Inherits <NSObject>.
Properties of the AgoraVideoFrame object.
◆ fillAlphaData
If data format is BGRA or RGBA and alphaBuf is nill, it is required to call fillAlphaData to fill alphaBuf.
◆ format
Video format:
- 1: I420
- 2: BGRA
- 3: NV21
- 4: RGBA
- 5: IMC2
- 7: ARGB
- 8: NV12
- 12: iOS texture (CVPixelBufferRef)
- 13: Still Image (UIImage for iPhone, NSImage for Mac)
◆ time
Timestamp of the incoming video frame (ms). An incorrect timestamp will result in frame loss or unsynchronized audio and video.
◆ stride
◆ strideInPixels
Line spacing of the incoming video frame, which must be in pixels instead of bytes. For textures, it is the width of the texture.
◆ height
Height of the incoming video frame.
◆ textureBuf
- (CVPixelBufferRef _Nullable) textureBuf |
|
readwritenonatomicassign |
◆ image
Still Image (UIImage for iPhone, NSImage for Mac)
◆ dataBuf
- (NSData* _Nullable) dataBuf |
|
readwritenonatomicstrong |
◆ alphaBuf
- (NSData* _Nullable) alphaBuf |
|
readwritenonatomicstrong |
Indicates the alpha channel of current frame, which is consistent with the dimension of the video frame. The value range of each pixel is [0,255], where 0 represents the background; 255 represents the foreground. The default value is nill.
◆ alphaStitchMode
The relative position between alphabuffer and the frame. 0: Normal frame; 1: Alphabuffer is above the frame; 2: Alphabuffer is below the frame; 3: Alphabuffer is on the left of frame; 4: Alphabuffer is on the right of frame; The default value is 0.
◆ cropLeft
(Optional) Specifies the number of pixels trimmed from the left, which is set as 0 by default.
◆ cropTop
(Optional) Specifies the number of pixels trimmed from the top, which is set as 0 by default.
◆ cropRight
(Optional) Specifies the number of pixels trimmed from the right, which is set as 0 by default.
◆ cropBottom
(Optional) Specifies the number of pixels trimmed from the bottom, which is set as 0 by default.
◆ rotation
(Optional) Specifies whether to rotate the incoming video group. Optional values: 0, 90, 180, or 270 clockwise. Set as 0 by default.
◆ colorSpace
Specifies the color space.