/ fm / liveswitch / sdp / UdpMedia

Class: UdpMedia

liveswitch.sdp.UdpMedia

An SDP media description with a transport protocol of "udp".

Hierarchy

• Media

  ↳ UdpMedia

Table of contents

Constructors

• constructor

Methods

• getFormatDescription
• getMediaType
• getNumberOfPorts
• getTransportPort
• getTransportProtocol
• getTypeString
• setFormatDescription
• setMediaType
• setNumberOfPorts
• setTransportPort
• setTransportProtocol
• toString
• getUdpTransportProtocol
• parse

Constructors

constructor

+ new UdpMedia(mediaType: string, transportPort: number, formatDescription: string): UdpMedia

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

Parameters:

Name	Type	Description
mediaType	string	The media type. See [[fm.liveswitch.sdp.mediaType]] for possible values.
transportPort	number	The transport port.
formatDescription	string	The format description.

Returns: UdpMedia

Inherited from: Media

Defined in: Generated/TypeScript/fm.liveswitch/sdp/UdpMedia.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/UdpMedia.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

---

getUdpTransportProtocol

▸ StaticgetUdpTransportProtocol(): string

Gets the protocol keyword for UDP.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/UdpMedia.ts:40

---

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