Table of Contents Index NMS Glossary Previous Page Next Page Version


Chapter 3

Function Summary


3.1 Introduction
3.2 Endpoint Operations
3.3 Channel Operations
3.4 Connect Operations
3.5 Enable and Disable MSPP Components
3.6 Processing MSPP Events
3.7 Endpoint and Channel Filter Commands
3.8 Endpoint and Channel Filter Queries

3.1 IntroductionTop of Page

This chapter describes the MSPP API and groups the MSPP service functions according to the tasks a typical telephony application may perform. Such tasks include:

3.2 Endpoint OperationsTop of Page

MSPP endpoints provide a point of origin for streaming media. For example, a 64Kbps PCM transport would be associated with a DS0 Endpoint. This first endpoint can be connected to a MSPP channel which, in turn, can be connected to a second RTP endpoint.
Function

S / A*

Description

mspCreateEndpoint

A

Creates an endpoint. The type of endpoint is specified in the ADDR structure.

mspDestroyEndpoint

A

Destroys an endpoint.

*Synchronous or Asynchronous

3.3 Channel OperationsTop of Page

MSPP channels provide a way to transform streaming media that flows between two endpoints. Channels are made up of a concatinated set of filters. Filters are parameter-driven functions that perform a series of specific actions on the media flow. This set of filters is referenced by an alphanumeric channel name.
Function

S / A*

Description

mspCreateChannel

A

Creates a media channel. The type of channel is specified in the ADDR structure via an alphanumeric value.

mspDestroyChannel

A

Destroys a channel.

*Synchronous or Asynchronous

3.4 Connect OperationsTop of Page

MSPP connections combine channels and endpoints to form simplex and full duplex data paths. A complete connection requires two endpoints, both of which must be connected to a channel.
Function

S / A*

Description

mspConnect

A

Connects a media channel to two endpoints.

mspDisconnect

A

Disconnects a media channel from two endpoints.

*Synchronous or Asynchronous

3.5 Enable and Disable MSPP ComponentsTop of Page

Both endpoints and channels can be enabled or disabled. Endpoints, however, are enabled by default at the time of creation. Channels are disabled by default.
Function

S / A*

Description

mspEnableEndpoint

A

Enables a specified endpoint (causing the underlying filter function to be started).

mspDisableEndpoint

A

Disables a specified endpoint (causing the underlying filter function to be stopped).

mspEnableChannel

A

Enables a specified channel (causing the underlying filter functions to be started).

mspDisableChannel

A

Disables a specified channel (causing the underlying filter functions to be stopped).

*Synchronous or Asynchronous

3.6 Processing MSPP EventsTop of Page

The mspReleaseBuffer function frees returned event buffers so that the application can reuse them. This function executes synchronously. Returned buffers are sent as a result of a call to mspSendQuery or mspSendCommand.

3.7 Endpoint and Channel Filter CommandsTop of Page

Once endpoints are created, the endpoint-specific parameters used at the time of creation now become attributes. These attributes are instance-specific, and can be modified (with the exception of IP addresses) at the time of creation with mspSendCommand. Different filters can be commanded in different states. For information on individual filters and their properties, see the Fusion MSPP Service Filter Reference Manual. When finished with the information, the application must free the buffer by calling mspReleaseBuffer and specifying the buffer address.
Function

S / A*

Description

mspSendCommand

A

Sends a command to a channel.

*Synchronous or Asynchronous

3.8 Endpoint and Channel Filter Queries Top of Page

The mspSendQuery function solicits configuration and operation data from MSPP filters. MSPP queries to MSP objects return filter status information in a buffer that must be released by mspReleaseBuffer.
Function

S / A*

Description

mspSendQuery

A

Provides information about an MSPP filter's configuration and/or operation.

*Synchronous or Asynchronous



Table of Contents Index NMS Glossary Previous Page Next Page Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.