Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Message

An SDP message.

Hierarchy

  • Message

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Message(origin: Origin, sessionName: string, timeDescriptions: TimeDescription[]): Message
  • new Message(origin: Origin, sessionName: string): Message
  • new Message(origin: Origin): Message
  • Initializes a new instance of the fm.icelink.sdp.message class.

    Parameters

    • origin: Origin

      The originator of the session plus a session identifier and version number.

    • sessionName: string

      The textual session name.

    • timeDescriptions: TimeDescription[]

      The array of start, stop, and repeat times for the session.

    Returns Message

  • Initializes a new instance of the fm.icelink.sdp.message class.

    Parameters

    • origin: Origin

      The originator of the session plus a session identifier and version number.

    • sessionName: string

      The textual session name.

    Returns Message

  • Initializes a new instance of the fm.icelink.sdp.message class.

    Parameters

    • origin: Origin

      The originator of the session plus a session identifier and version number.

    Returns Message

Properties

Private __bandwidths

__bandwidths: Array<Bandwidth>
internal

Private __mediaDescriptions

__mediaDescriptions: Array<MediaDescription>
internal

Private __sessionAttributes

__sessionAttributes: AttributeCollection
internal

Private __timeDescriptions

__timeDescriptions: Array<TimeDescription>
internal

Private _connectionData

_connectionData: ConnectionData
internal

Private _emailAddress

_emailAddress: string
internal

Private _encryptionKey

_encryptionKey: EncryptionKey
internal

Private _origin

_origin: Origin
internal

Private _phoneNumber

_phoneNumber: string
internal

Private _protocolVersion

_protocolVersion: string
internal

Private _sessionInformation

_sessionInformation: string
internal

Private _sessionName

_sessionName: string
internal

Private _timeZoneAdjustments

_timeZoneAdjustments: TimeZones
internal

Private _uri

_uri: Uri
internal

Methods

addBandwidth

  • addBandwidth(bandwidth: Bandwidth): void
  • Adds a proposed bandwidth.

    Parameters

    • bandwidth: Bandwidth

      The proposed bandwidth to add.

    Returns void

addMediaDescription

  • addMediaDescription(mediaDescription: MediaDescription): void
  • Adds a media description.

    Parameters

    • mediaDescription: MediaDescription

      The media description to add.

    Returns void

addSessionAttribute

  • addSessionAttribute(attribute: Attribute): void
  • Adds a session-level attribute.

    Parameters

    • attribute: Attribute

      The session-level attribute to add.

    Returns void

addTimeDescription

  • addTimeDescription(timeDescription: TimeDescription): void
  • Adds a start, stop, and repeat time.

    Parameters

    • timeDescription: TimeDescription

      The start, stop, and repeat time to add.

    Returns void

Private findMediaDescriptions

  • findMediaDescriptions(mediaType: string): MediaDescription[]
  • internal

    Parameters

    • mediaType: string

    Returns MediaDescription[]

getApplicationDescription

  • getApplicationDescription(): MediaDescription
  • Gets the first media description of type "application".

    Returns MediaDescription

getApplicationDescriptions

  • getApplicationDescriptions(): MediaDescription[]
  • Gets any media descriptions of type "application".

    Returns MediaDescription[]

getAudioDescription

  • getAudioDescription(): MediaDescription
  • Gets the first media description of type "audio".

    Returns MediaDescription

getAudioDescriptions

  • getAudioDescriptions(): MediaDescription[]
  • Gets any media descriptions of type "audio".

    Returns MediaDescription[]

getBandwidths

  • getBandwidths(): Bandwidth[]
  • Gets the array of proposed bandwidths to be used by the session.

    Returns Bandwidth[]

getConnectionData

  • getConnectionData(): ConnectionData
  • Gets session-level connection data.

    Returns ConnectionData

getEmailAddress

  • getEmailAddress(): string
  • Gets the email address for the person responsible for the conference.

    Returns string

getEncryptionKey

  • getEncryptionKey(): EncryptionKey
  • Gets the session-level encryption key.

    Returns EncryptionKey

