Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCRenderer Class Reference

A class for rendering video raw data. More...

#include <MobileRTCRenderer.h>

Inherits NSObject.

Instance Methods

(instancetype _Nonnull) - initWithDelegate:
 Initializes MobileRTCRenderer.
 
(MobileRTCRawDataError- setRawDataResolution:
 Sets the video resolution.
 
(MobileRTCRawDataError- subscribe:videoType:
 Subscribes to raw video data.
 
(MobileRTCRawDataError- unSubscribe
 Unsubscribes from raw video data.
 

Properties

NSUInteger userId
 The user ID.
 
MobileRTCVideoType videoType
 The video type.
 
MobileRTCVideoResolution resolution
 The video resolution.
 

Detailed Description

A class for rendering video raw data.

Definition at line 13 of file MobileRTCRenderer.h.

Method Documentation

◆ initWithDelegate:

- (instancetype _Nonnull) initWithDelegate: (id< MobileRTCVideoRawDataDelegate >_Nonnull) delegate

Initializes MobileRTCRenderer.

Parameters
delegateThe delegate that receives callbacks.
Returns
The MobileRTCRenderer object.

◆ setRawDataResolution:

- (MobileRTCRawDataError) setRawDataResolution: (MobileRTCVideoResolution) resolution

Sets the video resolution.

Parameters
resolutionThe video resolution.
Returns
If the function succeeds, it will return MobileRTCRawDataError_Success. Otherwise return an error.

◆ subscribe:videoType:

- (MobileRTCRawDataError) subscribe: (NSUInteger) userId
videoType: (MobileRTCVideoType) type 

Subscribes to raw video data.

Parameters
userIdThe user ID.
typeThe video type.
Returns
If the function succeeds, it will return MobileRTCRawDataError_Success. Otherwise return an error.
Note
Before entering the meeting, subscribe to your preview video data with userId = 0.
If you are already in the meeting, subscribe to your own video data using the real userId or userId = 0.

◆ unSubscribe

- (MobileRTCRawDataError) unSubscribe

Unsubscribes from raw video data.

Returns
If the function succeeds, it will return MobileRTCRawDataError_Success. Otherwise return an error.

Property Documentation

◆ resolution

- (MobileRTCVideoResolution) resolution
readnonatomicassign

The video resolution.

Definition at line 28 of file MobileRTCRenderer.h.

◆ userId

- (NSUInteger) userId
readnonatomicassign

The user ID.

Definition at line 18 of file MobileRTCRenderer.h.

◆ videoType

- (MobileRTCVideoType) videoType
readnonatomicassign

The video type.

Definition at line 23 of file MobileRTCRenderer.h.