Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKVideoRawData Class Reference

A class that contains the information of video raw data. More...

#include <ZoomVideoSDKVideoRawData.h>

Inherits NSObject.

Instance Methods

(BOOL) - canAddRef
 Determines whether the reference count for accessing the raw data buffer can be increased.
 
(BOOL) - addRef
 Increases reference count by 1. Adding a reference will ensure that the raw data buffer will not be released.
 
(NSInteger) - releaseRef
 Decreases reference count by 1.
 

Properties

char * yBuffer
 Gets the YUVI420 Y buffer. The Y component represents the luma or brightness values.
 
char * uBuffer
 Gets the YUVI420 U buffer. The U component represents the chroma values.
 
char * vBuffer
 Gets the YUVI420 V buffer. The V component represents the chroma values.
 
char * alphaBuffer
 Gets the YUVI420 data buffer. The alpha component represents the alpha values.
 
NSUInteger alphaBufferLen
 Gets the alpha buffer data length.
 
CGSize size
 Gets the stream size.
 
BOOL isLimited
 Determines whether video raw data is limited.
 
ZoomVideoSDKFrameDataFormat format
 Gets the raw data format of video data.
 
ZoomVideoSDKVideoRawDataRotation rotation
 Gets the video raw data rotation.
 
NSDate * timeStamp
 Gets the timestamp of video data.
 

Detailed Description

A class that contains the information of video raw data.

Definition at line 13 of file ZoomVideoSDKVideoRawData.h.

Method Documentation

◆ addRef

- (BOOL) addRef

Increases reference count by 1. Adding a reference will ensure that the raw data buffer will not be released.

Returns
YES if the function succeeds. Otherwise, NO.
Warning
If you addRef, the SDK will try to hold the raw data buffer until the reference becomes 0. When you finish using the raw data buffer, you must call releaseRef.

◆ canAddRef

- (BOOL) canAddRef

Determines whether the reference count for accessing the raw data buffer can be increased.

Returns
YES if the reference count can be increased. Otherwise, NO.
Warning
If you addRef, the SDK will try to hold the raw data buffer until the reference becomes 0. When you finish using the raw data buffer, you must call releaseRef.

◆ releaseRef

- (NSInteger) releaseRef

Decreases reference count by 1.

Returns
The current reference count after release.
Warning
If you addRef, the SDK will try to hold the raw data buffer until the reference becomes 0. When you finish using the raw data buffer, you must call releaseRef.

Property Documentation

◆ alphaBuffer

- (char*) alphaBuffer
readwritenonatomicassign

Gets the YUVI420 data buffer. The alpha component represents the alpha values.

Definition at line 33 of file ZoomVideoSDKVideoRawData.h.

◆ alphaBufferLen

- (NSUInteger) alphaBufferLen
readwritenonatomicassign

Gets the alpha buffer data length.

Definition at line 38 of file ZoomVideoSDKVideoRawData.h.

◆ format

- (ZoomVideoSDKFrameDataFormat) format
readwritenonatomicassign

Gets the raw data format of video data.

Definition at line 53 of file ZoomVideoSDKVideoRawData.h.

◆ isLimited

- (BOOL) isLimited
readwritenonatomicassign

Determines whether video raw data is limited.

Definition at line 48 of file ZoomVideoSDKVideoRawData.h.

◆ rotation

- (ZoomVideoSDKVideoRawDataRotation) rotation
readwritenonatomicassign

Gets the video raw data rotation.

Definition at line 58 of file ZoomVideoSDKVideoRawData.h.

◆ size

- (CGSize) size
readwritenonatomicassign

Gets the stream size.

Definition at line 43 of file ZoomVideoSDKVideoRawData.h.

◆ timeStamp

- (NSDate*) timeStamp
readwritenonatomicstrong

Gets the timestamp of video data.

Definition at line 63 of file ZoomVideoSDKVideoRawData.h.

◆ uBuffer

- (char*) uBuffer
readwritenonatomicassign

Gets the YUVI420 U buffer. The U component represents the chroma values.

Definition at line 23 of file ZoomVideoSDKVideoRawData.h.

◆ vBuffer

- (char*) vBuffer
readwritenonatomicassign

Gets the YUVI420 V buffer. The V component represents the chroma values.

Definition at line 28 of file ZoomVideoSDKVideoRawData.h.

◆ yBuffer

- (char*) yBuffer
readwritenonatomicassign

Gets the YUVI420 Y buffer. The Y component represents the luma or brightness values.

Definition at line 18 of file ZoomVideoSDKVideoRawData.h.