Private getFirstMediaDescription

  • getFirstMediaDescription(mediaDescriptions: MediaDescription[]): MediaDescription
  • internal

    Parameters

    • mediaDescriptions: MediaDescription[]

    Returns MediaDescription

getMediaDescriptions

  • getMediaDescriptions(): MediaDescription[]
  • Gets the array of media descriptions.

    Returns MediaDescription[]

getMessageDescription

  • getMessageDescription(): MediaDescription
  • Gets the first media description of type "message".

    Returns MediaDescription

getMessageDescriptions

  • getMessageDescriptions(): MediaDescription[]
  • Gets any media descriptions of type "message".

    Returns MediaDescription[]

getOrigin

  • getOrigin(): Origin
  • Gets the originator of the session plus a session identifier and version number.

    Returns Origin

getPhoneNumber

  • getPhoneNumber(): string
  • Gets the phone number for the person responsible for the conference.

    Returns string

getProtocolVersion

  • getProtocolVersion(): string
  • Gets the version of the Session Description Protocol.

    Returns string

getSessionAttributes

  • getSessionAttributes(): Attribute[]
  • Gets the array of session-level attributes.

    Returns Attribute[]

getSessionInformation

  • getSessionInformation(): string
  • Gets textual information about the session.

    Returns string

getSessionLevelCryptoAttributes

  • getSessionLevelCryptoAttributes(): CryptoAttribute[]
  • Obtains Crypto attributes from the session-level attributes in this message. Crypto attributes may also be sent as a media-level argument, so individual media descriptions must also be examined.

    Returns CryptoAttribute[]

getSessionLevelDirection

  • getSessionLevelDirection(): StreamDirection
  • Obtains the stream direction indicated as a session-level attribute in this message. If none is supplied, StreamDirection.Unset is returned. Stream Direction may also be (and most likely is) indicated as a media-level attribute, so individual media descriptions must also be examined.

    Returns StreamDirection

getSessionLevelFingerprintAttribute

  • getSessionLevelFingerprintAttribute(): FingerprintAttribute
  • Obtains Fingerprint attribute from the session-level attributes in this message. Fingerprint attribute may also be sent as a media-level argument, so individual media descriptions must also be examined.

    Returns FingerprintAttribute

getSessionLevelIceOptionAttributes

  • getSessionLevelIceOptionAttributes(): Attribute[]
  • Obtains session-level Ice Options attributes associated with the Sdp Message.

    Returns Attribute[]

getSessionLevelIcePasswordAttribute

  • getSessionLevelIcePasswordAttribute(): PasswordAttribute
  • Obtains Ice Password Attribute from the session-level attributes in this message. Ice Password attribute may also be sent as a media-level argument, so individual media descriptions must also be examined.

    Returns PasswordAttribute

getSessionLevelIceUfragAttribute

  • getSessionLevelIceUfragAttribute(): UfragAttribute
  • Obtains Ice Ufrag Attribute from the session-level attributes in this message. Ice Ufrag Attributes may also be sent as a media-level argument, so individual media descriptions must also be examined.

    Returns UfragAttribute

getSessionLevelRtcpMultiplexingSupport

  • getSessionLevelRtcpMultiplexingSupport(): boolean
  • Returns a value stating whether Rtcp Multiplexing support is indicated as a session-level attribute in this message. Rtcp Multiplexing support may also be indicated via a media-level argument, so individual media descriptions must also be examined.

    Returns boolean

getSessionLevelRtpExtMapAttributes

  • getSessionLevelRtpExtMapAttributes(): Attribute[]
  • Obtains session-level RTP ext-map attributes associated with the Sdp Message.

    Returns Attribute[]

getSessionLevelSetupAttribute

  • getSessionLevelSetupAttribute(): SetupAttribute
  • Obtains Setup Attribute from the session-level attributes in this message. Setup Attributes may also be sent as a media-level argument, so individual media descriptions must also be examined.

    Returns SetupAttribute

