/ fm / liveswitch / sdp / rtp / SsrcGroupAttribute
Class: SsrcGroupAttribute
The SDP media attribute "ssrc-group" expresses a relationship among several sources of an RTP session.
Hierarchy
-
↳ SsrcGroupAttribute
Table of contents
Constructors
Methods
- getAttributeType
- getAttributeValue
- getMultiplexingCategory
- getSemantics
- getSynchronizationSources
- getTypeString
- setAttributeType
- setMultiplexingCategory
- toString
- createAttribute
- fromAttributeValue
- getTypeName
- isMediaLevel
- isSessionLevel
- parse
Constructors
constructor
+ new SsrcGroupAttribute(): SsrcGroupAttribute
Returns: SsrcGroupAttribute
Inherited from: Attribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcGroupAttribute.ts:17
+ new SsrcGroupAttribute(semantics
: string, synchronizationSources
: number[]): SsrcGroupAttribute
Initializes a new instance of the [[fm.liveswitch.sdp.rtp.ssrcGroupAttribute]] class.
Parameters:
Name | Type | Description |
---|---|---|
semantics |
string | The semantics. |
synchronizationSources |
number[] | The synchronization sources. |
Returns: SsrcGroupAttribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcGroupAttribute.ts:19
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
▸ Protected
getAttributeValue(): string
Gets the internal value of the attribute.
Returns: string
Overrides: Attribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcGroupAttribute.ts:88
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
getSemantics
▸ getSemantics(): string
Gets the semantics.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcGroupAttribute.ts:106
getSynchronizationSources
▸ getSynchronizationSources(): number[]
Gets the synchronization sources.
Returns: number[]
Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcGroupAttribute.ts:118
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Attribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcGroupAttribute.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
▸ Protected
setMultiplexingCategory(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
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
▸ Static
createAttribute(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
▸ Static
fromAttributeValue(value
: string): SsrcGroupAttribute
Initializes a new instance of the [[fm.liveswitch.sdp.rtp.ssrcGroupAttribute]] class.
Parameters:
Name | Type | Description |
---|---|---|
value |
string | The attribute value. |
Returns: SsrcGroupAttribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SsrcGroupAttribute.ts:65
getTypeName
▸ Static
getTypeName(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
▸ Static
isMediaLevel(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
▸ Static
isSessionLevel(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
▸ Static
parse(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