/ fm / liveswitch / sdp / Origin
Class: Origin
liveswitch.sdp.Origin
An SDP origin element.
Table of contents
Constructors
Methods
- fmliveswitchsdpOriginInit
- getAddressType
- getNetworkType
- getSessionId
- getSessionVersion
- getTypeString
- getUnicastAddress
- getUsername
- setAddressType
- setNetworkType
- setSessionId
- setSessionVersion
- setUnicastAddress
- setUsername
- toString
- parse
Constructors
constructor
+ new Origin(unicastAddress
: string): Origin
Initializes a new instance of the [[fm.liveswitch.sdp.origin]] class.
Parameters:
Name | Type | Description |
---|---|---|
unicastAddress |
string | The address of the machine from which the session was created. |
Returns: Origin
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:29
+ new Origin(unicastAddress
: string, username
: string): Origin
Initializes a new instance of the [[fm.liveswitch.sdp.origin]] class.
Parameters:
Name | Type | Description |
---|---|---|
unicastAddress |
string | The address of the machine from which the session was created. |
username |
string | The user's login on the originating host. |
Returns: Origin
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:36
Methods
fmliveswitchsdpOriginInit
▸ Private
fmliveswitchsdpOriginInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:25
getAddressType
▸ getAddressType(): string
Gets the type of the address. See [[fm.liveswitch.sdp.origin.addressType]] for possible values.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:131
getNetworkType
▸ getNetworkType(): string
Gets the type of network. See [[fm.liveswitch.sdp.origin.networkType]] for possible values.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:143
getSessionId
▸ getSessionId(): number
Gets the globally unique identifier for the session.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:155
getSessionVersion
▸ getSessionVersion(): number
Gets the version number for the session.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:167
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:9
getUnicastAddress
▸ getUnicastAddress(): string
Gets the address of the machine from which the session was created.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:179
getUsername
▸ getUsername(): string
Gets the user's login on the originating host.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:191
setAddressType
▸ setAddressType(value
: string): void
Sets the type of the address. See [[fm.liveswitch.sdp.origin.addressType]] for possible values.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:203
setNetworkType
▸ setNetworkType(value
: string): void
Sets the type of network. See [[fm.liveswitch.sdp.origin.networkType]] for possible values.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:215
setSessionId
▸ setSessionId(value
: number): void
Sets the globally unique identifier for the session.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:227
setSessionVersion
▸ setSessionVersion(value
: number): void
Sets the version number for the session.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:240
setUnicastAddress
▸ setUnicastAddress(value
: string): void
Sets the address of the machine from which the session was created.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:253
setUsername
▸ setUsername(value
: string): void
Sets the user's login on the originating host.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:265
toString
▸ toString(): string
Converts this instance to a string.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:277
parse
▸ Static
parse(s
: string): Origin
Creates an [[fm.liveswitch.sdp.origin]] instance from a string.
Parameters:
Name | Type | Description |
---|---|---|
s |
string | The string to parse. |
Returns: Origin
Defined in: Generated/TypeScript/fm.liveswitch/sdp/Origin.ts:95