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

#import <MobileRTCRenderer.h>

Inherits NSObject.

Instance Methods

(instancetype _Nonnull) - initWithDelegate:
 Initialize MobileRTCRenderer.
 
(MobileRTCRawDataError- setRawDataResolution:
 Call the function to set video resolution.
 
(MobileRTCRawDataError- subscribe:videoType:
 Call the function to subscribe to raw video data.
 
(MobileRTCRawDataError- unSubscribe
 Call the function to unsubscribe from raw video data.
 

Properties

NSUInteger userId
 MobileRTCRenderer's user ID.
 
MobileRTCVideoType videoType
 MobileRTCRenderer's video type defined in MobileRTCVideoType.
 
MobileRTCVideoResolution resolution
 MobileRTCRenderer's video resolution defined in MobileRTCVideoResolution.
 

Detailed Description

Definition at line 12 of file MobileRTCRenderer.h.

Method Documentation

◆ initWithDelegate:

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

Initialize MobileRTCRenderer.

Parameters
delegate- The delegate to receive callbacks. See MobileRTCVideoRawDataDelegate.
Returns
The MobileRTCRenderer object.

◆ setRawDataResolution:

- (MobileRTCRawDataError) setRawDataResolution: (MobileRTCVideoResolution resolution

Call the function to set video resolution.

Returns
If the function succeeds, the return value is MobileRTCRawData_Success. Otherwise, the function fails and returns null. To get extended error information, see MobileRTCRawDataError.

◆ subscribe:videoType:

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

Call the function to subscribe to raw video data.

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.
Returns
If the function succeeds, the return value is MobileRTCRawData_Success. Otherwise, the function fails and returns null. To get extended error information, see MobileRTCRawDataError.

◆ unSubscribe

- (MobileRTCRawDataError) unSubscribe

Call the function to unsubscribe from raw video data.

Returns
If the function succeeds, the return value is MobileRTCRawData_Success. Otherwise, the function fails and returns null. To get extended error information, see MobileRTCRawDataError.

Property Documentation

◆ resolution

- (MobileRTCVideoResolution) resolution
readnonatomicassign

MobileRTCRenderer's video resolution defined in MobileRTCVideoResolution.

Definition at line 27 of file MobileRTCRenderer.h.

◆ userId

- (NSUInteger) userId
readnonatomicassign

MobileRTCRenderer's user ID.

Definition at line 17 of file MobileRTCRenderer.h.

◆ videoType

- (MobileRTCVideoType) videoType
readnonatomicassign

MobileRTCRenderer's video type defined in MobileRTCVideoType.

Definition at line 22 of file MobileRTCRenderer.h.