/ fm / liveswitch / sdp / rtp / SsrcAttribute

Class: SsrcAttribute

sdp.rtp.SsrcAttribute

The SDP media attribute "ssrc" indicates a property (known as a "source-level attribute") of a media source (RTP stream) within an RTP session.

Hierarchy

• Attribute

  ↳ SsrcAttribute

Table of contents

Constructors

• constructor

Methods

• fmliveswitchsdprtpSsrcAttributeInit
• getAttributeType
• getAttributeValue
• getMultiplexingCategory
• getName
• getSynchronizationSource
• getTypeString
• getValue
• setAttributeType
• setMultiplexingCategory
• setValue
• toString
• createAttribute
• fromAttributeValue
• getTypeName
• isMediaLevel
• isSessionLevel
• parse

Constructors

constructor

+ new SsrcAttribute(): SsrcAttribute

Returns: SsrcAttribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcAttribute.ts:25

+ new SsrcAttribute(synchronizationSource: number, attributeName: string): SsrcAttribute

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

Parameters:

Name	Type	Description
synchronizationSource	number	The synchronization source.
attributeName	string	Name of the attribute.

Returns: SsrcAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcAttribute.ts:26

+ new SsrcAttribute(synchronizationSource: number, attributeName: string, attributeValue: string): SsrcAttribute

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

Parameters:

Name	Type	Description
synchronizationSource	number	The synchronization source.
attributeName	string	Name of the attribute.
attributeValue	string	The attribute value.

Returns: SsrcAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcAttribute.ts:34

Methods

fmliveswitchsdprtpSsrcAttributeInit

▸ PrivatefmliveswitchsdprtpSsrcAttributeInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcAttribute.ts:22

---

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/SsrcAttribute.ts:138

---

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

---

getName

▸ getName(): string

Gets the name of the attribute.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcAttribute.ts:158

---

getSynchronizationSource

▸ getSynchronizationSource(): number

Gets the synchronization source.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcAttribute.ts:170

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcAttribute.ts:12

---

getValue

▸ getValue(): string

Gets the attribute value.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcAttribute.ts:182

---

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

---

setValue

▸ setValue(value: string): void

Sets the attribute value.

Parameters:

Name	Type
value	string

Returns: void

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

---

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): SsrcAttribute

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

Parameters:

Name	Type	Description
value	string	The attribute value.

Returns: SsrcAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcAttribute.ts:109

---

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