FMLiveSwitchSdpRtpRidRestriction Class Reference

A restriction for an RID attribute. More...

Instance Methods
(instancetype)	- initWithKey:
	Initializes a new instance of the FMLiveSwitchSdpRtpRidRestriction class. More...
(instancetype)	- initWithKey:value:
	Initializes a new instance of the FMLiveSwitchSdpRtpRidRestriction class. More...
(NSString *)	- key
	Gets the restriction key. More...
(void)	- setValue:
	Sets the restriction value. More...
(NSString *)	- value
	Gets the restriction value. More...

Class Methods
(NSString *)	+ dependKey
	Gets the "depend" key, for spatial resolution in pixels. More...
(NSString *)	+ maxBitrateKey
	Gets the "max-br" key, for bit rate in bits per second. More...
(NSString *)	+ maxBitsPerPixelKey
	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...
(NSString *)	+ maxFrameSizeKey
	Gets the "max-fs" key, for frame size in pixels per frame. More...
(NSString *)	+ maxFramesPerSecondKey
	Gets the "max-fps" key, for frame rate in frames per second. More...
(NSString *)	+ maxHeightKey
	Gets the "max-height" key, for spatial resolution in pixels. More...
(NSString *)	+ maxPixelsPerSecondKey
	Gets the "max-pps" key, for pixel rate in pixels per second. More...
(NSString *)	+ maxWidthKey
	Gets the "max-width" key, for spatial resolution in pixels. More...
(FMLiveSwitchSdpRtpRidRestriction *)	+ ridRestrictionWithKey:
	Initializes a new instance of the FMLiveSwitchSdpRtpRidRestriction class. More...
(FMLiveSwitchSdpRtpRidRestriction *)	+ ridRestrictionWithKey:value:
	Initializes a new instance of the FMLiveSwitchSdpRtpRidRestriction class. More...

Detailed Description

A restriction for an RID attribute.

Method Documentation

dependKey

+ (NSString*) dependKey

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.

initWithKey:

- (instancetype) initWithKey:

(NSString *)

key

Initializes a new instance of the FMLiveSwitchSdpRtpRidRestriction class.

Parameters

key

The key.

initWithKey:value:

- (instancetype) initWithKey:		(NSString *)	key
value:		(NSString *)	value

Initializes a new instance of the FMLiveSwitchSdpRtpRidRestriction class.

Parameters

key	The key.
value	The value.

key

- (NSString*) key

Gets the restriction key.

maxBitrateKey

+ (NSString*) maxBitrateKey

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."

maxBitsPerPixelKey

+ (NSString*) maxBitsPerPixelKey

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.

maxFrameSizeKey

+ (NSString*) maxFrameSizeKey

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.

maxFramesPerSecondKey

+ (NSString*) maxFramesPerSecondKey

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.

maxHeightKey

+ (NSString*) maxHeightKey

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.

maxPixelsPerSecondKey

+ (NSString*) maxPixelsPerSecondKey

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.

maxWidthKey

+ (NSString*) maxWidthKey

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.

ridRestrictionWithKey:

+ (FMLiveSwitchSdpRtpRidRestriction*) ridRestrictionWithKey:

(NSString *)

key

Initializes a new instance of the FMLiveSwitchSdpRtpRidRestriction class.

Parameters

key

The key.

ridRestrictionWithKey:value:

+ (FMLiveSwitchSdpRtpRidRestriction*) ridRestrictionWithKey:		(NSString *)	key
value:		(NSString *)	value

Initializes a new instance of the FMLiveSwitchSdpRtpRidRestriction class.

Parameters

key	The key.
value	The value.

setValue:

- (void) setValue:

(NSString *)

value

Sets the restriction value.

value

- (NSString*) value

Gets the restriction value.