/ fm / liveswitch / sdp / rtp / RidAttribute

Class: RidAttribute

sdp.rtp.RidAttribute

The SDP media attribute "rid" specifies restrictions defining a unique RTP payload configuration.

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

+ new RidAttribute(): RidAttribute

Returns: RidAttribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:21

+ new RidAttribute(idValue: string, direction: string): RidAttribute

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

Parameters:

Name Type Description
idValue string The identifier.
direction string The direction.

Returns: RidAttribute

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

+ new RidAttribute(idValue: string, direction: string, payloadTypes: number[]): RidAttribute

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

Parameters:

Name Type Description
idValue string The identifier.
direction string The direction.
payloadTypes number[] The payload types.

Returns: RidAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:31

+ new RidAttribute(idValue: string, direction: string, payloadTypes: number[], restrictions: RidRestriction[]): RidAttribute

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

Parameters:

Name Type Description
idValue string The identifier.
direction string The direction.
payloadTypes number[] The payload types.
restrictions RidRestriction[] The restrictions.

Returns: RidAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:40

+ new RidAttribute(idValue: string, direction: string, restrictions: RidRestriction[]): RidAttribute

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

Parameters:

Name Type Description
idValue string The identifier.
direction string The direction.
restrictions RidRestriction[] The restrictions.

Returns: RidAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:50

Methods

getAttributeType

▸ getAttributeType(): AttributeType

Gets this Attribute's Type.

Returns: AttributeType

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:582

getAttributeValue

▸ ProtectedgetAttributeValue(): string

Gets the internal value of the attribute.

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:303

getDirection

▸ getDirection(): string

Gets the direction.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:343

getId

▸ getId(): string

Gets the identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:355

getMultiplexingCategory

▸ getMultiplexingCategory(): AttributeCategory

Gets the Multiplexing Category of this Attribute.

Returns: AttributeCategory

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:600

getPayloadTypes

▸ getPayloadTypes(): number[]

Gets the payload types that can be used in the associated stream. This property is optional and may be null.

Returns: number[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:369

getRestrictionValue

▸ getRestrictionValue(restrictionKey: string): string

Gets a restriction value.

Parameters:

Name Type Description
restrictionKey string The restriction key.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:396

getRestrictions

▸ getRestrictions(): RidRestriction[]

Gets the codec-agnostic restrictions to which the corresponding stream will conform. This property is optional and may be null.

Returns: RidRestriction[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:383

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:11

setAttributeType

▸ setAttributeType(value: AttributeType): void

Sets this Attribute's Type.

Parameters:

Name Type
value AttributeType

Returns: void

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:612

setMultiplexingCategory

▸ ProtectedsetMultiplexingCategory(value: AttributeCategory): void

Sets the Multiplexing Category of this Attribute.

Parameters:

Name Type
value AttributeCategory

Returns: void

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:624

setPayloadTypes

▸ setPayloadTypes(value: number[]): void

Sets the payload types that can be used in the associated stream. This property is optional and may be null.

Parameters:

Name Type
value number[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:436

setRestrictions

▸ setRestrictions(value: RidRestriction[]): void

Sets the codec-agnostic restrictions to which the corresponding stream will conform. This property is optional and may be null.

Parameters:

Name Type
value RidRestriction[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:450

toString

▸ toString(): string

Converts this instance to a string.

Returns: string

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:636

createAttribute

▸ StaticcreateAttribute(name: string, value: string): Attribute

Creates an attribute.

Parameters:

Name Type Description
name string The name.
value string The value.

Returns: Attribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:42

fromAttributeValue

▸ StaticfromAttributeValue(value: string): RidAttribute

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

Parameters:

Name Type Description
value string The attribute value.

Returns: RidAttribute

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

getTypeName

▸ StaticgetTypeName(type: Type): string

Gets the name of the attribute type.

Parameters:

Name Type Description
type Type The attribute type.

Returns: string

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:467

isMediaLevel

▸ StaticisMediaLevel(type: Type): boolean

Determines whether the type applies to media streams.

Parameters:

Name Type Description
type Type The type.

Returns: boolean

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:492

isSessionLevel

▸ StaticisSessionLevel(type: Type): boolean

Determines whether the type applies to sessions.

Parameters:

Name Type Description
type Type The type.

Returns: boolean

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:516

parse

▸ Staticparse(s: string): Attribute

Creates an [[fm.liveswitch.sdp.connectionData]] instance from a string.

Parameters:

Name Type Description
s string The string to parse.

Returns: Attribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:540

validateId

▸ StaticvalidateId(idValue: string): boolean

Validates that the identifier conforms to RFC syntax, which means that it only contains alpha-numeric characters and/or the hyphen and underscore. See https://tools.ietf.org/html/draft-ietf-avtext-rid/ and https://tools.ietf.org/html/draft-ietf-mmusic-rid/ for more info.

Parameters:

Name Type Description
idValue string The identifier

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/RidAttribute.ts:272