function enables and disables control actions on the media stream associated
with the specified line, address, or call. Media control actions can be
triggered by the detection of specified digits, media modes, custom tones, and call
| HLINE hLine,
| DWORD dwAddressID,
| HCALL hCall,
| DWORD dwSelect,
| LPLINEMEDIACONTROLDIGIT const lpDigitList,
| DWORD dwDigitNumEntries,
| LPLINEMEDIACONTROLMEDIA const lpMediaList,
| DWORD dwMediaNumEntries,
| LPLINEMEDIACONTROLTONE const lpToneList,
| DWORD dwToneNumEntries,
| LPLINEMEDIACONTROLCALLSTATE const lpCallStateList,
| DWORD dwCallStateNumEntries
SAa handle to an open line device.
An address on the given open line device.
A handle to a call. The application must be an owner of the call. The call
state of hCall
can be any state.
Specifies whether the media control requested is associated with a single
call, is the default for all calls on an address, or is the default for all calls
on a line. This parameter can only have a single flag set, and it uses the
following LINECALLSELECT_ constants:
Selects the specified line device. The hLine
parameter must be a valid line handle; hCall
Selects the specified address on the line. Both hLine
must be valid; hCall
Selects the specified call. hCall
must be valid; hLine
are both ignored.
A pointer to the array that contains the digits that are to trigger media
control actions, of type LINEMEDIACONTROLDIGIT
. Each time a digit in the digit list is detected, the specified media control
action is carried out on the call's media stream.
Valid digits for pulse mode are '0' through '9'. Valid digits for DTMF mode
are '0' through '9', 'A', 'B', 'C', 'D', '*', '#'.
The number of entries in the lpDigitList
A pointer to an array with entries of type LINEMEDIACONTROLMEDIA
. The array has dwMediaNumEntries
entries. Each entry contains a media mode to be monitored, media-type
specific information (such as duration), and a media control field. If a media mode in
the list is detected, the corresponding media control action is performed on
the call's media stream.
The number of entries in lpMediaList
A pointer to an array with entries of type LINEMEDIACONTROLTONE
. The array has dwToneNumEntries
entries. Each entry contains a description of a tone to be monitored,
duration of the tone, and a media-control field. If a tone in the list is detected,
the corresponding media control action is performed on the call's media stream.
The number of entries in lpToneList
A pointer to an array with entries are of type LINEMEDIACONTROLCALLSTATE
. The array has dwCallStateNumEntries
entries. Each entry contains a call state and a media control action.
Whenever the given call transitions into one of the call states in the list, the
corresponding media control action is invoked.
The number of entries in lpCallStateList
Returns zero if the request is successful or a negative error number if an
error has occurred. Possible return values are:
LINEERR_INVALADDRESSID, LINEERR_NOMEM, LINEERR_INVALCALLHANDLE,
LINEERR_NOTOWNER, LINEERR_INVALCALLSELECT, LINEERR_OPERATIONUNAVAIL,
LINEERR_INVALCALLSTATELIST, LINEERR_OPERATIONFAILED, LINEERR_INVALDIGITLIST, LINEERR_RESOURCEUNAVAIL,
LINEERR_INVALLINEHANDLE, LINEERR_UNINITIALIZED, LINEERR_INVALMEDIALIST,
function is considered successful if media control has been correctly
initiated, not when any media control has taken effect. Media control in progress is
changed or is canceled by calling this function again with either different
parameters or NULLs. If one or more of the parameters lpDigitList
are NULL, then the corresponding digit, media mode, tone, or call
state-triggered media control is disabled. To modify just a portion of the media control
parameters while leaving the remaining settings in effect, the application
should invoke lineSetMediaControl
supplying the previous parameters for those portions that must remain in
effect, and new parameters for those parts that are to be modified.
is selected and the call terminates or the application deallocates its
handle, media control on that call is canceled.
All applications that are owners of the call are in principle allowed to make
media control requests on the call. Only a single media control request can be
outstanding on a call across all applications that own the call. Each time lineSetMediaControl
is called, the new request overrides any media control then in effect on the
call, whether set by the calling application or any other owning application.
Depending on the service provider and other activities that compete for such
resources, the amount of simultaneous detections that can be made may vary over
time. If service provider resources are overcommitted, the
LINEERR_RESOURCEUNAVAIL error is returned.
Whether or not media control is supported by the service provider is a device
- Software for developers
Software for Android Developers
- More information resources
Unix Manual Pages