org.lastbamboo.common.sdp.api
Interface SdpEncoder

public interface SdpEncoder

A SdpEncoder serializes SessionDescription objects in a customizable manner.

Version:

1.0

Author:

deruelle

Method Summary

void	output(SessionDescription sd, OutputStream out) Write the specified SessionDescription to the output stream using the current settings.
void	setEncoding(String enc) Specifies the character set to be used to display the session name and information data.
void	setRtpmapAttribute(boolean flag) Specifies whether to generate "a=rtpmap:" attributes for static RTP/AVP format strings.
void	setTypedTime(boolean flag) Specifies whether to try to write "typed-time" fields instead of raw integer values.

Method Detail

setEncoding

void setEncoding(String enc)
                 throws UnsupportedEncodingException

Specifies the character set to be used to display the session name and information data. By default, the ISO-10646 character set in UTF-8 encoding is used. If a more compact representation is required, other character sets may be used such as ISO-8859-1 for Northern European languages.

Parameters:

enc - enc - name of character encoding to use for session name and information data

Throws:

UnsupportedEncodingException - if the named encoding is not supported

setTypedTime

void setTypedTime(boolean flag)

Specifies whether to try to write "typed-time" fields instead of raw integer values. This makes the session description more readable but may have an adverse effect on serialization time. Ordinarily time values are given in numbers of seconds, but for readability they may be specified using logical units. From RFC 2327: To make announcements more compact, times may also be given in units of days, hours or minutes. The syntax for these is a number immediately followed by a single case-sensitive character. Fractional units are not allowed - a smaller unit should be used instead. The following unit specification characters are allowed: d - days (86400 seconds) h - minutes (3600 seconds) m - minutes (60 seconds) s - seconds (allowed for completeness but not recommended)

Parameters:

flag - if true this Outputter should emit "typed" time specs in preference to untyped times.

setRtpmapAttribute

void setRtpmapAttribute(boolean flag)

Specifies whether to generate "a=rtpmap:" attributes for static RTP/AVP format strings. This is recommended but makes messages bigger. The default is not to write such attributes.

Parameters:

flag - if true "a=rtpmap:" attributes are generated for all "RTP/AVP" formats

output

void output(SessionDescription sd,
            OutputStream out)
            throws IOException

Write the specified SessionDescription to the output stream using the current settings.

Parameters:

sd - SessionDescription to serialize

out - OutputStream to write serialized SessionDescription to

Throws:

IOException