Audio and video functions

Functions
Int32	PortSIP.PortSIPLib.addSupportedMimeType (String methodName, String mimeType, String subMimeType)
	Set the SDK to receive the SIP messages that include special mime type. More...
Int32	PortSIP.PortSIPLib.setAudioSamples (Int32 ptime, Int32 maxPtime)
	Set the audio capture sample. More...

Detailed Description

Function Documentation

addSupportedMimeType()

Int32 PortSIP.PortSIPLib.addSupportedMimeType	(	String	methodName,
		String	mimeType,
		String	subMimeType
	)

Set the SDK to receive the SIP messages that include special mime type.

Parameters

methodName	Method name of the SIP message, such as INVITE, OPTION, INFO, MESSAGE, UPDATE, ACK etc. For more details please read the RFC3261.
mimeType	The mime type of SIP message.
subMimeType	The sub mime type of SIP message.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

Remarks

By default, PortSIP VoIP SDK supports these media types (mime types) below for incoming SIP messages:

"message/sipfrag" in NOTIFY message.
"application/simple-message-summary" in NOTIFY message.
"text/plain" in MESSAGE message.
"application/dtmf-relay" in INFO message.
"application/media_control+xml" in INFO message.

The SDK allows to receive SIP messages that include above mime types. Now if remote side send an INFO SIP message with its "Content-Type" header value "text/plain". SDK will reject this INFO message, as "text/plain" of INFO message is not included in the default support list. How should we enable the SDK to receive the SIP INFO message that includes "text/plain" mime type? The answer is addSupportedMimyType:

addSupportedMimeType("INFO", "text", "plain");

If we want to receive the NOTIFY message with "application/media_control+xml", please:

addSupportedMimeType("NOTIFY", "application", "media_control+xml");

For more details about the mime type, please visit this website: http://www.iana.org/assignments/media-types/

setAudioSamples()

Int32 PortSIP.PortSIPLib.setAudioSamples	(	Int32	ptime,
		Int32	maxPtime
	)

Set the audio capture sample.

Parameters

ptime	It should be a multiple of 10 between 10 - 60 (with 10 and 60 inclusive).
maxPtime	For the "maxptime" attribute, it should be a multiple of 10 between 10 - 60 (with 10 and 60 inclusive). It cannot be less than "ptime".

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

Remarks

It will appear in the SDP of INVITE and 200 OK message as "ptime and "maxptime" attribute.