RTCVideoFrame Class Reference

#import <RTCVideoFrame.h>

Inheritance diagram for RTCVideoFrame:

Instance Methods
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- initWithPixelBuffer:rotation:timeStampNs:
(instancetype)	- initWithPixelBuffer:scaledWidth:scaledHeight:cropWidth:cropHeight:cropX:cropY:rotation:timeStampNs:
(RTCVideoFrame *)	- newI420VideoFrame
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- initWithPixelBuffer:rotation:timeStampNs:
(instancetype)	- initWithPixelBuffer:scaledWidth:scaledHeight:cropWidth:cropHeight:cropX:cropY:rotation:timeStampNs:
(RTCVideoFrame *)	- newI420VideoFrame
(instancetype)	- initWithVideoBuffer:rotation:timeStampNs: [implementation]
(instancetype)	- initWithVideoBuffer:rotation:timeStampNs: [implementation]

Properties
int	width
int	height
RTCVideoRotation	rotation
const uint8_t *	dataY
const uint8_t *	dataU
const uint8_t *	dataV
int	strideY
int	strideU
int	strideV
int64_t	timeStampNs
CVPixelBufferRef	nativeHandle

Method Documentation

initWithPixelBuffer:rotation:timeStampNs:() [1/2]

- (instancetype) initWithPixelBuffer:		(CVPixelBufferRef)	pixelBuffer
rotation:		(RTCVideoRotation)	rotation
timeStampNs:		(int64_t)	timeStampNs

Initialize an RTCVideoFrame from a pixel buffer, rotation, and timestamp.

initWithPixelBuffer:rotation:timeStampNs:() [2/2]

- (instancetype) initWithPixelBuffer:		(CVPixelBufferRef)	pixelBuffer
rotation:		(RTCVideoRotation)	rotation
timeStampNs:		(int64_t)	timeStampNs

Initialize an RTCVideoFrame from a pixel buffer, rotation, and timestamp.

initWithPixelBuffer:scaledWidth:scaledHeight:cropWidth:cropHeight:cropX:cropY:rotation:timeStampNs:() [1/2]

- (instancetype) initWithPixelBuffer:		(CVPixelBufferRef)	pixelBuffer
scaledWidth:		(int)	scaledWidth
scaledHeight:		(int)	scaledHeight
cropWidth:		(int)	cropWidth
cropHeight:		(int)	cropHeight
cropX:		(int)	cropX
cropY:		(int)	cropY
rotation:		(RTCVideoRotation)	rotation
timeStampNs:		(int64_t)	timeStampNs

Initialize an RTCVideoFrame from a pixel buffer combined with cropping and scaling. Cropping will be applied first on the pixel buffer, followed by scaling to the final resolution of scaledWidth x scaledHeight.

initWithPixelBuffer:scaledWidth:scaledHeight:cropWidth:cropHeight:cropX:cropY:rotation:timeStampNs:() [2/2]

- (instancetype) initWithPixelBuffer:		(CVPixelBufferRef)	pixelBuffer
scaledWidth:		(int)	scaledWidth
scaledHeight:		(int)	scaledHeight
cropWidth:		(int)	cropWidth
cropHeight:		(int)	cropHeight
cropX:		(int)	cropX
cropY:		(int)	cropY
rotation:		(RTCVideoRotation)	rotation
timeStampNs:		(int64_t)	timeStampNs

Initialize an RTCVideoFrame from a pixel buffer combined with cropping and scaling. Cropping will be applied first on the pixel buffer, followed by scaling to the final resolution of scaledWidth x scaledHeight.

initWithVideoBuffer:rotation:timeStampNs:() [1/2]

- (instancetype) initWithVideoBuffer: (rtc::scoped_refptr< webrtc::VideoFrameBuffer >)  videoBuffer rotation: (RTCVideoRotation)  rotation timeStampNs: (int64_t)  NS_DESIGNATED_INITIALIZER

implementation

initWithVideoBuffer:rotation:timeStampNs:() [2/2]

- (instancetype) initWithVideoBuffer: (rtc::scoped_refptr< webrtc::VideoFrameBuffer >)  videoBuffer rotation: (RTCVideoRotation)  rotation timeStampNs: (int64_t)  NS_DESIGNATED_INITIALIZER

implementation

newI420VideoFrame() [1/2]

- (RTCVideoFrame *) newI420VideoFrame

Return a frame that is guaranteed to be I420, i.e. it is possible to access the YUV data on it.

newI420VideoFrame() [2/2]

- (RTCVideoFrame *) newI420VideoFrame

Return a frame that is guaranteed to be I420, i.e. it is possible to access the YUV data on it.

NS_UNAVAILABLE() [1/4]

- (instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE() [2/4]

- (instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE() [3/4]

- (instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE() [4/4]

- (instancetype) NS_UNAVAILABLE

Property Documentation

dataU

- (const uint8_t *) dataU

readnonatomicassign

dataV

- (const uint8_t *) dataV

readnonatomicassign

dataY

- (const uint8_t *) dataY

readnonatomicassign

Accessing YUV data should only be done for I420 frames, i.e. if nativeHandle is null. It is always possible to get such a frame by calling newI420VideoFrame.

height

- (int) height

readnonatomicassign

Height without rotation applied.

nativeHandle

- (CVPixelBufferRef) nativeHandle

readnonatomicassign

The native handle should be a pixel buffer on iOS.

rotation

- (RTCVideoRotation) rotation

readnonatomicassign

strideU

- (int) strideU

readnonatomicassign

strideV

- (int) strideV

readnonatomicassign

strideY

- (int) strideY

readnonatomicassign

timeStampNs

- (int64_t) timeStampNs

readnonatomicassign

Timestamp in nanoseconds.

width

- (int) width

readnonatomicassign

Width without rotation applied.

---

The documentation for this class was generated from the following files:

• DerivedData/WebKit/Build/Products/Debug/usr/local/include/webrtc/sdk/objc/Framework/Headers/WebRTC/RTCVideoFrame.h
• Source/ThirdParty/libwebrtc/Source/webrtc/sdk/objc/Framework/Classes/RTCVideoFrame.mm