Prosody RTP processing: API: sm_vidmptx_destroy

This function is deprecated.

Prototype Definition

int sm_vidmptx_destroy(tSMVidMPtxId vidmptx)

Parameters

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

Description

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

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

Returns

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


This function is part of the Prosody RTP processing API.