/ fm / liveswitch / StreamDirectionHelper

Class: StreamDirectionHelper

fm.liveswitch.StreamDirectionHelper

Class containing utility methods to manipulate [[fm.liveswitch.streamDirection]].

Table of contents

Constructors

• constructor

Methods

• getTypeString
• directionFromString
• directionToString
• isReceiveDisabled
• isSendDisabled
• setReceiveDisabled
• setSendDisabled
• toggleReceive
• toggleSend

Constructors

constructor

+ new StreamDirectionHelper(): StreamDirectionHelper

Returns: StreamDirectionHelper

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

Methods

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:7

---

directionFromString

▸ StaticdirectionFromString(directionString: string): StreamDirection

Converts string representations of stream directions to [[fm.liveswitch.streamDirection]].

Parameters:

Name	Type	Description
directionString	string	The direction string.

Returns: StreamDirection

The direction.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:26

---

directionToString

▸ StaticdirectionToString(direction: StreamDirection): string

Obtains the string representation of [[fm.liveswitch.streamDirection]].

Parameters:

Name	Type	Description
direction	StreamDirection	The direction.

Returns: string

The direction string.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:56

---

isReceiveDisabled

▸ StaticisReceiveDisabled(direction: StreamDirection): boolean

Checks the receive flag.

Parameters:

Name	Type	Description
direction	StreamDirection	The direction.

Returns: boolean

The receive flag.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:80

▸ StaticisReceiveDisabled(directionString: string): boolean

Checks the receive flag.

Parameters:

Name	Type	Description
directionString	string	The direction string.

Returns: boolean

The receive flag.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:86

---

isSendDisabled

▸ StaticisSendDisabled(direction: StreamDirection): boolean

Checks the send flag.

Parameters:

Name	Type	Description
direction	StreamDirection	The direction.

Returns: boolean

The send flag.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:103

▸ StaticisSendDisabled(directionString: string): boolean

Checks the send flag.

Parameters:

Name	Type	Description
directionString	string	The direction string.

Returns: boolean

The send flag.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:109

---

setReceiveDisabled

▸ StaticsetReceiveDisabled(direction: StreamDirection, disabled: boolean): StreamDirection

Sets the receive flag.

Parameters:

Name	Type	Description
direction	StreamDirection	The direction.
disabled	boolean	Whether to disable the receive flag.

Returns: StreamDirection

The new direction.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:127

▸ StaticsetReceiveDisabled(directionString: string, disabled: boolean): string

Sets the receive flag.

Parameters:

Name	Type	Description
directionString	string	The direction string.
disabled	boolean	Whether to disable the receive flag.

Returns: string

The new direction.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:134

---

setSendDisabled

▸ StaticsetSendDisabled(direction: StreamDirection, disabled: boolean): StreamDirection

Sets the send flag.

Parameters:

Name	Type	Description
direction	StreamDirection	The direction.
disabled	boolean	Whether to disable the send flag.

Returns: StreamDirection

The new direction.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:154

▸ StaticsetSendDisabled(directionString: string, disabled: boolean): string

Sets the send flag.

Parameters:

Name	Type	Description
directionString	string	The direction string.
disabled	boolean	Whether to disable the send flag.

Returns: string

The new direction.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:161

---

toggleReceive

▸ StatictoggleReceive(direction: StreamDirection): StreamDirection

Toggles the receive flag.

Parameters:

Name	Type	Description
direction	StreamDirection	The direction.

Returns: StreamDirection

The new direction.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:180

▸ StatictoggleReceive(directionString: string): string

Toggles the receive flag.

Parameters:

Name	Type	Description
directionString	string	The direction string.

Returns: string

The new direction.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:186

---

toggleSend

▸ StatictoggleSend(direction: StreamDirection): StreamDirection

Toggles the send flag.

Parameters:

Name	Type	Description
direction	StreamDirection	The direction.

Returns: StreamDirection

The new direction.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:215

▸ StatictoggleSend(directionString: string): string

Toggles the send flag.

Parameters:

Name	Type	Description
directionString	string	The direction string.

Returns: string

The new direction.

Defined in: fm/Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:221