/ fm / liveswitch / LogContext

Class: LogContext

fm.liveswitch.LogContext

LogContext structure to hold ambient properties that can be attached to log events.

Table of contents

Constructors

• constructor

Methods

• clone
• getApplicationId
• getBundleTransportId
• getCandidateId
• getCandidatePairId
• getChannelId
• getClientId
• getClusterConnectionId
• getClusterSocketId
• getConnectionId
• getDeviceId
• getDtlsTransportId
• getExternalConnectionId
• getGatewayId
• getGathererId
• getIceTransportId
• getLabel
• getMediaDescriptionManagerId
• getMediaPipeId
• getMediaServerId
• getMediaSourceId
• getRemoteConnectionId
• getRemoteMediaServerId
• getRtpPacketId
• getRtpReceiverId
• getRtpSenderId
• getRtpTransportId
• getSctpTrasnportId
• getSiteId
• getSocketManagerId
• getStreamId
• getTypeString
• getUserId
• getWebSocketMediaServerConnectionId
• getWebSocketMediaServerId
• getWebhookUrl
• setApplicationId
• setBundleTransportId
• setCandidateId
• setCandidatePairId
• setChannelId
• setClientId
• setClusterConnectionId
• setClusterSocketId
• setConnectionId
• setDeviceId
• setDtlsTransportId
• setExternalConnectionId
• setGatewayId
• setGathererId
• setIceTransportId
• setLabel
• setMediaDescriptionManagerId
• setMediaPipeId
• setMediaServerId
• setMediaSourceId
• setRemoteConnectionId
• setRemoteMediaServerId
• setRtpPacketId
• setRtpReceiverId
• setRtpSenderId
• setRtpTransportId
• setSctpTrasnportId
• setSiteId
• setSocketManagerId
• setStreamId
• setUserId
• setWebSocketMediaServerConnectionId
• setWebSocketMediaServerId
• setWebhookUrl
• toPairArray
• fromJson

Constructors

constructor

+ new LogContext(): LogContext

Returns: LogContext

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:147

Methods

clone

▸ clone(): LogContext

Clones this object, creating a new instance with the same property values.

Returns: LogContext

A new LogContext instance with the same properties as this instance.

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:325

---

getApplicationId

▸ getApplicationId(): string

Gets the application Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:372

---

getBundleTransportId

▸ getBundleTransportId(): string

Gets the bundle transport Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:384

---

getCandidateId

▸ getCandidateId(): string

Gets the candidate Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:396

---

getCandidatePairId

▸ getCandidatePairId(): string

Gets the candidate pair Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:408

---

getChannelId

▸ getChannelId(): string

Gets the channel Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:420

---

getClientId

▸ getClientId(): string

Gets the client Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:432

---

getClusterConnectionId

▸ getClusterConnectionId(): string

Gets cluster connection Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:444

---

getClusterSocketId

▸ getClusterSocketId(): string

Gets the cluster socket id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:456

---

getConnectionId

▸ getConnectionId(): string

Gets the connection Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:468

---

getDeviceId

▸ getDeviceId(): string

Gets the device Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:480

---

getDtlsTransportId

▸ getDtlsTransportId(): string

Gets DTLS Transport Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:492

---

getExternalConnectionId

▸ getExternalConnectionId(): string

Gets the external connection Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:504

---

getGatewayId

▸ getGatewayId(): string

Gets the gateway Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:516

---

getGathererId

▸ getGathererId(): string

Gets the gatherer Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:528

---

getIceTransportId

▸ getIceTransportId(): string

Gets the Ice transport Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:540

---

getLabel

▸ getLabel(): string

Gets the Label.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:552

---

getMediaDescriptionManagerId

▸ getMediaDescriptionManagerId(): string

Gets the media description manager Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:564

---

getMediaPipeId

▸ getMediaPipeId(): string

Gets the Media Pipe Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:576

---

getMediaServerId

▸ getMediaServerId(): string

Gets the media server Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:588

---

getMediaSourceId

▸ getMediaSourceId(): string

Gets the media source Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:600

---

getRemoteConnectionId

▸ getRemoteConnectionId(): string

Gets the remote connection Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:612

---

getRemoteMediaServerId

▸ getRemoteMediaServerId(): string

Gets the remote media server Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:624

---

getRtpPacketId

▸ getRtpPacketId(): string

Gets RTP packet Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:636

---

getRtpReceiverId

▸ getRtpReceiverId(): string

Gets RTP Receiver Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:648

---

getRtpSenderId

▸ getRtpSenderId(): string

Gets RTP Sender Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:660

---

getRtpTransportId

▸ getRtpTransportId(): string

Gets RTP Transport Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:672

---

getSctpTrasnportId

▸ getSctpTrasnportId(): string

