MobileRTCVideoRawData Class Reference

Represents raw data received from subscribed video stream. More...

#include <MobileRTCVideoRawData.h>

Inherits NSObject.

Instance Methods
(BOOL)	- canAddRef
	Determines if adding a reference is allowed.
(BOOL)	- addRef
	Increases the reference count by 1.
(NSInteger)	- releaseRef
	Decreases the reference count by 1.

Properties
char *	yBuffer
	The Y buffer pointer to a video's YUV data.
char *_Nullable	uBuffer
	The U buffer pointer to a video's YUV data.
char *_Nullable	vBuffer
	The V buffer pointer to a video's YUV data.
CGSize	size
	The video data size.
char *_Nullable	alphaBuffer
	A pointer to a video's alpha data.
unsigned int	alphaBufferLen
	The length of the alpha buffer data.
MobileRTCFrameDataFormat	format
	The raw data format of the video data.
MobileRTCVideoRawDataRotation	rotation
	The video data rotation.
NSDate *	timeStamp
	The timestamp of the video data.
MobileRTCFaceROIInfo *	faceROIInfo
	Per-frame face ROI metadata reported by the sender.

Detailed Description

Represents raw data received from subscribed video stream.

Definition at line 13 of file MobileRTCVideoRawData.h.

Method Documentation

addRef

- (BOOL) addRef

Increases the reference count by 1.

Returns

YES if successfully added. Otherwise, NO.

References addRef.

Referenced by addRef.

canAddRef

- (BOOL) canAddRef

Determines if adding a reference is allowed.

Returns

YES if allowed. Otherwise, NO.

References canAddRef.

Referenced by canAddRef.

releaseRef

- (NSInteger) releaseRef

Decreases the reference count by 1.

Returns

If the function succeeds, it returns the reference count of this object.

References releaseRef.

Referenced by releaseRef.

Property Documentation

alphaBuffer

- (char* _Nullable) alphaBuffer

readwritenonatomicassign

A pointer to a video's alpha data.

Definition at line 38 of file MobileRTCVideoRawData.h.

alphaBufferLen

- (unsigned int) alphaBufferLen

readwritenonatomicassign

The length of the alpha buffer data.

Definition at line 43 of file MobileRTCVideoRawData.h.

faceROIInfo

- (MobileRTCFaceROIInfo*) faceROIInfo

readnonatomicstrong

Per-frame face ROI metadata reported by the sender.

Always non-null; inspect -getFaceCount to determine whether any face was reported. The accessor is a self-contained snapshot captured when the delegate fires, so it may be safely retained and used asynchronously after the callback returns - the underlying MobileRTCVideoRawData frame does not need to outlive it.

Note

The same per-frame face ROI metadata is also delivered to -onMobileRTCRender:framePixelBuffer:extraInfo: via MobileRTCVideoPixelBufferExtraInfo.faceROIInfo, for delegates that consume CVPixelBuffer-shaped frames instead of YUV I420.

Face ROI is only supported on video streams.

Definition at line 77 of file MobileRTCVideoRawData.h.

format

- (MobileRTCFrameDataFormat) format

readwritenonatomicassign

The raw data format of the video data.

Definition at line 48 of file MobileRTCVideoRawData.h.

rotation

- (MobileRTCVideoRawDataRotation) rotation

readwritenonatomicassign

The video data rotation.

Definition at line 53 of file MobileRTCVideoRawData.h.

size

- (CGSize) size

readwritenonatomicassign

The video data size.

Definition at line 33 of file MobileRTCVideoRawData.h.

timeStamp

- (NSDate*) timeStamp

readwritenonatomicstrong

The timestamp of the video data.

Definition at line 58 of file MobileRTCVideoRawData.h.

uBuffer

- (char* _Nullable) uBuffer

readwritenonatomicassign

The U buffer pointer to a video's YUV data.

Definition at line 23 of file MobileRTCVideoRawData.h.

vBuffer

- (char* _Nullable) vBuffer

readwritenonatomicassign

The V buffer pointer to a video's YUV data.

Definition at line 28 of file MobileRTCVideoRawData.h.

yBuffer

- (char*) yBuffer

readwritenonatomicassign

The Y buffer pointer to a video's YUV data.

Definition at line 18 of file MobileRTCVideoRawData.h.