ZoomSDKYUVRawDataI420 Class Reference

Represents raw YUV I420 format data received from subscribed video stream. More...

#include <ZoomSDKRenderer.h>

Inherits NSObject.

Instance Methods
(BOOL)	- canAddRef
	Gets if this object can add ref.
(BOOL)	- addRef
	Adds reference for this object, if you doesn't add ref, this object is 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
	Gets the Y data.
(char *_Nullable)	- getUBuffer
	Gets the U data.
(char *_Nullable)	- getVBuffer
	Gets the V data.
(char *_Nullable)	- getBuffer
	Gets the buffer data.
(char *_Nullable)	- getAlphaBuffer
	Gets video alpha mask data buffer.
(unsigned int)	- getBufferLen
	Gets the buffer length of this data.
(unsigned int)	- getAlphaBufferLen
	Gets the alpha buffer length.
(BOOL)	- isLimitedI420
	Gets if this data is limited I420 format.
(unsigned int)	- getStreamWidth
	Gets the stream width of this data.
(unsigned int)	- getStreamHeight
	Gets the stream height of this data.
(unsigned int)	- getRotation
	Gets the rotation of this data.
(unsigned int)	- getSourceID
	Gets the s␝ource ID of this data.
(long long)	- getTimeStamp
	Gets the raw data's timestamp.

Detailed Description

Represents raw YUV I420 format data received from subscribed video stream.

Definition at line 16 of file ZoomSDKRenderer.h.

Method Documentation

addRef

- (BOOL) addRef

Adds reference for this object, if you doesn't add ref, this object is released when the callback response ends.

Returns

If the function succeeds, it returns YES. Otherwise, NO.

canAddRef

- (BOOL) canAddRef

Gets if this object can add ref.

Returns

If can add ref, it returns YES. Otherwise, NO.

getAlphaBuffer

- (char *_Nullable) getAlphaBuffer

Gets video alpha mask data buffer.

Returns

Buffer address if alpha data exists. Otherwise, this function fails and returns nil.

getAlphaBufferLen

- (unsigned int) getAlphaBufferLen

Gets the alpha buffer length.

Returns

The length of alpha data.

getBuffer

- (char *_Nullable) getBuffer

Gets the buffer data.

Returns

If the function succeeds, it returns the buffer data. Otherwise, this function fails and returns nil.

getBufferLen

- (unsigned int) getBufferLen

Gets the buffer length of this data.

Returns

If the function succeeds, it returns the buffer length of this data. Otherwise, returns 0.

getRotation

- (unsigned int) getRotation

Gets the rotation of this data.

Returns

If the function succeeds, it returns the rotation of this data. Otherwise, returns 0.

getSourceID

- (unsigned int) getSourceID

Gets the s␝ource ID of this data.

Returns

If the function succeeds, it returns the source ID of this data. Otherwise, returns 0.

getStreamHeight

- (unsigned int) getStreamHeight

Gets the stream height of this data.

Returns

If the function succeeds, it returns the stream height of this data. Otherwise, returns 0.

getStreamWidth

- (unsigned int) getStreamWidth

Gets the stream width of this data.

Returns

If the function succeeds, it returns the stream width of this data. Otherwise, returns 0.

getTimeStamp

- (long long) getTimeStamp

Gets the raw data's timestamp.

Returns

If the function succeeds, it returns the millisecond timestamp. Otherwise, returns 0.

getUBuffer

- (char *_Nullable) getUBuffer

Gets the U data.

Returns

If the function succeeds, it returns the U data. Otherwise, this function fails and returns nil.

getVBuffer

- (char *_Nullable) getVBuffer

Gets the V data.

Returns

If the function succeeds, it returns the V data. Otherwise, this function fails and returns nil.

getYBuffer

- (char *_Nullable) getYBuffer

Gets the Y data.

Returns

If the function succeeds, it returns the Y data. Otherwise, this function fails and returns nil.

isLimitedI420

- (BOOL) isLimitedI420

Gets if this data is limited I420 format.

Returns

If is limited I420 format, it returns 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 returns reference count of this object. Otherwise, returns -1.