/ fm / liveswitch / sdp / InactiveAttribute

Class: InactiveAttribute

liveswitch.sdp.InactiveAttribute

This specifies that the tools should be started in inactive mode. This is necessary for interactive conferences where users can put other users on hold. No media is sent over an inactive media stream. Note that an RTP-based system SHOULD still send RTCP, even if started inactive. It can be either a session or media-level attribute, and it is not dependent on charset.

Hierarchy

• DirectionAttribute

  ↳ InactiveAttribute

Table of contents

Constructors

• constructor

Methods

• getAttributeType
• getAttributeValue
• getMultiplexingCategory
• getStreamDirection
• getTypeString
• setAttributeType
• setMultiplexingCategory
• toString
• createAttribute
• fromAttributeValue
• generateDirectionAttribute
• getTypeName
• isMediaLevel
• isSessionLevel
• parse

Constructors

constructor

+ new InactiveAttribute(): InactiveAttribute

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

Returns: InactiveAttribute

Inherited from: DirectionAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/InactiveAttribute.ts:18

Methods

getAttributeType

▸ getAttributeType(): AttributeType

Gets this Attribute's Type.

Returns: AttributeType

Inherited from: DirectionAttribute

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

---

getAttributeValue

▸ ProtectedgetAttributeValue(): string

Gets the internal value of the attribute.

Returns: string

Overrides: DirectionAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/InactiveAttribute.ts:55

---

getMultiplexingCategory

▸ getMultiplexingCategory(): AttributeCategory

Gets the Multiplexing Category of this Attribute.

Returns: AttributeCategory

Inherited from: DirectionAttribute

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

---

getStreamDirection

▸ getStreamDirection(): StreamDirection

Gets the stream direction.

Returns: StreamDirection

Overrides: DirectionAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/InactiveAttribute.ts:67

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: DirectionAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/InactiveAttribute.ts:16

---

setAttributeType

▸ setAttributeType(value: AttributeType): void

Sets this Attribute's Type.

Parameters:

Name	Type
value	AttributeType

Returns: void

Inherited from: DirectionAttribute

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: DirectionAttribute

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

---

toString

▸ toString(): string

Converts this instance to a string.

Returns: string

Inherited from: DirectionAttribute

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: DirectionAttribute

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

---

fromAttributeValue

▸ StaticfromAttributeValue(value: string): InactiveAttribute

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

Parameters:

Name	Type	Description
value	string	The attribute value.

Returns: InactiveAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/InactiveAttribute.ts:43

---

generateDirectionAttribute

▸ StaticgenerateDirectionAttribute(direction: StreamDirection): DirectionAttribute

Creates a DirectionAttribute for a required direction.

Parameters:

Name	Type	Description
direction	StreamDirection	Direction.

Returns: DirectionAttribute

Inherited from: DirectionAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/DirectionAttribute.ts:30

---

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: DirectionAttribute

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: DirectionAttribute

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: DirectionAttribute

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: DirectionAttribute

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