/ fm / liveswitch / sdp / sctp / Media

Class: Media

sdp.sctp.Media

An SDP media description with a transport protocol of "RTP/AVP" or "RTP/SAVP".

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

+ new Media(mediaType: string, transportPort: number, transportProtocol: string, associationUsage: string): Media

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

Parameters:

Name Type Description
mediaType string The media type. See [[fm.liveswitch.sdp.mediaType]] for possible values.
transportPort number The transport port.
transportProtocol string The transport protocol.
associationUsage string The association usage.

Returns: Media

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/Media.ts:12

Methods

getFormatDescription

▸ getFormatDescription(): string

Gets the format description.

Returns: string

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:166

getMediaType

▸ getMediaType(): string

Gets the media type. See [[fm.liveswitch.sdp.media.mediaType]] for possible values.

Returns: string

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:178

getNumberOfPorts

▸ getNumberOfPorts(): number

Gets the number of ports.

Returns: number

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:190

getTransportPort

▸ getTransportPort(): number

Gets the transport port.

Returns: number

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:202

getTransportProtocol

▸ getTransportProtocol(): string

Gets the transport protocol.

Returns: string

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:214

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/Media.ts:10

setFormatDescription

▸ setFormatDescription(value: string): void

Sets the format description.

Parameters:

Name Type
value string

Returns: void

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:226

setMediaType

▸ setMediaType(value: string): void

Sets the media type. See [[fm.liveswitch.sdp.media.mediaType]] for possible values.

Parameters:

Name Type
value string

Returns: void

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:238

setNumberOfPorts

▸ setNumberOfPorts(value: number): void

Sets the number of ports.

Parameters:

Name Type
value number

Returns: void

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:250

setTransportPort

▸ setTransportPort(value: number): void

Sets the transport port.

Parameters:

Name Type
value number

Returns: void

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:263

setTransportProtocol

▸ setTransportProtocol(value: string): void

Sets the transport protocol.

Parameters:

Name Type
value string

Returns: void

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:276

toString

▸ toString(): string

Converts this instance to a string.

Returns: string

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:288

getDtlsSctpTransportProtocol

▸ StaticgetDtlsSctpTransportProtocol(): string

Gets the protocol keyword for the SCTP over DTLS data profile.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/Media.ts:46

getSctpDtlsTransportProtocol

▸ StaticgetSctpDtlsTransportProtocol(): string

Gets the protocol keyword for the DTLS over SCTP data profile.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/Media.ts:58

getSctpTransportProtocol

▸ StaticgetSctpTransportProtocol(): string

Gets the protocol keyword for the SCTP data profile.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/Media.ts:70

getTcpDtlsSctpTransportProtocol

▸ StaticgetTcpDtlsSctpTransportProtocol(): string

Gets the protocol keyword for the SCTP over DTLS over TCP data profile.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/Media.ts:82

getUdpDtlsSctpTransportProtocol

▸ StaticgetUdpDtlsSctpTransportProtocol(): string

Gets the protocol keyword for the SCTP over DTLS over UDP data profile.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/Media.ts:94

getWebRtcDatachannelAssociationUsage

▸ StaticgetWebRtcDatachannelAssociationUsage(): string

Gets the Association Usage name registry for WebRTC Datachannel.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/Media.ts:106

isSupported

▸ StaticisSupported(protocol: string): boolean

Returns a value indicating whther a given protocol is supported.

Parameters:

Name Type Description
protocol string Protocol keyword.

Returns: boolean

Value indicating whther a given protocol is supported.

Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/Media.ts:120

parse

▸ Staticparse(s: string): Media

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

Parameters:

Name Type Description
s string The string to parse.

Returns: Media

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:121

supportsEncryption

▸ StaticsupportsEncryption(protocol: string): boolean

Returns a value indicating whther a given protocol supports encryption.

Parameters:

Name Type Description
protocol string Protocol keyword.

Returns: boolean

Value indicating whther a given protocol supports encryption.

Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/Media.ts:134