/ fm / liveswitch / sdp / LanguageAttribute
Class: LanguageAttribute
liveswitch.sdp.LanguageAttribute
This can be a session-level attribute or a media-level attribute. As a session-level attribute, it specifies the default language for the session being described. As a media- level attribute, it specifies the language for that media, overriding any session-level language specified. Multiple lang attributes can be provided either at session or media level if the session description or media use multiple languages, in which case the order of the attributes indicates the order of importance of the various languages in the session or media from most important to least important.
Hierarchy
-
↳ LanguageAttribute
Table of contents
Constructors
Methods
- getAttributeType
- getAttributeValue
- getLanguageTag
- getMultiplexingCategory
- getTypeString
- setAttributeType
- setMultiplexingCategory
- toString
- createAttribute
- fromAttributeValue
- getTypeName
- isMediaLevel
- isSessionLevel
- parse
Constructors
constructor
+ new LanguageAttribute(languageTag
: string): LanguageAttribute
Initializes a new instance of the [[fm.liveswitch.sdp.languageAttribute]] class.
Parameters:
Name | Type | Description |
---|---|---|
languageTag |
string | The default language for the session being described (if used as a session-level attribute) or the language for a media stream (if used as a media-level attribute). |
Returns: LanguageAttribute
Inherited from: Attribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/LanguageAttribute.ts:23
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/LanguageAttribute.ts:69
getLanguageTag
▸ getLanguageTag(): string
Gets the default language for the session being described (if used as a session-level attribute) or the language for a media stream (if used as a media-level attribute).
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/LanguageAttribute.ts:83
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
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Attribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/LanguageAttribute.ts:19
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): LanguageAttribute
Initializes a new instance of the [[fm.liveswitch.sdp.languageAttribute]] class.
Parameters:
Name | Type | Description |
---|---|---|
value |
string | The attribute value. |
Returns: LanguageAttribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/LanguageAttribute.ts:57
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