/ fm / liveswitch / sdp / MediaDescription

Class: MediaDescription

liveswitch.sdp.MediaDescription

An SDP media description element.

Table of contents

Constructors

Methods

Constructors

constructor

+ new MediaDescription(media: Media): MediaDescription

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

Parameters:

Name Type Description
media Media The media name and transport address.

Returns: MediaDescription

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:25

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/MediaDescription.ts:390

addMediaAttribute

▸ addMediaAttribute(attribute: Attribute): void

Adds a media-level attribute.

Parameters:

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

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:403

getBandwidths

▸ getBandwidths(): Bandwidth[]

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

Returns: Bandwidth[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:479

getBundleOnly

▸ getBundleOnly(): boolean

Gets a value indicating whether this media description has been marked as bundle-only.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:491

getCandidateAttributes

▸ getCandidateAttributes(): Attribute[]

Obtains Ice Candidate attributes associated with this media description.

Returns: Attribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:503

getCcmFirFeedbackAttribute

▸ getCcmFirFeedbackAttribute(payloadType: number): FeedbackAttribute

Gets the RTCP "ccm fir" feedback attribute for the given payload type.

Parameters:

Name Type Description
payloadType number The payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:537

getCcmLrrFeedbackAttribute

▸ getCcmLrrFeedbackAttribute(payloadType: number): FeedbackAttribute

Gets the RTCP "ccm lrr" feedback attribute for the given payload type.

Parameters:

Name Type Description
payloadType number The payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:551

getConnectionData

▸ getConnectionData(): ConnectionData

Gets media-level connection data.

Returns: ConnectionData

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:564

getContentAttribute

▸ getContentAttribute(): ContentAttribute

Obtains the content attribute.

Returns: ContentAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:576

getCryptoAttributes

▸ getCryptoAttributes(): CryptoAttribute[]

Gets CryptoAttributes associated with this MediaDescription.

Returns: CryptoAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:595

getEncryptionKey

▸ getEncryptionKey(): EncryptionKey

Gets the media-level encryption key.

Returns: EncryptionKey

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:607

getFingerprintAttribute

▸ getFingerprintAttribute(): FingerprintAttribute

Gets the Fingerprint Attribute from this MediaDescription

Returns: FingerprintAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:619

getFormatParameterValue

▸ getFormatParameterValue(payloadType: number, formatParameterName: string): string

Sets a format parameter value.

Parameters:

Name Type
payloadType number
formatParameterName string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:657

getFormatParametersAttribute

▸ getFormatParametersAttribute(payloadType: number): FormatParametersAttribute

Gets the format parameters attribute for the given payload type.

Parameters:

Name Type Description
payloadType number The payload type.

Returns: FormatParametersAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:632

getIceOptionAttributes

▸ getIceOptionAttributes(): Attribute[]

Obtains Ice Options attributes associated with this media description.

Returns: Attribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:686

getIcePasswordAttribute

▸ getIcePasswordAttribute(): PasswordAttribute

Gets the IcePasswordAttribute associated with this MediaDescription

Returns: PasswordAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:698

getIceUfragAttribute

▸ getIceUfragAttribute(): UfragAttribute

Gets the IceUfragAttribute associated with this MediaDescription

Returns: UfragAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:710

getIdenticalCategoryAttributes

▸ getIdenticalCategoryAttributes(): Attribute[]

Gets the attributes with Identical Multiplexing Category present in this description.

Returns: Attribute[]

Attributes with Identical Multiplexing Category present in this description.

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:723

getIsApplication

▸ getIsApplication(): boolean

Gets whether this media description represents an application stream (media type == "application").

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:736

getIsAudio

▸ getIsAudio(): boolean

Gets whether this media description represents an audio stream (media type == "audio").

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:749

getIsMessage

▸ getIsMessage(): boolean

Gets whether this media description represents a message stream (media type == "message").

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:762

getIsMuted

▸ getIsMuted(): boolean

Gets a value indicating whether this stream is muted. Applies to only media streams.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:775

getIsText

▸ getIsText(): boolean

Gets whether this media description represents a text stream (media type == "text").

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:788

getIsVideo

▸ getIsVideo(): boolean

Gets whether this media description represents a video stream (media type == "video").

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:801

getMaxPacketTimeAttribute

▸ getMaxPacketTimeAttribute(): MaxPacketTimeAttribute

Obtains the maximum packet time attribute.

Returns: MaxPacketTimeAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:813

getMedia

▸ getMedia(): Media

Gets the media name and transport address.

Returns: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:832

getMediaAttributes

▸ getMediaAttributes(): Attribute[]

Gets the array of media-level attributes.

Returns: Attribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:844

getMediaStreamIdentifierAttribute

▸ getMediaStreamIdentifierAttribute(): MediaStreamIdAttribute

Obtains the media stream identifier attribute.

Returns: MediaStreamIdAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:873

getMediaTitle

▸ getMediaTitle(): string

Gets the media title.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:892

getNackFeedbackAttribute

▸ getNackFeedbackAttribute(payloadType: number): FeedbackAttribute

Gets the RTCP "nack" feedback attribute for the given payload type.

Parameters:

Name Type Description
payloadType number The payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:905

getNackPliFeedbackAttribute

▸ getNackPliFeedbackAttribute(payloadType: number): FeedbackAttribute

Gets the RTCP "nack pli" feedback attribute for the given payload type.

Parameters:

Name Type Description
payloadType number The payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:919

getNackRpsiFeedbackAttribute

▸ getNackRpsiFeedbackAttribute(payloadType: number): FeedbackAttribute

Gets the RTCP "nack rpsi" feedback attribute for the given payload type.

Parameters:

Name Type Description
payloadType number The payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:933

getNackSliFeedbackAttribute

▸ getNackSliFeedbackAttribute(payloadType: number): FeedbackAttribute

Gets the RTCP "nack sli" feedback attribute for the given payload type.

Parameters:

Name Type Description
payloadType number The payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:947

getPacketTimeAttribute

▸ getPacketTimeAttribute(): PacketTimeAttribute

Obtains the packet time attribute.

Returns: PacketTimeAttribute

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

getPreferredRtpMapAttributes

▸ getPreferredRtpMapAttributes(): MapAttribute[]

Obtains the RTP map attributes in preference order.

Returns: MapAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:979

getQualityAttribute

▸ getQualityAttribute(): QualityAttribute

Gets the QualityAttribute associated with this MediaDescription.

Returns: QualityAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1009

getRidAttribute

▸ getRidAttribute(rid: string): RidAttribute

Obtains an RID attribute by its RID.

Parameters:

Name Type
rid string

Returns: RidAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1021

getRidAttributes

▸ getRidAttributes(): RidAttribute[]

Obtains the RID attributes.

Returns: RidAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1045

▸ getRidAttributes(direction: string): RidAttribute[]

Obtains the RID attributes.

Parameters:

Name Type Description
direction string The RID attribute direction.

Returns: RidAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1052

getRtcpAttribute

▸ getRtcpAttribute(): Attribute

Gets Rtcp Attributes associated with this media description.

Returns: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1084

getRtcpFeedbackAttribute

▸ getRtcpFeedbackAttribute(payloadType: number, type: string, subType: string): FeedbackAttribute

Gets the RTCP feedback attribute for the given payload type.

Parameters:

Name Type Description
payloadType number The payload type.
type string The type.
subType string The sub-type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1106

getRtcpMultiplexingSupported

▸ getRtcpMultiplexingSupported(): boolean

Gets a value indicating support for RTCP Multiplexing.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1131

getRtpExtMapAttributes

▸ getRtpExtMapAttributes(): Attribute[]

Obtains the RTP ext-map attributes.

Returns: Attribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1162

getRtpMapAttribute

▸ getRtpMapAttribute(formatName: string, clockRate: number): MapAttribute

Obtains the RTP map attribute for a given format.

Parameters:

Name Type Description
formatName string Format name.
clockRate number Clock rate.

Returns: MapAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1180

▸ getRtpMapAttribute(formatName: string, clockRate: number, formatParameters: string): MapAttribute

Obtains the RTP map attribute for a given format.

Parameters:

Name Type Description
formatName string Format name.
clockRate number Clock rate.
formatParameters string Format parameters.

Returns: MapAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1189

▸ getRtpMapAttribute(formatName: string, clockRate: number, formatParameters: string, rtpMapAttributeIndex: Holder<number>): MapAttribute

Obtains the RTP map attribute for a given format.

Parameters:

Name Type Description
formatName string Format name.
clockRate number Clock rate.
formatParameters string Format parameters.
rtpMapAttributeIndex Holder<number> The index of the [[fm.liveswitch.sdp.rtp.mapAttribute]].

Returns: MapAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1199

▸ getRtpMapAttribute(payloadType: number): MapAttribute

Obtains the RTP map attribute for a given payload type.

Parameters:

Name Type Description
payloadType number The payload type.

Returns: MapAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1206

▸ getRtpMapAttribute(payloadType: number, rtpMapAttributeIndex: Holder<number>): MapAttribute

Obtains the RTP map attribute for a given payload type.

Parameters:

Name Type Description
payloadType number The payload type.
rtpMapAttributeIndex Holder<number> The index of the [[fm.liveswitch.sdp.rtp.mapAttribute]].

Returns: MapAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1214

getRtpMapAttributes

▸ getRtpMapAttributes(): MapAttribute[]

Obtains the RTP map attributes.

Returns: MapAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1275

▸ getRtpMapAttributes(formatName: string, clockRate: number, formatParameters: string): MapAttribute[]

Obtains the RTP map attributes for a given format.

Parameters:

Name Type Description
formatName string Format name.
clockRate number Clock rate.
formatParameters string Format parameters.

Returns: MapAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1284

▸ getRtpMapAttributes(formatName: string, clockRate: number, formatParameters: string, rtpMapAttributeIndices: Holder<number[]>): MapAttribute[]

Obtains the RTP map attributes for a given format.

Parameters:

Name Type Description
formatName string Format name.
clockRate number Clock rate.
formatParameters string Format parameters.
rtpMapAttributeIndices Holder<number[]> The indeces of the [[fm.liveswitch.sdp.rtp.mapAttribute]].

Returns: MapAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1294

getSctpMapAttribute

▸ getSctpMapAttribute(): MapAttribute

Gets the Sctp Map Attribute, if it is present in the Media Description.

Returns: MapAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1352

getSctpMaxMessageSizeAttribute

▸ getSctpMaxMessageSizeAttribute(): MaxMessageSizeAttribute

Gets the Sctp Max Message Size Attribute, if it is present in the Media Description.

Returns: MaxMessageSizeAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1371

getSctpPortAttribute

▸ getSctpPortAttribute(): PortAttribute

Gets the Sctp Port Attribute, if it is present in the Media Description.

Returns: PortAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1390

getSetupAttribute

▸ getSetupAttribute(): SetupAttribute

Gets the SetupAttribute associated with this MediaDescription.

Returns: SetupAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1409

getSimulcastAttribute

▸ getSimulcastAttribute(): SimulcastAttribute

Obtains the simulcast attribute.

Returns: SimulcastAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1421

getSsrcAttribute

▸ getSsrcAttribute(ssrc: number, name: string): SsrcAttribute

Obtains the first SSRC attribute matching a given synchronization source and name.

Parameters:

Name Type Description
ssrc number The synchronization source.
name string The attribute name.

Returns: SsrcAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1442

▸ getSsrcAttribute(ssrc: number, name: string, value: string): SsrcAttribute

Obtains the SSRC attribute matching a given synchronization source, name, and value.

Parameters:

Name Type Description
ssrc number The synchronization source.
name string The attribute name.
value string The attribute value.

Returns: SsrcAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1451

getSsrcAttributes

▸ getSsrcAttributes(): SsrcAttribute[]

Obtains the SSRC attributes.

Returns: SsrcAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1481

▸ getSsrcAttributes(name: string): SsrcAttribute[]

Obtains the SSRC attributes.

Parameters:

Name Type Description
name string The SSRC attribute name.

Returns: SsrcAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1488

▸ getSsrcAttributes(ssrc: number): SsrcAttribute[]

Obtains the SSRC attributes matching a given synchronization source.

Parameters:

Name Type Description
ssrc number The synchronization source.

Returns: SsrcAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1495

▸ getSsrcAttributes(ssrc: number, name: string): SsrcAttribute[]

Obtains the SSRC attributes matching a given synchronization source and name.

Parameters:

Name Type Description
ssrc number The synchronization source.
name string The attribute name.

Returns: SsrcAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1503

getSsrcGroupAttributes

▸ getSsrcGroupAttributes(): SsrcGroupAttribute[]

Obtains the SSRC Group attributes.

Returns: SsrcGroupAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1552

getSsrcGroupSsrcs

▸ getSsrcGroupSsrcs(semantics: string): number[]

Obtains the SSRCS from the first SSRC Group with matching semantics.

Parameters:

Name Type
semantics string

Returns: number[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1572

getStreamDirection

▸ getStreamDirection(): StreamDirection

Gets the stream direction indicated in Media Description. Getter returns StreamDirection if DirectionAttribute is present; otherwise, returns StreamDirection.Unset.

Returns: StreamDirection

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1589

getSupportsIce

▸ getSupportsIce(): boolean

Gets a value indicating whether this SDP MediaDescription suggests support for ICE.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1601

getTransportCategoryAttributes

▸ getTransportCategoryAttributes(): Attribute[]

Gets the attributes with Transport Multiplexing Category present in this description.

Returns: Attribute[]

Attributes with Transport Multiplexing Category present in this description.

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1614

getTypeString

▸ getTypeString(): string

Returns: string

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

insertMediaAttribute

▸ insertMediaAttribute(attribute: Attribute, index: number): void

DEPRECATED: Use AddMediaAttribute instead. Inserts a media-level attribute at the given index.

Parameters:

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

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1629

orderFormats

▸ orderFormats(names: string[]): boolean

Orders the formats in preference order.

Parameters:

Name Type Description
names string[] The format names.

Returns: boolean

false if a media element does not exist; otherwise true.

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1653

purgeFormat

▸ purgeFormat(name: string): boolean

Removes a format by name.

Parameters:

Name Type Description
name string The format name.

Returns: boolean

true if the format was found and removed; otherwise, false

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1706

▸ purgeFormat(name: string, clockRate: number): boolean

Removes a format by name and clock rate.

Parameters:

Name Type Description
name string The format name.
clockRate number The clock rate.

Returns: boolean

true if the format was found and removed; otherwise, false

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1715

▸ purgeFormat(name: string, clockRate: number, channelCount: number): boolean

Removes a format by name, clock rate, and channel count.

Parameters:

Name Type Description
name string The format name.
clockRate number The clock rate.
channelCount number The channel count.

Returns: boolean

true if the format was found and removed; otherwise, false

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1725

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/MediaDescription.ts:1801

removeBundleCategoryAttributes

▸ removeBundleCategoryAttributes(): void

Removes Bundle (i.e. Transport and Identical) Category Attributes.

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1813

removeMediaAttribute

▸ removeMediaAttribute(attribute: Attribute): boolean

Removes a media-level attribute.

Parameters:

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

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1838

setConnectionData

▸ setConnectionData(value: ConnectionData): void

Sets media-level connection data.

Parameters:

Name Type
value ConnectionData

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1897

setEncryptionKey

▸ setEncryptionKey(value: EncryptionKey): void

Sets the media-level encryption key.

Parameters:

Name Type
value EncryptionKey

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1909

setFormatParameterValue

▸ setFormatParameterValue(payloadType: number, formatParameterName: string, formatParameterValue: string): boolean

Sets a format parameter value.

Parameters:

Name Type
payloadType number
formatParameterName string
formatParameterValue string

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1921

setIsMuted

▸ setIsMuted(value: boolean): void

Sets a value indicating whether this stream is muted. Applies to only media streams.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1953

setMediaTitle

▸ setMediaTitle(value: string): void

Sets the media title.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1986

setQualityAttribute

▸ setQualityAttribute(value: QualityAttribute): void

Sets the QualityAttribute associated with this MediaDescription.

Parameters:

Name Type
value QualityAttribute

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:1998

setRtcpAttribute

▸ setRtcpAttribute(value: Attribute): void

Sets Rtcp Attributes associated with this media description.

Parameters:

Name Type
value Attribute

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:2010

setRtcpMultiplexingSupported

▸ setRtcpMultiplexingSupported(value: boolean): void

Sets a value indicating support for RTCP Multiplexing.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:2022

setSetupAttribute

▸ setSetupAttribute(value: SetupAttribute): void

Sets the SetupAttribute associated with this MediaDescription.

Parameters:

Name Type
value SetupAttribute

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:2043

setStreamDirection

▸ setStreamDirection(value: StreamDirection): void

Sets the stream direction indicated in Media Description. Getter returns StreamDirection if DirectionAttribute is present; otherwise, returns StreamDirection.Unset.

Parameters:

Name Type
value StreamDirection

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:2055

toString

▸ toString(): string

Converts this instance to a string.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:2068

tryAddContentAttribute

▸ tryAddContentAttribute(contentAttribute: ContentAttribute): boolean

Adds a content attribute if not already present.

Parameters:

Name Type Description
contentAttribute ContentAttribute The content attribute.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:2111

updateQualityAttributeValue

▸ updateQualityAttributeValue(quality: number): void

Updates SDP Quality Attribute associated with this media description if one is present. Otherwise, creates a new one and inserts it into this media description.

Parameters:

Name Type
quality number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:2129

parse

▸ Staticparse(s: string): MediaDescription

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

Parameters:

Name Type Description
s string The string to parse.

Returns: MediaDescription

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaDescription.ts:284