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

Provide interfaces for outgoing calls and Call Room Device. More...

#import <MobileRTCMeetingService+Customize.h>

Instance Methods

(void) - customizeMeetingTitle:
 Set to customize the meeting title which will be displayed in the meeting bar. More...
 
(BOOL) - setMeetingTopic:
 Set to customize the meeting topic which will be displayed in the meeting info view. More...
 
(BOOL) - isDialOutSupported
 Query if user can dial out in the meeting. More...
 
(BOOL) - isDialOutInProgress
 Query if there is any outgoing call in process. More...
 
(BOOL) - dialOut:isCallMe:withName:
 Start to dial out. More...
 
(BOOL) - cancelDialOut:
 Cancel to dial out. More...
 
(BOOL) - isCallRoomDeviceSupported
 Query if it is able to Call Room device(H.323). More...
 
(BOOL) - isCallingRoomDevice
 Query if it is in process to call room device. More...
 
(BOOL) - cancelCallRoomDevice
 Cancel to call room device. More...
 
(nullable NSArray *) - getIPAddressList
 Get an array of IP Addresses of room device which is used for calling. More...
 
(nullable NSString *) - getH323MeetingPassword
 Get the password of the meeting running on H.323 device. More...
 
(nullable NSArray *) - getRoomDeviceList
 Get room devices that can be called. More...
 
(BOOL) - sendPairingCode:WithMeetingNumber:
 Get the pairing code when the room device call in. More...
 
(BOOL) - callRoomDevice:
 The user calls out to invite the room device. More...
 
(NSUInteger) - getParticipantID
 Get Participant ID. More...
 
(nullable MobileRTCCallCountryCode *) - getDialInCurrentCountryCode
 Get countrycode for the current user's locale. More...
 
(nullable NSArray *) - getDialInAllCountryCodes
 Get all countrycodes. More...
 
(nullable NSArray *) - getDialInCallCodesWithCountryId:
 Get to the countrycode specified by countryId. More...
 
(BOOL) - dialInCall:
 Make a phone call to access your voice. More...
 

Detailed Description

Provide interfaces for outgoing calls and Call Room Device.

Method Documentation

◆ callRoomDevice:()

- (BOOL) callRoomDevice: (nonnull MobileRTCRoomDevice *)  device

The user calls out to invite the room device.

Parameters
deviceThe room device.
Returns
YES means the method is called successfully, otherwise not.

Extends class MobileRTCMeetingService.

◆ cancelCallRoomDevice()

- (BOOL) cancelCallRoomDevice

Cancel to call room device.

Returns
YES means the method is called successfully, otherwise not.

Extends class MobileRTCMeetingService.

◆ cancelDialOut:()

- (BOOL) cancelDialOut: (BOOL)  isCallMe

Cancel to dial out.

Parameters
isCallMeYES means Call Me; NO means inviting others by Phone.
Returns
YES means the method is called successfully, otherwise not.

Extends class MobileRTCMeetingService.

◆ customizeMeetingTitle:()

- (void) customizeMeetingTitle: (NSString *_Nullable)  title

Set to customize the meeting title which will be displayed in the meeting bar.

Parameters
titleThe topic/title of the meeting.
Warning
User should call the method before starting or joining the meeting if he wants to reset the title/topic of the meeting.

Extends class MobileRTCMeetingService.

◆ dialInCall:()

- (BOOL) dialInCall: (nullable NSString *)  countryNumber

Make a phone call to access your voice.

Returns
YES means the method is called successfully, otherwise not.

Extends class MobileRTCMeetingService.

◆ dialOut:isCallMe:withName:()

- (BOOL) dialOut: (nonnull NSString *)  phone
isCallMe: (BOOL)  me
withName: (nullable NSString *)  username 

Start to dial out.

Parameters
phoneThe phone number of destination, you should add the country code in front of the phone number, such as +86123456789.
meYES means Call Me; NO means inviting others by Phone.
usernameThe name of the user to be called.
Returns
YES means the method is called successfully, otherwise not.

Extends class MobileRTCMeetingService.

◆ getDialInAllCountryCodes()

- (nullable NSArray *) getDialInAllCountryCodes

Get all countrycodes.

Returns
The array of all countrycode.

Extends class MobileRTCMeetingService.

◆ getDialInCallCodesWithCountryId:()

- (nullable NSArray *) getDialInCallCodesWithCountryId: (nullable NSString *)  countryId

Get to the countrycode specified by countryId.

Returns
The array of countrycode.

Extends class MobileRTCMeetingService.

◆ getDialInCurrentCountryCode()

- (nullable MobileRTCCallCountryCode *) getDialInCurrentCountryCode

Get countrycode for the current user's locale.

Returns
The object of MobileRTCCallCountryCode for user's locale.

Extends class MobileRTCMeetingService.

◆ getH323MeetingPassword()

- (nullable NSString*) getH323MeetingPassword

Get the password of the meeting running on H.323 device.

Returns
The meeting password. If no meeting is running, it will return nil.

Extends class MobileRTCMeetingService.

◆ getIPAddressList()

- (nullable NSArray*) getIPAddressList

Get an array of IP Addresses of room device which is used for calling.

Returns
The array of IP Address; if there is no existed IP Address, it will return nil.

Extends class MobileRTCMeetingService.

◆ getParticipantID()

- (NSUInteger) getParticipantID

Get Participant ID.

Returns
The Participant ID.

Extends class MobileRTCMeetingService.

◆ getRoomDeviceList()

- (nullable NSArray*) getRoomDeviceList

Get room devices that can be called.

Returns
The array of room devices. If there is no any room device. it will return nil.

Extends class MobileRTCMeetingService.

◆ isCallingRoomDevice()

- (BOOL) isCallingRoomDevice

Query if it is in process to call room device.

Returns
YES means calling room device in process, otherwise not.

Extends class MobileRTCMeetingService.

◆ isCallRoomDeviceSupported()

- (BOOL) isCallRoomDeviceSupported

Query if it is able to Call Room device(H.323).

Returns
YES means able, otherwise not.

Extends class MobileRTCMeetingService.

◆ isDialOutInProgress()

- (BOOL) isDialOutInProgress

Query if there is any outgoing call in process.

Returns
YES means that there is outgoing call in process.

Extends class MobileRTCMeetingService.

◆ isDialOutSupported()

- (BOOL) isDialOutSupported

Query if user can dial out in the meeting.

Returns
YES means able, No disable.

Extends class MobileRTCMeetingService.

◆ sendPairingCode:WithMeetingNumber:()

- (BOOL) sendPairingCode: (nonnull NSString *)  code
WithMeetingNumber: (unsigned long long)  meetingNumber 

Get the pairing code when the room device call in.

Parameters
codeThe pairing code which enable the device connect to the meeting.
meetingNumberThe number of meeting.
Returns
YES means the method is called successfully, otherwise not.
Warning
App can invite Room System while App is in Meeting or in pre-Meeting.

Extends class MobileRTCMeetingService.

◆ setMeetingTopic:()

- (BOOL) setMeetingTopic: (NSString *_Nonnull)  meetingTopic

Set to customize the meeting topic which will be displayed in the meeting info view.

Parameters
topicThe topic of the meeting.
Warning
only meeting original host can call the function.
only in-meeting can call the function.

Extends class MobileRTCMeetingService.


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