swiConfigLocalStream

Configures the stream-specific characteristics of a local device.

Prototype

DWORD swiConfigLocalStream ( SWIHD swihd, SWI_LOCALSTREAM_ARGS *args, void *buffer, unsigned size)

Argument

Description

swihd

Switch handle.

args

Pointer to a SWI_LOCALSTREAM_ARGS structure for configuring a device associated with a local stream:

typedef struct
{
  DWORD localstream;     
  DWORD deviceid;
  DWORD parameterid;
} SWI_LOCALSTREAM_ARGS;

Refer to 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

Return value

Description

SUCCESS

 

CTAERR_DRIVER_ERROR

Underlying driver retrieved an unrecognized error. Call swiGetLastError to retrieve the MVIP device error code.

CTAERR_FUNCTION_NOT_AVAIL

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.

CTAERR_SVR_COMM

Communication error in the server environment.


Details

swiConfigLocalStream 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.

CG boards do not support swiConfigLocalStream.

The SWI_LOCALSTREAM_ARGS structure contains the following fields:

Field

Description

localstream

Stream to be configured on the local bus.

deviceid

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 can define device identifiers specific to their products. Refer to the device-specific documentation for these values.

parameterid

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 Configuring boards and drivers. 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, swiGetLocalStreamInfo, swiGetLocalTimeslotInfo, swiOpenSwitch