Component API Objects
The objects implemented by the Diva Component API are:
DivaSystem:
The DivaSystem method
GetDevice
provides access to DivaDevice objects so that Diva hardware and software characteristics can be queried.
The DivaSystem method
CreateInstance
creates DivaInstance objects.
DivaInstance:
If you need to create more than one DivaCall object - so that you can handle multiple simultaneous
calls in one multi-threaded program - then you must create all the DivaCall objects using the
CreateCall
method of DivaInstance. The DivaCall objects will inherit the default properties set in the DivaInstance,
but can be overridden.
DivaCall:
Each DivaCall object represents a call and can be used to make an outgoing call or answer an incoming call.
DivaDevice:
DivaDevice allows you to interrogate the Diva hardware or software - each DivaDevice object
represents a Diva line device (or virtual device in the case of SoftIP) and is accessed through
the DivaSystem
GetDevice
method
DivaConference:
allows you to manage a conference with unlimited members.
The conference, including mixing and automatic gain control, is handled by the underlying
Diva communication platform. Members of the conference are of type
DivaCall.
The conference object is created by the
DivaInstance.CreateConference
method
See also: Component API Object Hierarchy diagram
Notes:
-
Simple single-call programs can create a DivaCall object directly - see the following examples -
and don't need to use DivaSystem or DivaInstance. If your program handles two or more simultaneous calls, then
it must use
DivaSystem and
DivaInstance and the
DivaCall
objects must be created using the
CreateCall method of DivaInstance.
-
To interrogate the hardware - to find out how many devices or lines are available, for instance -
use DivaSystem
and DivaDevice.