/ fm / liveswitch / StreamDirectionHelper
Class: StreamDirectionHelper
fm.liveswitch.StreamDirectionHelper
Class containing utility methods to manipulate [[fm.liveswitch.streamDirection]].
Table of contents
Constructors
Methods
- getTypeString
- directionFromString
- directionToString
- isReceiveDisabled
- isSendDisabled
- setReceiveDisabled
- setSendDisabled
- toggleReceive
- toggleSend
Constructors
constructor
+ new StreamDirectionHelper(): StreamDirectionHelper
Returns: StreamDirectionHelper
Defined in: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:11
Methods
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:9
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: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:30
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: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:62
isReceiveDisabled
▸ StaticisReceiveDisabled(direction: StreamDirection): boolean
Checks the receive flag.
Parameters:
| Name | Type | Description |
|---|---|---|
direction |
StreamDirection | The direction. |
Returns: boolean
The receive flag.
Defined in: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:88
▸ StaticisReceiveDisabled(directionString: string): boolean
Checks the receive flag.
Parameters:
| Name | Type | Description |
|---|---|---|
directionString |
string | The direction string. |
Returns: boolean
The receive flag.
Defined in: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:96
isSendDisabled
▸ StaticisSendDisabled(direction: StreamDirection): boolean
Checks the send flag.
Parameters:
| Name | Type | Description |
|---|---|---|
direction |
StreamDirection | The direction. |
Returns: boolean
The send flag.
Defined in: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:115
▸ StaticisSendDisabled(directionString: string): boolean
Checks the send flag.
Parameters:
| Name | Type | Description |
|---|---|---|
directionString |
string | The direction string. |
Returns: boolean
The send flag.
Defined in: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:123
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: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:143
▸ 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: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:152
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: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:174
▸ 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: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:183
toggleReceive
▸ StatictoggleReceive(direction: StreamDirection): StreamDirection
Toggles the receive flag.
Parameters:
| Name | Type | Description |
|---|---|---|
direction |
StreamDirection | The direction. |
Returns: StreamDirection
The new direction.
Defined in: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:204
▸ StatictoggleReceive(directionString: string): string
Toggles the receive flag.
Parameters:
| Name | Type | Description |
|---|---|---|
directionString |
string | The direction string. |
Returns: string
The new direction.
Defined in: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:212
toggleSend
▸ StatictoggleSend(direction: StreamDirection): StreamDirection
Toggles the send flag.
Parameters:
| Name | Type | Description |
|---|---|---|
direction |
StreamDirection | The direction. |
Returns: StreamDirection
The new direction.
Defined in: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:243
▸ StatictoggleSend(directionString: string): string
Toggles the send flag.
Parameters:
| Name | Type | Description |
|---|---|---|
directionString |
string | The direction string. |
Returns: string
The new direction.
Defined in: Generated/TypeScript/fm.liveswitch/StreamDirectionHelper.ts:251