Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKYUVRawDataI420 Class Reference

#include <ZoomSDKRenderer.h>

Inherits NSObject.

Instance Methods

(BOOL) - canAddRef
 Get if this object can add ref.
 
(BOOL) - addRef
 Add reference for this object, if you doesn't add ref, this object will be released when the callback response ends.
 
(int) - releaseData
 Release the object, if you has add ref, remeber to call this api to release when you wantn't to use this object.
 
(char *_Nullable) - getYBuffer
 Get the Y data.
 
(char *_Nullable) - getUBuffer
 Get the U data.
 
(char *_Nullable) - getVBuffer
 Get the V data.
 
(char *_Nullable) - getBuffer
 Get the buffer data.
 
(char *_Nullable) - getAlphaBuffer
 Get video alpha mask data buffer.
 
(unsigned int) - getBufferLen
 Get the buffer length of this data.
 
(unsigned int) - getAlphaBufferLen
 Get the alpha buffer length.
 
(BOOL) - isLimitedI420
 Get if this data is limited I420 format.
 
(unsigned int) - getStreamWidth
 Get the stream width of this data.
 
(unsigned int) - getStreamHeight
 Get the stream height of this data.
 
(unsigned int) - getRotation
 Get the rotation of this data.
 
(unsigned int) - getSourceID
 Get the s␝ource id of this data.
 
(long long) - getTimeStamp
 Get the timestamp of the raw data.
 

Detailed Description

Definition at line 11 of file ZoomSDKRenderer.h.

Method Documentation

◆ addRef

- (BOOL) addRef

Add reference for this object, if you doesn't add ref, this object will be released when the callback response ends.

Returns
If the function succeeds, it will return YES. Otherwise NO.

◆ canAddRef

- (BOOL) canAddRef

Get if this object can add ref.

Returns
If can add ref, it will return YES. Otherwise NO.

◆ getAlphaBuffer

- (char *_Nullable) getAlphaBuffer

Get video alpha mask data buffer.

Returns
buffer address if alpha data exists. Otherwise nil.

◆ getAlphaBufferLen

- (unsigned int) getAlphaBufferLen

Get the alpha buffer length.

Returns
The length of alpha data.

◆ getBuffer

- (char *_Nullable) getBuffer

Get the buffer data.

Returns
If the function succeeds, it will return the buffer data.

◆ getBufferLen

- (unsigned int) getBufferLen

Get the buffer length of this data.

Returns
If the function succeeds, it will return the buffer length of this data.

◆ getRotation

- (unsigned int) getRotation

Get the rotation of this data.

Returns
If the function succeeds, it will return the rotation of this data.

◆ getSourceID

- (unsigned int) getSourceID

Get the s␝ource id of this data.

Returns
If the function succeeds, it will return the source id of this data.

◆ getStreamHeight

- (unsigned int) getStreamHeight

Get the stream height of this data.

Returns
If the function succeeds, it will return the stream height of this data.

◆ getStreamWidth

- (unsigned int) getStreamWidth

Get the stream width of this data.

Returns
If the function succeeds, it will return the stream width of this data.

◆ getTimeStamp

- (long long) getTimeStamp

Get the timestamp of the raw data.

Returns
If the function succeeds, it will return the millisecond timestamp.

◆ getUBuffer

- (char *_Nullable) getUBuffer

Get the U data.

Returns
If the function succeeds, it will return the U data.

◆ getVBuffer

- (char *_Nullable) getVBuffer

Get the V data.

Returns
If the function succeeds, it will return the V data.

◆ getYBuffer

- (char *_Nullable) getYBuffer

Get the Y data.

Returns
If the function succeeds, it will return the Y data.

◆ isLimitedI420

- (BOOL) isLimitedI420

Get if this data is limited I420 format.

Returns
If is limited I420 format, it will return YES. Otherwise NO.

◆ releaseData

- (int) releaseData

Release the object, if you has add ref, remeber to call this api to release when you wantn't to use this object.

Returns
If the function succeeds, it will return reference count of this object.