Conference controlling helper.
More...
#include <ConferenceProvider.h>
|
ZDK::IConferenceProvider * | cppRef = nullptr |
|
Conference controlling helper.
◆ AddConferenceProviderListener()
◆ ConferenceContainingCall()
Gets the conference in which the provided call is part of.
Returns the conference in which the given call is part of, if it is part of any, otherwise a null pointer is returned.
- Parameters
-
[in] | call | The call to be searched for |
- Returns
- The call's conference if exists or null pointer otherwise
- See also
- IsCallInConference()
◆ CreateConference()
Creates a new conferene with the provided calls.
ConferenceProviderEventsHandler's OnConferenceAdded() is invoked on successful creation of the conference. ConferenceEventsHandler's OnConferenceParticipantJoined() is invoked for each added call to the conferene.
Creating an empty conference (with empty calls list) is not supported!
To remove a conference simply remove all its calls/participants. It is not allowed to have an empty conference, and that is why such are automatically destroyed! OnConferenceRemoved() is invoked in this case.
- Parameters
-
[in] | calls | List of the calls to be added in the conference |
- Returns
- The newly created conference
- See also
- Conference, ConferenceEventsHandler, ConferenceProviderEventsHandler
◆ DropConferenceProviderListener()
◆ GetConference()
Gets the conference with the specified ID.
Returns the conference with the specified ID if exist, otherwise a null pointer is returned.
- Parameters
-
[in] | hConf | The ID of the requested conference |
- Returns
- The requested conference if exists or null pointer otherwise
◆ IsCallInConference()
bool ZDK_NET::ConferenceProvider::IsCallInConference |
( |
long long |
hCall | ) |
|
Checks whether the call with the provided ID is part of any conference.
Returns whether a call with the provided ID exists and is part of any active conference.
- Parameters
-
[in] | hCall | The ID of the call to be searched for |
- Returns
- 0 - The call is not in conference, or does not exists at all
- 1 - The call is in conference
- See also
- ConferenceContainingCall()
◆ BrandingInfo
ZDK_NET:: BrandingInfo^ ZDK_NET::ConferenceProvider::BrandingInfo |
|
get |
Gets the conference branding info.
- Returns
- The conference branding info
- See also
- BrandingInfo
◆ CallsInConferences
int ZDK_NET::ConferenceProvider::CallsInConferences |
|
get |
Gets the total count of calls in all conferences.
- Returns
- The number of all calls in conferences
◆ ConferencesCount
int ZDK_NET::ConferenceProvider::ConferencesCount |
|
get |
Gets the count of all conferences.
- Returns
- The number of all conferences
◆ ListConferences
List< Conference^>^ ZDK_NET::ConferenceProvider::ListConferences |
|
get |
Gets a list with all conferences.
- Returns
- List with all conferences
- See also
- Conference
The documentation for this class was generated from the following file: