/ fm / liveswitch / sdp / ice / OptionsAttribute
Class: OptionsAttribute
The "ice-options" attribute is a session-level attribute. It contains a series of tokens that identify the options supported by the agent.
Hierarchy
-
↳ OptionsAttribute
Table of contents
Constructors
Methods
- getAttributeType
- getAttributeValue
- getMultiplexingCategory
- getTags
- getTrickleOptionSet
- getTypeString
- setAttributeType
- setMultiplexingCategory
- setTags
- setTrickleOptionSet
- toString
- createAttribute
- fromAttributeValue
- getTypeName
- isMediaLevel
- isSessionLevel
- parse
Constructors
constructor
+ new OptionsAttribute(): OptionsAttribute
Returns: OptionsAttribute
Inherited from: Attribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/OptionsAttribute.ts:16
+ new OptionsAttribute(tags
: OptionTag[]): OptionsAttribute
Initializes a new instance of the [[fm.liveswitch.sdp.ice.optionsAttribute]] class.
Parameters:
Name | Type | Description |
---|---|---|
tags |
OptionTag[] | The tokens that identify options supported by the agent. |
Returns: OptionsAttribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/OptionsAttribute.ts:18
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 value of the attribute.
Returns: string
Overrides: Attribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/OptionsAttribute.ts:82
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
getTags
▸ getTags(): OptionTag[]
Gets the tokens that identify options supported by the agent.
Returns: OptionTag[]
Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/OptionsAttribute.ts:102
getTrickleOptionSet
▸ getTrickleOptionSet(): boolean
Gets a value indicating whether trickle-ice is supported.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/OptionsAttribute.ts:114
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Attribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/OptionsAttribute.ts:12
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
setTags
▸ setTags(value
: OptionTag[]): void
Sets the tokens that identify options supported by the agent.
Parameters:
Name | Type |
---|---|
value |
OptionTag[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/OptionsAttribute.ts:131
setTrickleOptionSet
▸ setTrickleOptionSet(value
: boolean): void
Sets a value indicating whether trickle-ice is supported.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/OptionsAttribute.ts:143
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): OptionsAttribute
Initializes a new instance of the [[fm.liveswitch.sdp.ice.optionsAttribute]] class.
Parameters:
Name | Type | Description |
---|---|---|
value |
string | The attribute value. |
Returns: OptionsAttribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/OptionsAttribute.ts:60
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