getSessionName

  • getSessionName(): string
  • Gets the textual session name.

    Returns string

getTextDescription

  • getTextDescription(): MediaDescription
  • Gets the first media description of type "text".

    Returns MediaDescription

getTextDescriptions

  • getTextDescriptions(): MediaDescription[]
  • Gets any media descriptions of type "text".

    Returns MediaDescription[]

getTimeDescriptions

  • getTimeDescriptions(): TimeDescription[]
  • Gets the array of start, stop, and repeat times for the session.

    Returns TimeDescription[]

getTimeZoneAdjustments

  • getTimeZoneAdjustments(): TimeZones
  • Gets the time zone adjustments.

    Returns TimeZones

getTypeString

  • getTypeString(): string

  • Returns string

getUri

  • getUri(): Uri
  • Gets the pointer to additional information about the session.

    Returns Uri

getVideoDescription

  • getVideoDescription(): MediaDescription
  • Gets the first media description of type "video".

    Returns MediaDescription

getVideoDescriptions

  • getVideoDescriptions(): MediaDescription[]
  • Gets any media descriptions of type "video".

    Returns MediaDescription[]

removeBandwidth

  • removeBandwidth(bandwidth: Bandwidth): boolean
  • Removes a proposed bandwidth.

    Parameters

    • bandwidth: Bandwidth

      The proposed bandwidth to remove.

    Returns boolean

removeMediaDescription

  • removeMediaDescription(mediaDescription: MediaDescription): boolean
  • Removes a media description.

    Parameters

    • mediaDescription: MediaDescription

      The media description to remove.

    Returns boolean

removeSessionAttribute

  • removeSessionAttribute(attributeType: AttributeType): boolean
  • Removes a session-level attribute.

    Parameters

    • attributeType: AttributeType

      The session-level attribute type to remove.

    Returns boolean

removeTimeDescription

  • removeTimeDescription(timeDescription: TimeDescription): boolean
  • Removes a start, stop, and repeat time.

    Parameters

    • timeDescription: TimeDescription

      The start, stop, and repeat time to remove.

    Returns boolean

removeTimeDescriptions

  • removeTimeDescriptions(): void
  • Removes all time descriptions.

    Returns void

setConnectionData

  • setConnectionData(value: ConnectionData): void
  • Sets session-level connection data.

    Parameters

    • value: ConnectionData

    Returns void

setEmailAddress

  • setEmailAddress(value: string): void
  • Sets the email address for the person responsible for the conference.

    Parameters

    • value: string

    Returns void

setEncryptionKey

  • setEncryptionKey(value: EncryptionKey): void
  • Sets the session-level encryption key.

    Parameters

    • value: EncryptionKey

    Returns void

Private setOrigin

  • setOrigin(value: Origin): void
  • internal

    Parameters

    • value: Origin

    Returns void

setPhoneNumber

  • setPhoneNumber(value: string): void
  • Sets the phone number for the person responsible for the conference.

    Parameters

    • value: string

    Returns void

Private setProtocolVersion

  • setProtocolVersion(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setSessionInformation

  • setSessionInformation(value: string): void
  • Sets textual information about the session.

    Parameters

    • value: string

    Returns void

Private setSessionName

  • setSessionName(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setTimeZoneAdjustments

  • setTimeZoneAdjustments(value: TimeZones): void
  • Sets the time zone adjustments.

    Parameters

    • value: TimeZones

    Returns void

setUri

  • setUri(value: Uri): void
  • Sets the pointer to additional information about the session.

    Parameters

    • value: Uri

    Returns void

toString

  • toString(): string
  • Converts this instance to a string.

    Returns string

updateSetupValue

  • updateSetupValue(setupValue: string): void
  • Updates SDP Setup Value associated with the session description.

    Parameters

    • setupValue: string

    Returns void

Static parse

  • parse(s: string): Message
  • Creates an fm.icelink.sdp.message instance from a string.

    Parameters

    • s: string

      The string to parse.

    Returns Message