/ fm / liveswitch / SessionDescription

Class: SessionDescription

fm.liveswitch.SessionDescription

A session description.

Table of contents

Constructors

Methods

Constructors

constructor

+ new SessionDescription(): SessionDescription

Returns: SessionDescription

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

Methods

fmliveswitchSessionDescriptionInit

▸ PrivatefmliveswitchSessionDescriptionInit(): void

Returns: void

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

getHasAudio

▸ getHasAudio(): boolean

Gets a value indicating whether an audio stream is described.

Returns: boolean

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

getHasData

▸ getHasData(): boolean

Gets a value indicating whether a data stream is described.

Returns: boolean

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

getHasVideo

▸ getHasVideo(): boolean

Gets a value indicating whether a video stream is described.

Returns: boolean

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

getIsOffer

▸ getIsOffer(): boolean

Gets a value indicating whether this instance is offer.

Returns: boolean

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

getSdpMessage

▸ getSdpMessage(): Message

Gets the SDP message.

Returns: Message

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

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

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

getTieBreaker

▸ getTieBreaker(): string

Gets the tie breaker in case of a role conflict.

Returns: string

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

getType

▸ getType(): SessionDescriptionType

Gets the type.

Returns: SessionDescriptionType

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

getTypeString

▸ getTypeString(): string

Returns: string

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

setSdpMessage

▸ setSdpMessage(value: Message): void

Sets the SDP message.

Parameters:

Name Type
value Message

Returns: void

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

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

setType

▸ setType(value: SessionDescriptionType): void

Sets the type.

Parameters:

Name Type
value SessionDescriptionType

Returns: void

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

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

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

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

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