Intel® Collaboration Suite for WebRTC  version 4.3.1
Open WebRTC Toolkit (OWT) Client SDK for Windows*
owt::conference::ConferenceClient Class Referencefinal

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

#include <owt/conference/conferenceclient.h>

Inheritance diagram for owt::conference::ConferenceClient:
Collaboration diagram for owt::conference::ConferenceClient:

Public Member Functions

void AddObserver (ConferenceClientObserver &observer)
 Add an observer for conferenc client.
 
void RemoveObserver (ConferenceClientObserver &observer)
 Remove an object from conference client.
 
void Join (const std::string &token, std::function< void(std::shared_ptr< ConferenceInfo >)> on_success, std::function< void(std::unique_ptr< Exception >)> on_failure)
 Connect to the specified room to join a conference. More...
 
void Leave (std::function< void()> on_success, std::function< void(std::unique_ptr< Exception >)> on_failure)
 Leave current conference.
 
void Publish (std::shared_ptr< LocalStream > stream, std::function< void(std::shared_ptr< ConferencePublication >)> on_success, std::function< void(std::unique_ptr< Exception >)> on_failure)
 Publish the stream to the current room. More...
 
void Publish (std::shared_ptr< LocalStream > stream, const PublishOptions &options, std::function< void(std::shared_ptr< ConferencePublication >)> on_success, std::function< void(std::unique_ptr< Exception >)> on_failure)
 Publish the stream to the current room. More...
 
void Subscribe (std::shared_ptr< RemoteStream > stream, std::function< void(std::shared_ptr< ConferenceSubscription >)> on_success, std::function< void(std::unique_ptr< Exception >)> on_failure)
 Subscribe a stream from the current room. More...
 
void Subscribe (std::shared_ptr< RemoteStream > stream, const SubscribeOptions &options, std::function< void(std::shared_ptr< ConferenceSubscription >)> on_success, std::function< void(std::unique_ptr< Exception >)> on_failure)
 Subscribe a stream from the current room. More...
 
void Send (const std::string &message, std::function< void()> on_success, std::function< void(std::unique_ptr< Exception >)> on_failure)
 Send messsage to all participants in the conference. More...
 
void Send (const std::string &message, const std::string &receiver, std::function< void()> on_success, std::function< void(std::unique_ptr< Exception >)> on_failure)
 Send messsage to all participants in the conference. More...
 

Static Public Member Functions

static std::shared_ptr< ConferenceClientCreate (const ConferenceClientConfiguration &configuration)
 Create a ConferenceClient instance with specific configuration. More...
 

Detailed Description

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

Member Function Documentation

◆ Create()

static std::shared_ptr<ConferenceClient> owt::conference::ConferenceClient::Create ( const ConferenceClientConfiguration configuration)
static

Create a ConferenceClient instance with specific configuration.

Parameters
configurationConfiguration for creating the ConferenceClient.

◆ Join()

void owt::conference::ConferenceClient::Join ( const std::string &  token,
std::function< void(std::shared_ptr< ConferenceInfo >)>  on_success,
std::function< void(std::unique_ptr< Exception >)>  on_failure 
)

Connect to the specified room to join a conference.

Parameters
tokenIncludes the room info which is encrypted.
on_successJoin conference success, on_sucess will be executed with current conference information.

◆ Publish() [1/2]

void owt::conference::ConferenceClient::Publish ( std::shared_ptr< LocalStream stream,
std::function< void(std::shared_ptr< ConferencePublication >)>  on_success,
std::function< void(std::unique_ptr< Exception >)>  on_failure 
)

Publish the stream to the current room.

Parameters
streamThe stream to be published.

◆ Publish() [2/2]

void owt::conference::ConferenceClient::Publish ( std::shared_ptr< LocalStream stream,
const PublishOptions options,
std::function< void(std::shared_ptr< ConferencePublication >)>  on_success,
std::function< void(std::unique_ptr< Exception >)>  on_failure 
)

Publish the stream to the current room.

Parameters
streamThe stream to be published.
optionsOptions for publishing the stream.

◆ Send() [1/2]

void owt::conference::ConferenceClient::Send ( const std::string &  message,
std::function< void()>  on_success,
std::function< void(std::unique_ptr< Exception >)>  on_failure 
)

Send messsage to all participants in the conference.

Parameters
messageThe message to be sent.

◆ Send() [2/2]

void owt::conference::ConferenceClient::Send ( const std::string &  message,
const std::string &  receiver,
std::function< void()>  on_success,
std::function< void(std::unique_ptr< Exception >)>  on_failure 
)

Send messsage to all participants in the conference.

Parameters
messageThe message to be sent.
receiverReceiver's user ID.

◆ Subscribe() [1/2]

void owt::conference::ConferenceClient::Subscribe ( std::shared_ptr< RemoteStream stream,
std::function< void(std::shared_ptr< ConferenceSubscription >)>  on_success,
std::function< void(std::unique_ptr< Exception >)>  on_failure 
)

Subscribe a stream from the current room.

Parameters
streamThe remote stream to be subscribed.
onSuccessSuccess callback with a stream that contains media stream.

◆ Subscribe() [2/2]

void owt::conference::ConferenceClient::Subscribe ( std::shared_ptr< RemoteStream stream,
const SubscribeOptions options,
std::function< void(std::shared_ptr< ConferenceSubscription >)>  on_success,
std::function< void(std::unique_ptr< Exception >)>  on_failure 
)

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.