Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SessionDescription

A session description.

Hierarchy

  • SessionDescription

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _renegotiation

_renegotiation: boolean
internal

Private _sdpMessage

_sdpMessage: Message
internal

Private _tieBreaker

_tieBreaker: string
internal

Private _type

_type: SessionDescriptionType
internal

Methods

getHasAudio

  • getHasAudio(): boolean
  • Gets a value indicating whether an audio stream is described.

    Returns boolean

getHasData

  • getHasData(): boolean
  • Gets a value indicating whether a data stream is described.

    Returns boolean

getHasVideo

  • getHasVideo(): boolean
  • Gets a value indicating whether a video stream is described.

    Returns boolean

getIsOffer

  • getIsOffer(): boolean
  • Gets a value indicating whether this instance is offer.

    Returns boolean

getRenegotiation

  • getRenegotiation(): boolean
  • internal

    Returns boolean

getSdpMessage

  • getSdpMessage(): Message
  • Gets the SDP message.

    Returns Message

getSessionId

  • getSessionId(): number
  • Gets the session id of the remote description, if remote description is set. Returns null otherwise.

    Returns number

getSessionVersion

  • getSessionVersion(): number
  • Gets the version of the remote description, if remote description is set. Returns null otherwise.

    Returns number

getTieBreaker

  • getTieBreaker(): string
  • Gets the tie breaker in case of a role conflict.

    Returns string

getType

  • getType(): SessionDescriptionType
  • Gets the type.

    Returns SessionDescriptionType

getTypeString

  • getTypeString(): string

  • Returns string

setRenegotiation

  • setRenegotiation(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setSdpMessage

  • setSdpMessage(value: Message): void
  • Sets the SDP message.

    Parameters

    • value: Message

    Returns void

setTieBreaker

  • setTieBreaker(value: string): void
  • Sets the tie breaker in case of a role conflict.

    Parameters

    • value: string

    Returns void

setType

  • setType(value: SessionDescriptionType): void
  • Sets the type.

    Parameters

    • value: SessionDescriptionType

    Returns void

toJson

  • toJson(): string
  • Serializes this instance to JSON.

    Returns string

Static fromJson

  • fromJson(sessionDescriptionJson: string): SessionDescription
  • Deserializes an instance from JSON.

    Parameters

    • sessionDescriptionJson: string

      The JSON to deserialize.

    Returns SessionDescription

    The deserialized session description.

Static toJson

  • toJson(sessionDescription: SessionDescription): string
  • Serializes an instance to JSON.

    Parameters

    • sessionDescription: SessionDescription

      The session description.

    Returns string

    The serialized JSON.