iOS API Doc
Instance Methods | List of all members
MobileRTCMeetingService(Video) Category Reference

Instance Methods

(BOOL) - isSendingMyVideo
 Query if the user is sending video.
More...
 
(BOOL) - canUnmuteMyVideo
 Query if user can unmute his video himself. More...
 
(MobileRTCVideoError) - muteMyVideo:
 Set to mute video of the current user. More...
 
(BOOL) - isUserSpotlighted:
 Query if user's video is spotlighted. Once the user's video is spotlighted, it will show only the specified video in the meeting instead of active user's.
More...
 
(BOOL) - spotlightVideo:withUser:
 Set whether to spotlight user's video. More...
 
(BOOL) - isUserPinned:
 Query if the user's video is pinned. More...
 
(BOOL) - pinVideo:withUser:
 Set whether to pin user's video or not. More...
 
(BOOL) - isUserVideoSending:
 Query if user's video is being sent. More...
 
(BOOL) - stopUserVideo:
 Set to stop user's video. More...
 
(BOOL) - askUserStartVideo:
 Host can use this function to demand user to start video. More...
 
(CGSize) - getUserVideoSize:
 Get the size of user's video. More...
 
(BOOL) - isBackCamera
 Query if user is using back camera. More...
 
(MobileRTCCameraError) - switchMyCamera
 Set to Switch the camera of the current user in local device. More...
 

Method Documentation

◆ askUserStartVideo:()

- (BOOL) askUserStartVideo: (NSUInteger)  userID

Host can use this function to demand user to start video.

Parameters
userIDThe ID of user who needs to turn on video in meeting.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only host can run the function in the meeting.

Extends class MobileRTCMeetingService.

◆ canUnmuteMyVideo()

- (BOOL) canUnmuteMyVideo

Query if user can unmute his video himself.

Returns
YES means able, otherwise not.

Extends class MobileRTCMeetingService.

◆ getUserVideoSize:()

- (CGSize) getUserVideoSize: (NSUInteger)  userID

Get the size of user's video.

Parameters
userIDThe ID of user in the meeting
Returns
The size of user's video.

Extends class MobileRTCMeetingService.

◆ isBackCamera()

- (BOOL) isBackCamera

Query if user is using back camera.

Returns
YES means using Back camera, otherwise not.

Extends class MobileRTCMeetingService.

◆ isSendingMyVideo()

- (BOOL) isSendingMyVideo

Query if the user is sending video.

Returns
YES means sending, otherwise not.

Extends class MobileRTCMeetingService.

◆ isUserPinned:()

- (BOOL) isUserPinned: (NSUInteger)  userId

Query if the user's video is pinned.

Parameters
userIdThe ID of user whose video will be pinned in the meeting.
Returns
YES means that the user's video is pinned, otherwise not.

Extends class MobileRTCMeetingService.

◆ isUserSpotlighted:()

- (BOOL) isUserSpotlighted: (NSUInteger)  userId

Query if user's video is spotlighted. Once the user's video is spotlighted, it will show only the specified video in the meeting instead of active user's.

Parameters
userIdThe ID of user in meeting.
Returns
YES means spotlighted, otherwise not.

Extends class MobileRTCMeetingService.

◆ isUserVideoSending:()

- (BOOL) isUserVideoSending: (NSUInteger)  userID

Query if user's video is being sent.

Parameters
userIDThe ID of user whose video will be sent in meeting
Returns
YES means that the video is being sent, otherwise not.

Extends class MobileRTCMeetingService.

◆ muteMyVideo:()

- (MobileRTCVideoError) muteMyVideo: (BOOL)  mute

Set to mute video of the current user.

Parameters
muteYES means to mute video of the current user, otherwise not.
Returns
The result of operation.

Extends class MobileRTCMeetingService.

◆ pinVideo:withUser:()

- (BOOL) pinVideo: (BOOL)  on
withUser: (NSUInteger)  userId 

Set whether to pin user's video or not.

Parameters
onYES means to pin user's video, otherwise not.
userIdThe ID of user whose video will be pinned.
Returns
YES means that the method is called successfully, otherwise not.

Extends class MobileRTCMeetingService.

◆ spotlightVideo:withUser:()

- (BOOL) spotlightVideo: (BOOL)  on
withUser: (NSUInteger)  userId 

Set whether to spotlight user's video.

Parameters
onYES means to spotlight user's video; NO means that spotlight user's video will be canceled.
userIdThe ID of user whose video will be spotlighted in the meeting.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only meeting host can run the function, and user spotlighted should not be the host himself.

Extends class MobileRTCMeetingService.

◆ stopUserVideo:()

- (BOOL) stopUserVideo: (NSUInteger)  userID

Set to stop user's video.

Parameters
userIDThe ID of other users except the host in the meeting.
Returns
YES means that the method is called successfully, otherwise not.
Warning
Only host can run the function in the meeting.

Extends class MobileRTCMeetingService.

◆ switchMyCamera()

- (MobileRTCCameraError) switchMyCamera

Set to Switch the camera of the current user in local device.

Returns
The result of operation.

Extends class MobileRTCMeetingService.


The documentation for this category was generated from the following file: