Prosody RTP processing: API: sm_vidmptx_stop

This function is deprecated.

Prototype Definition

int sm_vidmptx_stop(struct sm_vidmptx_stop_parms *stopp)

Parameters

*stopp

a structure of the following type:

typedef struct sm_vidmptx_stop_parms {
	tSMVidMPtxId vidmptx;					/* in */
} SM_VIDMPTX_STOP_PARMS;

Description

Requests that a VidMP[tx] stops executing. The user will be notified that a VidMP[tx] has terminated by a final status, kSMVidMPtxStatusStopped, from sm_vidmptx_status(). Once the stopped status notification has been received the VidMP[tx] can be destroyed using sm_vidmptx_destroy().

Once the VidMP[tx] has stopped the event should no longer be used to wait for status notifications as it will be signalled permanently. The event is invalidated when sm_vidmptx_destroy() is called.

Fields

vidmptx (Deprecated)

A tSMVidMPtxId that has been previously created by a call to sm_vidmptx_create().

Returns

0 if call completed successfully, otherwise a standard error such as:

• ERR_SM_DEVERR - device error

This function is part of the Prosody RTP processing API.