Prosody RTP processing: API: sm_vidmprx_destroy

This function is deprecated.

Prototype Definition

int sm_vidmprx_destroy(tSMVidMPrxId vidmprx)

Parameters

vidmprx

A tSMVidMPrxId that has been prevously created by a call to sm_vidmprx_create().

Description

Destroys vidmprx and invalidates the tSMVidMPrxId. Normally, a VidMP[rx] will only be destroyed when it is in the stopped state. If the VidMP[rx] is not in the stopped state, it will be implicitly stopped. It is an error to refer to a VidMP[rx] once it has been destroyed.

If a call to sm_vidmprx_create() completes successfully, sm_vidmprx_stop() should be used to stop to the VidMP[rx] and move it into the stopped state.

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.