(Page 5 of 29 in this chapter)
Version
swiConfigLocalStream
Description
Configures stream-specific characteristics of a local device.
Prototype
DWORD
swiConfigLocalStream
(
SWIHD
swihd
,
SWI_LOCALSTREAM_ARGS
*args
,
void *
buffer
,
unsigned
size
)
swihd
Handle returned by
swiOpenSwitch
.
args
Pointer to a
SWI_LOCALSTREAM_ARGS
structure for configuring a device associated with a local stream. The
SWI_LOCALSTREAM_ARGS
structure is:
typedef struct
{
DWORD localstream;
DWORD deviceid;
DWORD parameterid;
} SWI_LOCALSTREAM_ARGS;
See the
Details
section for a description of these fields.
buffer
Pointer to stream-specific information interpreted by the device driver.
size
Size of
buffer
, in bytes.
Return Values
SUCCESS
CTAERR_DRIVER_ERROR
The underlying driver retrieved an unrecognized error. Call
swiGetLastError
to retrieve the MVIP device error code.
CTAERR_FUNCTION_NOT_AVAIL
The underlying driver does not support the configuration of stream-specific characteristics of a local device.
CTAERR_INVALID_HANDLE
swihd
is not a valid switch handle.
SWIERR_INVALID_PARAMETER
Either the parameters passed in
buffer
are invalid for the
deviceid
or the
parameterid
, or the
deviceid/parameterid
combination is not supported, or configuration of the specific local stream is not supported.
Events
None.
Details
This function configures stream-specific characteristics of a local device. The content of the buffer portion of the call contains the configuration information and is vendor-dependent and device-dependent.
The
SWI_LOCALSTREAM_ARGS
structure contains the following fields:
Field
Description
localstream
The stream to be configured on the local bus.
deviceid
The device type on the local stream. The
deviceid
is
hardware-dependent. Acceptable values for
deviceid
are:
MVIP95_T1_TRUNK_DEVICE
MVIP95_E1_TRUNK_DEVICE
MVIP95_ANALOG_LINE_DEVICE
MVIP95_CONFERENCE_DEVICE
In addition to these values, the device vendor may define device identifiers specific to their products. Refer to the device-specific documentation for these values.
parameterid
The data item for which configuration is to be performed. This value is vendor-specific and device driver-specific. The combination of the
deviceid
and the
parameterid
specify the part of the device to configure.
For more information, refer to
Section 6.3, Board and Driver Configuration
. Refer to the installation and developer's manual for the board you are using for board-specific information.
If
CTAERR_DRIVER_ERROR
is returned, call
swiGetLastError
to retrieve the MVIP device error code.
See Also
swiConfigLocalTimeslot
,
swiGetBoardInfo
,
swiGetDriverInfo
,
swiGetLastError
,
swiGetLocalStreamInfo
,
swiGetLocalTimeslotInfo
,
swiOpenSwitch
(Page 5 of 29 in this chapter)
Version
Want to send us feedback on our documentation? Email:
Tech_Pubs@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.