hp.opencall.media.ccapi
Class ConferenceSpec

java.lang.Object
  hp.opencall.media.ccapi.ConferenceSpec

public class ConferenceSpec

extends Object

A descriptor class to specify conference objects.

Constructor Summary

ConferenceSpec(int aId, int aCapacity)
Creates a ConferenceSpec with an User ID and a capacity.

Method Summary

boolean	equals(Object obj)
int	getCapacity() /** Returns the capacity of the ConferenceSpec.
int	getId() Returns the id of the ConferenceSpec
int	getNLoudest() Returns the N Loudest parameter of the ConferenceSpec
int	hashCode()
void	setNLoudest(int nLoudest) Set the number of conferencers that will be retained as the louders speakers.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConferenceSpec

public ConferenceSpec(int aId,
                      int aCapacity)

Creates a ConferenceSpec with an User ID and a capacity.

The ID defines a unique conference.

The capacity is the number of AsyncMediaGroup, and possible ConfAsyncMediaGroup, supposed to be joined, or looped, to the conference.

Actually, this is an initial capacity : the sum of all join() is simply limited by the maximum number of Media Groups on the OC MP, on a per processor basis.

However, before any join() is requested, a preliminary check consists in ensuring there is a processor that will be able to hold the requested capacity, provided this is the only conference on this processor. Thus, on a 3 data processors OC MP (having a total of 4 CPUs) set up for 2016 CICs, you can make a reservation of 672 x 3 = 2016 conferences of maximal capacities 672 (over 1 million).

When the time comes to join(), of course, there will be no more than 672 attendees at the same time !

Since:

OCMP 2.2

Method Detail

getId

public int getId()

Returns the id of the ConferenceSpec

Since:

OCMP 2.2

setNLoudest

public void setNLoudest(int nLoudest)

Set the number of conferencers that will be retained as the louders speakers.

If the value is 0, all conferencers voices are summed by the conference. If the value is positive, only the N Loudest speakers'voice are summed. This service is based on an internal VAD mechanism and increase the CPU usage. The nLoudest value can be modified each time a new conferencer enter in the conference.

Valid values: any positive Integer.
Default value = 0.

Since:

OCMP 2.4.C2

getNLoudest

public int getNLoudest()

Returns the N Loudest parameter of the ConferenceSpec

Since:

OCMP 2.4.C2

getCapacity

public int getCapacity()

/** Returns the capacity of the ConferenceSpec.

Since:

OCMP 2.2

hashCode

public int hashCode()

equals

public boolean equals(Object obj)

toString

public String toString()