/ fm / liveswitch / sdp / Media
Class: Media
liveswitch.sdp.Media
An SDP media element.
Hierarchy
Table of contents
Constructors
Methods
- fmliveswitchsdpMediaInit
- getFormatDescription
- getMediaType
- getNumberOfPorts
- getTransportPort
- getTransportProtocol
- getTypeString
- setFormatDescription
- setMediaType
- setNumberOfPorts
- setTransportPort
- setTransportProtocol
- toString
- parse
Constructors
constructor
+ new Media(): Media
Initializes a new instance of the [[fm.liveswitch.sdp.media]] class.
Returns: Media
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:29
+ new Media(mediaType
: string, transportPort
: number, transportProtocol
: string): Media
Initializes a new instance of the [[fm.liveswitch.sdp.media]] class.
Parameters:
Name | Type | Description |
---|---|---|
mediaType |
string | The media type. See [[fm.liveswitch.sdp.media.mediaType]] for possible values. |
transportPort |
number | The transport port. |
transportProtocol |
string | The transport protocol. |
Returns: Media
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:35
+ new Media(mediaType
: string, transportPort
: number, transportProtocol
: string, formatDescription
: string): Media
Initializes a new instance of the [[fm.liveswitch.sdp.media]] class.
Parameters:
Name | Type | Description |
---|---|---|
mediaType |
string | The media type. See [[fm.liveswitch.sdp.media.mediaType]] for possible values. |
transportPort |
number | The transport port. |
transportProtocol |
string | The transport protocol. |
formatDescription |
string | The format description. |
Returns: Media
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:44
Methods
fmliveswitchsdpMediaInit
▸ Private
fmliveswitchsdpMediaInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:25
getFormatDescription
▸ getFormatDescription(): string
Gets the format description.
Returns: string
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
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:178
getNumberOfPorts
▸ getNumberOfPorts(): number
Gets the number of ports.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:190
getTransportPort
▸ getTransportPort(): number
Gets the transport port.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:202
getTransportProtocol
▸ getTransportProtocol(): string
Gets the transport protocol.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:214
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:9
setFormatDescription
▸ setFormatDescription(value
: string): void
Sets the format description.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
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
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
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
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
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:276
toString
▸ toString(): string
Converts this instance to a string.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:288
parse
▸ Static
parse(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
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Media.ts:121