/ fm / liveswitch / SessionDescription

Class: SessionDescription

fm.liveswitch.SessionDescription

A session description.

Table of contents

Constructors

• constructor

Methods

• fmliveswitchSessionDescriptionInit
• getHasAudio
• getHasData
• getHasVideo
• getIsOffer
• getSdpMessage
• getSessionId
• getSessionVersion
• getTieBreaker
• getType
• getTypeString
• setSdpMessage
• setSessionVersion
• setTieBreaker
• setType
• toJson
• fromJson
• toJson

Constructors

constructor

+ new SessionDescription(): SessionDescription

Returns: SessionDescription

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:24

Methods

fmliveswitchSessionDescriptionInit

▸ PrivatefmliveswitchSessionDescriptionInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:21

---

getHasAudio

▸ getHasAudio(): boolean

Gets a value indicating whether an audio stream is described.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:97

---

getHasData

▸ getHasData(): boolean

Gets a value indicating whether a data stream is described.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:113

---

getHasVideo

▸ getHasVideo(): boolean

Gets a value indicating whether a video stream is described.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:129

---

getIsOffer

▸ getIsOffer(): boolean

Gets a value indicating whether this instance is offer.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:145

---

getSdpMessage

▸ getSdpMessage(): Message

Gets the SDP message.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:165

---

getSessionId

▸ getSessionId(): number

Gets the session id of the remote description, if remote description is set. Returns null otherwise.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:177

---

getSessionVersion

▸ getSessionVersion(): number

Gets the version of the remote description, if remote description is set. Returns null otherwise.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:195

---

getTieBreaker

▸ getTieBreaker(): string

Gets the tie breaker in case of a role conflict.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:213

---

getType

▸ getType(): SessionDescriptionType

Gets the type.

Returns: SessionDescriptionType

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:225

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:9

---

setSdpMessage

▸ setSdpMessage(value: Message): void

Sets the SDP message.

Parameters:

Name	Type
value	Message

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:245

---

setSessionVersion

▸ setSessionVersion(value: number): void

Sets the version of the remote description, if remote description is set. Returns null otherwise.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:257

---

setTieBreaker

▸ setTieBreaker(value: string): void

Sets the tie breaker in case of a role conflict.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:274

---

setType

▸ setType(value: SessionDescriptionType): void

Sets the type.

Parameters:

Name	Type
value	SessionDescriptionType

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:286

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:298

---

fromJson

▸ StaticfromJson(sessionDescriptionJson: string): SessionDescription

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
sessionDescriptionJson	string	The JSON to deserialize.

Returns: SessionDescription

The deserialized session description.

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:44

---

toJson

▸ StatictoJson(sessionDescription: SessionDescription): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
sessionDescription	SessionDescription	The session description.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/SessionDescription.ts:77