javax.sdp
Interface RepeatTime

All Superinterfaces:

Cloneable, Field, Serializable

All Known Implementing Classes:

RepeatField

public interface RepeatTime
extends Field

A RepeatTime represents a r= field contained within a TimeDescription. A RepeatTime specifies the repeat times for a SessionDescription. This consists of a "repeat interval", an "active duration", and a list of offsets relative to the t= start-time (see Time.getStart()). Quoting from RFC 2327: For example, if a session is active at 10am on Monday and 11am on Tuesday for one hour each week for three months, then the in the corresponding "t=" field would be the NTP representation of 10am on the first Monday, the would be 1 week, the would be 1 hour, and the offsets would be zero and 25 hours. The corresponding "t=" field stop time would be the NTP representation of the end of the last session three months later. By default all fields are in seconds, so the "r=" and "t=" fields might be: t=3034423619 3042462419 r=604800 3600 0 90000 Please refer to IETF RFC 2327 for a description of SDP.

Version:

1.0

Author:

deruelle

Method Summary

int	getActiveDuration() Returns the "active duration" in seconds.
int[]	getOffsetArray() Returns the list of offsets.
int	getRepeatInterval() Returns the "repeat interval" in seconds.
boolean	getTypedTime() Returns whether the field will be output as a typed time or a integer value.
void	setActiveDuration(int activeDuration) Sets the "active duration" in seconds.
void	setOffsetArray(int[] offsets) Set the list of offsets.
void	setRepeatInterval(int repeatInterval) Set the "repeat interval" in seconds.
void	setTypedTime(boolean typedTime) Sets whether the field will be output as a typed time or a integer value.

Methods inherited from interface javax.sdp.Field

clone, getTypeChar

Method Detail

getRepeatInterval

int getRepeatInterval()
                      throws SdpParseException

Returns the "repeat interval" in seconds.

Returns:

the "repeat interval" in seconds.

Throws:

SdpParseException

setRepeatInterval

void setRepeatInterval(int repeatInterval)
                       throws SdpException

Set the "repeat interval" in seconds.

Parameters:

repeatInterval - the "repeat interval" in seconds.

Throws:

SdpException - if repeatInterval is <0

getActiveDuration

int getActiveDuration()
                      throws SdpParseException

Returns the "active duration" in seconds.

Returns:

the "active duration" in seconds.

Throws:

SdpParseException

setActiveDuration

void setActiveDuration(int activeDuration)
                       throws SdpException

Sets the "active duration" in seconds.

Parameters:

activeDuration - the "active duration" in seconds.

Throws:

SdpException - if the active duration is <0

getOffsetArray

int[] getOffsetArray()
                     throws SdpParseException

Returns the list of offsets. These are relative to the start-time given in the Time object (t= field) with which this RepeatTime is associated.

Returns:

the list of offsets

Throws:

SdpParseException

setOffsetArray

void setOffsetArray(int[] offsets)
                    throws SdpException

Set the list of offsets. These are relative to the start-time given in the Time object (t= field) with which this RepeatTime is associated.

Parameters:

offsets - array of repeat time offsets

Throws:

SdpException

getTypedTime

boolean getTypedTime()
                     throws SdpParseException

Returns whether the field will be output as a typed time or a integer value. Typed time is formatted as an integer followed by a unit character. The unit indicates an appropriate multiplier for the integer. The following unit types are allowed. d - days (86400 seconds) h - hours (3600 seconds) m - minutes (60 seconds) s - seconds ( 1 seconds)

Returns:

true, if the field will be output as a typed time; false, if as an integer value.

Throws:

SdpParseException

setTypedTime

void setTypedTime(boolean typedTime)

Sets whether the field will be output as a typed time or a integer value. Typed time is formatted as an integer followed by a unit character. The unit indicates an appropriate multiplier for the integer. The following unit types are allowed. d - days (86400 seconds) h - hours (3600 seconds) m - minutes (60 seconds) s - seconds ( 1 seconds)

Parameters:

typedTime - typedTime - if set true, the start and stop times will be output in an optimal typed time format; if false, the times will be output as integers.