Class RidRestriction

A restriction for an RID attribute.

Inheritance

System.Object

RidRestriction

Namespace: FM.LiveSwitch.Sdp.Rtp

Assembly: FM.LiveSwitch.dll

Syntax

public class RidRestriction : object

Constructors

RidRestriction(String)

Initializes a new instance of the RidRestriction class.

Declaration

public RidRestriction(string key)

Parameters

Type	Name	Description
System.String	key	The key.

RidRestriction(String, String)

Initializes a new instance of the RidRestriction class.

Declaration

public RidRestriction(string key, string value)

Parameters

Type	Name	Description
System.String	key	The key.
System.String	value	The value.

Properties

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.

Declaration

public static string DependKey { get; }

Property Value

Type	Description
System.String

Key

Gets the restriction key.

Declaration

public string Key { get; }

Property Value

Type	Description
System.String

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

Declaration

public static string MaxBitrateKey { get; }

Property Value

Type	Description
System.String

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.

Declaration

public static string MaxBitsPerPixelKey { get; }

Property Value

Type	Description
System.String

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.

Declaration

public static string MaxFrameSizeKey { get; }

Property Value

Type	Description
System.String

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.

Declaration

public static string MaxFramesPerSecondKey { get; }

Property Value

Type	Description
System.String

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.

Declaration

public static string MaxHeightKey { get; }

Property Value

Type	Description
System.String

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.

Declaration

public static string MaxPixelsPerSecondKey { get; }

Property Value

Type	Description
System.String

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.

Declaration

public static string MaxWidthKey { get; }

Property Value

Type	Description
System.String

Value

Gets or sets the restriction value.

Declaration

public string Value { get; set; }

Property Value

Type	Description
System.String