fm.liveswitch.sdp.rtp.RidRestriction Class Reference

A restriction for an RID attribute. More...

Public Member Functions
String	getKey ()
	Gets the restriction key. More...
String	getValue ()
	Gets the restriction value. More...
	RidRestriction (String key)
	Initializes a new instance of the fm.liveswitch.sdp.rtp.RidRestriction class. More...
	RidRestriction (String key, String value)
	Initializes a new instance of the fm.liveswitch.sdp.rtp.RidRestriction class. More...
void	setValue (String value)
	Sets the restriction value. More...

Static Public Member Functions
static String	getDependKey ()
	Gets the "depend" key, for spatial resolution in pixels. More...
static String	getMaxBitrateKey ()
	Gets the "max-br" key, for bit rate in bits per second. More...
static String	getMaxBitsPerPixelKey ()
	Gets the "max-bpp" key, for maximum number of bits per pixel, calculated as an average of all samples of any given coded picture. More...
static String	getMaxFrameSizeKey ()
	Gets the "max-fs" key, for frame size in pixels per frame. More...
static String	getMaxFramesPerSecondKey ()
	Gets the "max-fps" key, for frame rate in frames per second. More...
static String	getMaxHeightKey ()
	Gets the "max-height" key, for spatial resolution in pixels. More...
static String	getMaxPixelsPerSecondKey ()
	Gets the "max-pps" key, for pixel rate in pixels per second. More...
static String	getMaxWidthKey ()
	Gets the "max-width" key, for spatial resolution in pixels. More...

Detailed Description

A restriction for an RID attribute.

Constructor & Destructor Documentation

RidRestriction() [1/2]

fm.liveswitch.sdp.rtp.RidRestriction.RidRestriction

(

String

key

)

Initializes a new instance of the fm.liveswitch.sdp.rtp.RidRestriction class.

Parameters

key

The key.

RidRestriction() [2/2]

fm.liveswitch.sdp.rtp.RidRestriction.RidRestriction	(	String	key,
		String	value
	)

Initializes a new instance of the fm.liveswitch.sdp.rtp.RidRestriction class.

Parameters

key	The key.
value	The value.

Member Function Documentation

getDependKey()

static String fm.liveswitch.sdp.rtp.RidRestriction.getDependKey ( )

static

Gets the "depend" key, for spatial resolution in pixels.

The value is a comma-separated list of rid-ids.These rid-ids identify RTP streams that this stream depends on in order to allow for proper interpretation. The mechanism defined in this document allows for such dependencies to be expressed only when the streams are in the same media section.

getKey()

String fm.liveswitch.sdp.rtp.RidRestriction.getKey

(

)

Gets the restriction key.

getMaxBitrateKey()

static String fm.liveswitch.sdp.rtp.RidRestriction.getMaxBitrateKey ( )

static

Gets the "max-br" key, for bit rate in bits per second.

The restriction applies to the media payload only, and does not include overhead introduced by other layers(e.g., RTP, UDP, IP, or Ethernet). The exact means of keeping within this limit are left up to the implementation, and instantaneous excursions outside the limit are permissible. For any given one-second sliding window, however, the total number of bits in the payload portion of RTP SHOULD NOT exceed the value specified in "max-br."

getMaxBitsPerPixelKey()

static String fm.liveswitch.sdp.rtp.RidRestriction.getMaxBitsPerPixelKey ( )

static

Gets the "max-bpp" key, for maximum number of bits per pixel, calculated as an average of all samples of any given coded picture.

This is expressed as a floating point value, with an allowed range of 0.0001 to 48.0. These values MUST NOT be encoded with more than four digits to the right of the decimal point.

getMaxFrameSizeKey()

static String fm.liveswitch.sdp.rtp.RidRestriction.getMaxFrameSizeKey ( )

static

Gets the "max-fs" key, for frame size in pixels per frame.

This is the product of frame width and frame height, in pixels, for rectangular frames.

getMaxFramesPerSecondKey()

static String fm.liveswitch.sdp.rtp.RidRestriction.getMaxFramesPerSecondKey ( )

static

Gets the "max-fps" key, for frame rate in frames per second.

For encoders that do not use a fixed framerate for encoding, this value is used to restrict the minimum amount of time between frames: the time between any two consecutive frames SHOULD NOT be less than 1 / max - fps seconds.

getMaxHeightKey()

static String fm.liveswitch.sdp.rtp.RidRestriction.getMaxHeightKey ( )

static

Gets the "max-height" key, for spatial resolution in pixels.

In the case that stream orientation signaling is used to modify the intended display orientation, this attribute refers to the height of the stream when a rotation of zero degrees is encoded.

getMaxPixelsPerSecondKey()

static String fm.liveswitch.sdp.rtp.RidRestriction.getMaxPixelsPerSecondKey ( )

static

Gets the "max-pps" key, for pixel rate in pixels per second.

This value SHOULD be handled identically to max-fps, after performing the following conversion: max-fps = max-pps / (width* height). If the stream resolution changes, this value is recalculated. Due to this recalculation, excursions outside the specified maximum are possible near resolution change boundaries.

getMaxWidthKey()

static String fm.liveswitch.sdp.rtp.RidRestriction.getMaxWidthKey ( )

static

Gets the "max-width" key, for spatial resolution in pixels.

In the case that stream orientation signaling is used to modify the intended display orientation, this attribute refers to the width of the stream when a rotation of zero degrees is encoded.

getValue()

String fm.liveswitch.sdp.rtp.RidRestriction.getValue

(

)

Gets the restriction value.

setValue()

void fm.liveswitch.sdp.rtp.RidRestriction.setValue

(

String

value

)

Sets the restriction value.