Intel® Collaboration Suite for WebRTC  version 4.3.1
Open WebRTC Toolkit (OWT) Client SDK for iOS*
OWTConferenceClient Class Reference

An asynchronous class for app to communicate with a conference in MCU. More...

#import <OWTConferenceClient.h>

Inheritance diagram for OWTConferenceClient:
Collaboration diagram for OWTConferenceClient:

Instance Methods

(instancetype) - initWithConfiguration:
 Initialize a OWTConferenceClient with configuration. More...
 
(void) - joinWithToken:onSuccess:onFailure:
 Connect to the specified room to join a conference. More...
 
(void) - publish:withOptions:onSuccess:onFailure:
 Publish the stream to the current room. More...
 
(void) - subscribe:withOptions:onSuccess:onFailure:
 Subscribe a stream from the current room. More...
 
(void) - send:onSuccess:onFailure:
 Send message to all participants in the conference. More...
 
(void) - send:to:onSuccess:onFailure:
 Send message to specific participant in the conference. More...
 
(void) - leaveWithOnSuccess:onFailure:
 Leave current conference.
 

Properties

id< OWTConferenceClientDelegatedelegate
 

Detailed Description

An asynchronous class for app to communicate with a conference in MCU.

Method Documentation

◆ initWithConfiguration:()

- (instancetype) initWithConfiguration: (OWTConferenceClientConfiguration *)  config

Initialize a OWTConferenceClient with configuration.

Parameters
configConfiguration for creating the OWTConferenceClient.

◆ joinWithToken:onSuccess:onFailure:()

- (void) joinWithToken: (NSString *)  token
onSuccess: (nullable void(^)(OWTConferenceInfo *))  onSuccess
onFailure: (nullable void(^)(NSError *))  onFailure 

Connect to the specified room to join a conference.

Parameters
tokenIncludes the room info which is encrypted.
onSuccessSuccess callback with the conference info.

◆ publish:withOptions:onSuccess:onFailure:()

- (void) publish: (OWTLocalStream *)  stream
withOptions: (nullable OWTPublishOptions *)  options
onSuccess: (nullable void(^)(OWTConferencePublication *))  onSuccess
onFailure: (nullable void(^)(NSError *))  onFailure 

Publish the stream to the current room.

Parameters
streamThe stream to be published.

◆ send:onSuccess:onFailure:()

- (void) send: (NSString *)  message
onSuccess: (nullable void(^)())  onSuccess
onFailure: (nullable void(^)(NSError *))  onFailure 

Send message to all participants in the conference.

Parameters
messageThe message to be sent.

◆ send:to:onSuccess:onFailure:()

- (void) send: (NSString *)  message
to: (NSString *)  receiver
onSuccess: (nullable void(^)())  onSuccess
onFailure: (nullable void(^)(NSError *))  onFailure 

Send message to specific participant in the conference.

Parameters
messageThe message to be sent.
toThe user who receives this message.

◆ subscribe:withOptions:onSuccess:onFailure:()

- (void) subscribe: (OWTRemoteStream *)  stream
withOptions: (nullable OWTConferenceSubscribeOptions *)  options
onSuccess: (nullable void(^)(OWTConferenceSubscription *))  onSuccess
onFailure: (nullable void(^)(NSError *))  onFailure 

Subscribe a stream from the current room.

Parameters
streamThe remote stream to be subscribed.
optionsOptions for subscribing the stream.
onSuccessSuccess callback with a stream that contains media stream.