Gets the Sctp transport Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:684

---

getSiteId

▸ getSiteId(): string

Gets the site Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:696

---

getSocketManagerId

▸ getSocketManagerId(): string

Gets the socket manager Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:708

---

getStreamId

▸ getStreamId(): string

Gets the stream Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:720

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:9

---

getUserId

▸ getUserId(): string

Gets the user Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:732

---

getWebSocketMediaServerConnectionId

▸ getWebSocketMediaServerConnectionId(): string

Gets the WSMS Connection ID.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:756

---

getWebSocketMediaServerId

▸ getWebSocketMediaServerId(): string

Gets the websocket media server Id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:768

---

getWebhookUrl

▸ getWebhookUrl(): string

Gets the Webhook URL.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:744

---

setApplicationId

▸ setApplicationId(value: string): void

Sets the application Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:780

---

setBundleTransportId

▸ setBundleTransportId(value: string): void

Sets the bundle transport Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:792

---

setCandidateId

▸ setCandidateId(value: string): void

Sets the candidate Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:804

---

setCandidatePairId

▸ setCandidatePairId(value: string): void

Sets the candidate pair Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:816

---

setChannelId

▸ setChannelId(value: string): void

Sets the channel Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:828

---

setClientId

▸ setClientId(value: string): void

Sets the client Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:840

---

setClusterConnectionId

▸ setClusterConnectionId(value: string): void

Sets cluster connection Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:852

---

setClusterSocketId

▸ setClusterSocketId(value: string): void

Sets the cluster socket id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:864

---

setConnectionId

▸ setConnectionId(value: string): void

Sets the connection Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:876

---

setDeviceId

▸ setDeviceId(value: string): void

Sets the device Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:888

---

setDtlsTransportId

▸ setDtlsTransportId(value: string): void

Sets DTLS Transport Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:900

---

setExternalConnectionId

▸ setExternalConnectionId(value: string): void

Sets the external connection Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:912

---

setGatewayId

▸ setGatewayId(value: string): void

Sets the gateway Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:924

---

setGathererId

▸ setGathererId(value: string): void

Sets the gatherer Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:936

---

setIceTransportId

▸ setIceTransportId(value: string): void

Sets the Ice transport Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:948

---

setLabel

▸ setLabel(value: string): void

Sets the Label.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:960

---

setMediaDescriptionManagerId

▸ setMediaDescriptionManagerId(value: string): void

Sets the media description manager Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:972

---

setMediaPipeId

▸ setMediaPipeId(value: string): void

Sets the Media Pipe Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:984

---

setMediaServerId

▸ setMediaServerId(value: string): void

Sets the media server Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:996

---

setMediaSourceId

▸ setMediaSourceId(value: string): void

Sets the media source Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1008

---

setRemoteConnectionId

▸ setRemoteConnectionId(value: string): void

Sets the remote connection Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1020

---

setRemoteMediaServerId

▸ setRemoteMediaServerId(value: string): void

Sets the remote media server Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1032

---

setRtpPacketId

▸ setRtpPacketId(value: string): void

Sets RTP packet Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1044

---

setRtpReceiverId

▸ setRtpReceiverId(value: string): void

Sets RTP Receiver Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1056

---

setRtpSenderId

▸ setRtpSenderId(value: string): void

Sets RTP Sender Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1068

---

setRtpTransportId

▸ setRtpTransportId(value: string): void

Sets RTP Transport Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1080

---

setSctpTrasnportId

▸ setSctpTrasnportId(value: string): void

Sets the Sctp transport Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1092

---

setSiteId

▸ setSiteId(value: string): void

Sets the site Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1104

---

setSocketManagerId

▸ setSocketManagerId(value: string): void

Sets the socket manager Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1116

---

setStreamId

▸ setStreamId(value: string): void

Sets the stream Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1128

---

setUserId

▸ setUserId(value: string): void

Sets the user Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1140

---

setWebSocketMediaServerConnectionId

▸ setWebSocketMediaServerConnectionId(value: string): void

Sets the WSMS Connection ID.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1164

---

setWebSocketMediaServerId

▸ setWebSocketMediaServerId(value: string): void

Sets the websocket media server Id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1176

---

setWebhookUrl

▸ setWebhookUrl(value: string): void

Sets the Webhook URL.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1152

---

toPairArray

▸ toPairArray(): string[][]

Returns a paired array rerpresentation of this log context.

Returns: string[][]

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:1188

---

fromJson

▸ StaticfromJson(valueJson: string): LogContext

Deserializes json into a LogContext object.

Parameters:

Name	Type	Description
valueJson	string	Value to deserialize

Returns: LogContext

Logcontext

Defined in: Generated/TypeScript/fm.liveswitch/LogContext.ts:168