/ fm / liveswitch / sdp / rtp / RidRestriction

Class: RidRestriction

sdp.rtp.RidRestriction

A restriction for an RID attribute.

Table of contents

Constructors

Methods

Constructors

constructor

+ new RidRestriction(key: string): RidRestriction

Initializes a new instance of the [[fm.liveswitch.sdp.rtp.ridRestriction]] class.

Parameters:

Name Type Description
key string The key.

Returns: RidRestriction

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:15

+ new RidRestriction(key: string, value: string): RidRestriction

Initializes a new instance of the [[fm.liveswitch.sdp.rtp.ridRestriction]] class.

Parameters:

Name Type Description
key string The key.
value string The value.

Returns: RidRestriction

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:23

Methods

getKey

▸ getKey(): string

Gets the restriction key.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:199

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:9

getValue

▸ getValue(): string

Gets the restriction value.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:211

setValue

▸ setValue(value: string): void

Sets the restriction value.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:231

getDependKey

▸ StaticgetDependKey(): string

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.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:76

getMaxBitrateKey

▸ StaticgetMaxBitrateKey(): string

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

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:95

getMaxBitsPerPixelKey

▸ StaticgetMaxBitsPerPixelKey(): string

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.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:111

getMaxFrameSizeKey

▸ StaticgetMaxFrameSizeKey(): string

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.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:124

getMaxFramesPerSecondKey

▸ StaticgetMaxFramesPerSecondKey(): string

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.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:140

getMaxHeightKey

▸ StaticgetMaxHeightKey(): string

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.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:155

getMaxPixelsPerSecondKey

▸ StaticgetMaxPixelsPerSecondKey(): string

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.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:172

getMaxWidthKey

▸ StaticgetMaxWidthKey(): string

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.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidRestriction.ts:187