/ fm / liveswitch / sdp / ReceiveOnlyAttribute

Class: ReceiveOnlyAttribute

liveswitch.sdp.ReceiveOnlyAttribute

This specifies that the tools should be started in receive-only mode where applicable. It can be either a session- or media- level attribute, and it is not dependent on charset. Note that recvonly applies to the media only, not to any associated control protocol (e.g., an RTP-based system in recvonly mode SHOULD still send RTCP packets).

Hierarchy

• DirectionAttribute

  ↳ ReceiveOnlyAttribute

Table of contents

Constructors

• constructor

Methods

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

Constructors

constructor

+ new ReceiveOnlyAttribute(): ReceiveOnlyAttribute

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

Returns: ReceiveOnlyAttribute

Inherited from: DirectionAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ReceiveOnlyAttribute.ts:17

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/ReceiveOnlyAttribute.ts:54

---

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/ReceiveOnlyAttribute.ts:66

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: DirectionAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ReceiveOnlyAttribute.ts:15

---

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

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

Parameters:

Name	Type	Description
value	string	The attribute value.

Returns: ReceiveOnlyAttribute

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

---

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