LINEMEDIACONTROLCALLSTATE
The LINEMEDIACONTROLCALLSTATE structure describes a media action to be executed when detecting transitions into one or more call states.
typedef struct linemediacontrolcallstate_tag {
DWORD dwCallStates;
DWORD dwMediaControl;
} LINEMEDIACONTROLCALLSTATE, FAR *LPLINEMEDIACONTROLCALLSTATE;
Members
-
dwCallStates
-
Specifies one or more call states. This member uses the following LINECALLSTATE_ constants:
-
LINECALLSTATE_IDLE
-
The call is idle—no call exists.
-
LINECALLSTATE_OFFERING
-
The call is being offered to the station, signaling the arrival of a new call. In some environments, a call in the offering state does not automatically alert the user. Alerting is done by the switch instructing the line to ring, and it does not affect any call states.
-
LINECALLSTATE_ACCEPTED
-
The call was offering and has been accepted. This indicates to other (monitoring) applications that the current owner application has claimed responsibility for answering the call. In ISDN, this also initiates alerting to both parties.
-
LINECALLSTATE_DIALTONE
-
The call is receiving a dial tone from the switch, which means that the switch is ready to receive a dialed number.
-
LINECALLSTATE_DIALING
-
Destination address information (a phone number) is being sent to the switch over the call. The function lineGenerateDigits does not place the line into the dialing state.
-
LINECALLSTATE_RINGBACK
-
The call is receiving ringback from the called address. Ringback indicates that the other station has been reached and is being alerted.
-
LINECALLSTATE_BUSY
-
The call is receiving a busy tone. Busy tone indicates that the call cannot be completed because either a circuit (trunk) or the remote party's station are in use.
-
LINECALLSTATE_SPECIALINFO
-
Special information is sent by the network. Special information is typically sent when the destination cannot be reached.
-
LINECALLSTATE_CONNECTED
-
The call has been established, and the connection is made. Information is able to flow over the call between the originating address and the destination address.
-
LINECALLSTATE_PROCEEDING
-
Dialing has completed and the call is proceeding through the switch or telephone network.
-
LINECALLSTATE_ONHOLD
-
The call is on hold by the switch.
-
LINECALLSTATE_CONFERENCED
-
The call is currently a member of a multiparty conference call.
-
LINECALLSTATE_ONHOLDPENDCONF
-
The call is currently on hold while it is being added to a conference.
-
LINECALLSTATE_ONHOLDPENDTRANSF
-
The call is currently on hold awaiting transfer to another number.
-
LINECALLSTATE_DISCONNECTED
-
The remote party has disconnected from the call.
-
LINECALLSTATE_UNKNOWN
-
The state of the call is not known. This may be due to limitations of the call-progress detection implementation.
-
dwMediaControl
-
The media control action. This member uses the following LINEMEDIACONTROL_ constants:
-
LINEMEDIACONTROL_NONE
-
No change is to be made to the media stream.
-
LINEMEDIACONTROL_RESET
-
Reset the media stream. Equivalent to an end-of-input. All buffers are released.
-
LINEMEDIACONTROL_PAUSE
-
Temporarily pause the media stream.
-
LINEMEDIACONTROL_RESUME
-
Start or resume a paused media stream.
-
LINEMEDIACONTROL_RATEUP
-
The speed of the media stream is increased by some stream-defined quantity.
-
LINEMEDIACONTROL_RATEDOWN
-
The speed of the media stream is decreased by some stream-defined quantity.
-
LINEMEDIACONTROL_RATENORMAL
-
The speed of the media stream is returned to normal.
-
LINEMEDIACONTROL_VOLUMEUP
-
The amplitude of the media stream is increased by some stream-defined quantity.
-
LINEMEDIACONTROL_VOLUMEDOWN
-
The amplitude of the media stream is decreased by some stream-defined quantity.
-
LINEMEDIACONTROL_VOLUMENORMAL
-
The amplitude of the media stream is returned to normal.
Remarks
No extensions.
The LINEMEDIACONTROLCALLSTATE structure defines a triple <call state(s), media-control action>. An array of these triples is passed to the lineSetMediaControl function to set the media control actions triggered by the transition to the call state of the given call. When a transition to a listed call state is detected, the corresponding action on the media stream is invoked.
QuickInfo
Version: Use TAPI version 1.4 and later.
Header: Declared in tapi.h.
See Also
lineGenerateDigits, lineSetMediaControl