/ fm / liveswitch / sdp / Message

Class: Message

liveswitch.sdp.Message

An SDP message.

Table of contents

Constructors

Methods

Constructors

constructor

+ new Message(origin: Origin): Message

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

Parameters:

Name Type Description
origin Origin The originator of the session plus a session identifier and version number.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:39

+ new Message(origin: Origin, sessionName: string): Message

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

Parameters:

Name Type Description
origin Origin The originator of the session plus a session identifier and version number.
sessionName string The textual session name.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:47

+ new Message(origin: Origin, sessionName: string, timeDescriptions: TimeDescription[]): Message

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

Parameters:

Name Type Description
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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:55

Methods

addBandwidth

▸ addBandwidth(bandwidth: Bandwidth): void

Adds a proposed bandwidth.

Parameters:

Name Type Description
bandwidth Bandwidth The proposed bandwidth to add.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:264

addMediaDescription

▸ addMediaDescription(mediaDescription: MediaDescription): void

Adds a media description.

Parameters:

Name Type Description
mediaDescription MediaDescription The media description to add.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:277

addSessionAttribute

▸ addSessionAttribute(attribute: Attribute): void

Adds a session-level attribute.

Parameters:

Name Type Description
attribute Attribute The session-level attribute to add.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:290

addTimeDescription

▸ addTimeDescription(timeDescription: TimeDescription): void

Adds a start, stop, and repeat time.

Parameters:

Name Type Description
timeDescription TimeDescription The start, stop, and repeat time to add.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:310

getApplicationDescription

▸ getApplicationDescription(): MediaDescription

Gets the first media description of type "application".

Returns: MediaDescription

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:378

getApplicationDescriptions

▸ getApplicationDescriptions(): MediaDescription[]

Gets any media descriptions of type "application".

Returns: MediaDescription[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:390

getAudioDescription

▸ getAudioDescription(): MediaDescription

Gets the first media description of type "audio".

Returns: MediaDescription

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:402

getAudioDescriptions

▸ getAudioDescriptions(): MediaDescription[]

Gets any media descriptions of type "audio".

Returns: MediaDescription[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:414

getBandwidths

▸ getBandwidths(): Bandwidth[]

Gets the array of proposed bandwidths to be used by the session.

Returns: Bandwidth[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:426

getBundleGroups

▸ getBundleGroups(): BundleGroup[]

Gets bundle groups in this media description.

Returns: BundleGroup[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:438

getConnectionData

▸ getConnectionData(): ConnectionData

Gets session-level connection data.

Returns: ConnectionData

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:458

getEmailAddress

▸ getEmailAddress(): string

Gets the email address for the person responsible for the conference.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:470

getEncryptionKey

▸ getEncryptionKey(): EncryptionKey

Gets the session-level encryption key.

Returns: EncryptionKey

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:482

getMediaDescriptions

▸ getMediaDescriptions(): MediaDescription[]

Gets the array of media descriptions.

Returns: MediaDescription[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:505

getMessageDescription

▸ getMessageDescription(): MediaDescription

Gets the first media description of type "message".

Returns: MediaDescription

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:517

getMessageDescriptions

▸ getMessageDescriptions(): MediaDescription[]

Gets any media descriptions of type "message".

Returns: MediaDescription[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:529

getOrigin

▸ getOrigin(): Origin

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

Returns: Origin

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:541

getPhoneNumber

▸ getPhoneNumber(): string

Gets the phone number for the person responsible for the conference.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:553

getProtocolVersion

▸ getProtocolVersion(): string

Gets the version of the Session Description Protocol.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:565

getSessionAttributes

▸ getSessionAttributes(): Attribute[]

Gets the array of session-level attributes.

Returns: Attribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:577

getSessionInformation

▸ getSessionInformation(): string

Gets textual information about the session.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:589

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[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:602

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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:615

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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:628

getSessionLevelIceOptionAttributes

▸ getSessionLevelIceOptionAttributes(): Attribute[]

Obtains session-level Ice Options attributes associated with the Sdp Message.

Returns: Attribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:640

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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:653

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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:666

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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:679

getSessionLevelRtpExtMapAttributes

▸ getSessionLevelRtpExtMapAttributes(): Attribute[]

Obtains session-level RTP ext-map attributes associated with the Sdp Message.

Returns: Attribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:691

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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:704

getSessionName

▸ getSessionName(): string

Gets the textual session name.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:716

getSupportsRtcpMultiplexing

▸ getSupportsRtcpMultiplexing(): boolean

Gets a value indicating whether the SDP Message implies RTP/RTCP Multiplexing Support.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:728

getSupportsTrickleIce

▸ getSupportsTrickleIce(): boolean

Gets a value indicating whether Trickle-ICE is supported.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:752

getTextDescription

▸ getTextDescription(): MediaDescription

Gets the first media description of type "text".

Returns: MediaDescription

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:785

getTextDescriptions

▸ getTextDescriptions(): MediaDescription[]

Gets any media descriptions of type "text".

Returns: MediaDescription[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:797

getTimeDescriptions

▸ getTimeDescriptions(): TimeDescription[]

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

Returns: TimeDescription[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:809

getTimeZoneAdjustments

▸ getTimeZoneAdjustments(): TimeZones

Gets the time zone adjustments.

Returns: TimeZones

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:821

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:9

getUri

▸ getUri(): Uri

Gets the pointer to additional information about the session.

Returns: Uri

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:833

getVideoDescription

▸ getVideoDescription(): MediaDescription

Gets the first media description of type "video".

Returns: MediaDescription

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:845

getVideoDescriptions

▸ getVideoDescriptions(): MediaDescription[]

Gets any media descriptions of type "video".

Returns: MediaDescription[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:857

insertMediaDescription

▸ insertMediaDescription(index: number, mediaDescription: MediaDescription): void

Adds a media description at the given index.

Parameters:

Name Type Description
index number The index at which to add the media description.
mediaDescription MediaDescription The media description to add.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:871

removeBandwidth

▸ removeBandwidth(bandwidth: Bandwidth): boolean

Removes a proposed bandwidth.

Parameters:

Name Type Description
bandwidth Bandwidth The proposed bandwidth to remove.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:885

removeMediaDescription

▸ removeMediaDescription(mediaDescription: MediaDescription): boolean

Removes a media description.

Parameters:

Name Type Description
mediaDescription MediaDescription The media description to remove.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:898

removeSessionAttribute

▸ removeSessionAttribute(attributeType: AttributeType): boolean

Removes a session-level attribute.

Parameters:

Name Type Description
attributeType AttributeType The session-level attribute type to remove.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:911

removeTimeDescription

▸ removeTimeDescription(timeDescription: TimeDescription): boolean

Removes a start, stop, and repeat time.

Parameters:

Name Type Description
timeDescription TimeDescription The start, stop, and repeat time to remove.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:924

removeTimeDescriptions

▸ removeTimeDescriptions(): void

Removes all time descriptions.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:936

setConnectionData

▸ setConnectionData(value: ConnectionData): void

Sets session-level connection data.

Parameters:

Name Type
value ConnectionData

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:948

setEmailAddress

▸ setEmailAddress(value: string): void

Sets the email address for the person responsible for the conference.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:960

setEncryptionKey

▸ setEncryptionKey(value: EncryptionKey): void

Sets the session-level encryption key.

Parameters:

Name Type
value EncryptionKey

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:972

setPhoneNumber

▸ setPhoneNumber(value: string): void

Sets the phone number for the person responsible for the conference.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:992

setSessionInformation

▸ setSessionInformation(value: string): void

Sets textual information about the session.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:1012

setSupportsTrickleIce

▸ setSupportsTrickleIce(value: boolean): void

Sets a value indicating whether Trickle-ICE is supported.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:1032

setTimeZoneAdjustments

▸ setTimeZoneAdjustments(value: TimeZones): void

Sets the time zone adjustments.

Parameters:

Name Type
value TimeZones

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:1077

setUri

▸ setUri(value: Uri): void

Sets the pointer to additional information about the session.

Parameters:

Name Type
value Uri

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:1089

toString

▸ toString(): string

Converts this instance to a string.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:1101

updateSetupValue

▸ updateSetupValue(setupValue: string): void

Updates SDP Setup Value associated with the session description.

Parameters:

Name Type
setupValue string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:1151

parse

▸ Staticparse(s: string): Message

Creates an [[fm.liveswitch.sdp.message]] instance from a string.

Parameters:

Name Type Description
s string The string to parse.

Returns: Message

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Message.ts:171