Members

# constant openWebpage

Opens a webpage in the default browser.

View Source sharedUtilities/openWebpage.tsx, line 7

Methods

# ApplicationView() → {React.Component}

Represents the ApplicationView component.

View Source ApplicationView.tsx, line 34

Returns:

The rendered ApplicationView component.

Type: React.Component

# MinimalView() → {React.Element}

Creates a minimal view component.

View Source Elements/Actionbars/MinimalView.tsx, line 10

Returns:

A React component representing the minimal view.

Type: React.Element

# SourceItem(props) → {JSX.Element}

Represents a source item.

Parameters:

Name	Type	Description
`props`	`Object`	The properties for the source item.
`item`	`Electron.DesktopCapturerSource`	The Electron desktop capturer source for the item.
`selectedSource`	`string` \| `undefined`	The ID of the selected source, or undefined if none selected.
`onClick`	`function`	The function to be called when the item is clicked.

View Source Elements/SourceItem.tsx, line 3

Returns:

- The rendered source item component.

Type: JSX.Element

# TopAppBar() → {JSX.Element}

React functional component representing the top app bar.

View Source Elements/Actionbars/TopAppBar.tsx, line 12

Returns:

The top app bar component.

Type: JSX.Element

# Webcam(param) → {React.Element}

Renders a webcam component with a video and canvas element.

Parameters:

Name	Type	Description
`param`	`Object`	The configuration object.
`webCamRef`	`React.RefObject.<any>`	The React ref object used to access the video element.
`canvasRef`	`React.RefObject.<any>`	The React ref object used to access the canvas element.

View Source Elements/Webcam.tsx, line 12

Returns:

The webcam component.

Type: React.Element

# async createAction(action) → {Promise}

Creates an action using the provided attributes.

Parameters:

Name	Type	Description
`action`	`ActionCreationAttributes`	The attributes of the action to be created.

View Source modelApi/action.ts, line 29

Returns:

- A promise that resolves with the created action.

Type: Promise

# async createGesture(gesture, actions) → {Promise}

Creates a new gesture by invoking the 'create-gesture' method in ipcRenderer with the provided gesture and actions.

Parameters:

Name	Type	Description
`gesture`	`GestureCreationAttributes`	The details of the gesture to be created.
`actions`	`Array.<ActionType>`	The list of actions associated with the gesture.

View Source modelApi/gesture.ts, line 28

Returns:

- A promise that resolves with the result of invoking 'create-gesture' method.

Type: Promise

# async deleteAction(id) → {Promise.<void>}

Deletes an action with the specified ID.

Parameters:

Name	Type	Description
`id`	`number`	The ID of the action to delete.

View Source modelApi/action.ts, line 48

Returns:

- A promise that resolves when the action is deleted successfully.

Type: Promise.<void>

# async deleteGesture(id) → {Promise.<void>}

Delete a gesture.

Parameters:

Name	Type	Description
`id`	`number`	The ID of the gesture to delete.

View Source modelApi/gesture.ts, line 50

Returns:

- A Promise that resolves when the gesture is deleted.

Type: Promise.<void>

# formatTime(timeInSeconds) → {string}

A function that formats time in seconds into a string representation of minutes and seconds in the format "MM:SS".

Parameters:

Name	Type	Description
`timeInSeconds`	`*`	The time in seconds.

View Source sharedUtilities/formatTime.tsx, line 8

Returns:

- The formatted time string in the format "MM:SS".

Type: string

# async getAction(id) → {Promise}

Performs an asynchronous operation to get the action with the specified ID.

Parameters:

Name	Type	Description
`id`	`number`	The ID of the action to retrieve.

View Source modelApi/action.ts, line 19

Returns:

- A Promise that resolves with the retrieved action.

Type: Promise

# async getAllActions() → {Promise.<Array>}

Retrieves all actions.

View Source modelApi/action.ts, line 3

Returns:

A promise that resolves to an array of actions.

Type: Promise.<Array>

# async getAllGestures() → {Promise.<Array>}

Retrieves all the gestures from the renderer process.

View Source modelApi/gesture.ts, line 9

Returns:

A promise that resolves to an array of all gestures.

Type: Promise.<Array>

# async getGesture(id) → {Promise}

Retrieves a gesture based on the provided ID.

Parameters:

Name	Type	Description
`id`	`number`	The ID of the gesture to retrieve.

View Source modelApi/gesture.ts, line 18

Returns:

Returns a promise that resolves with the gesture object.

Type: Promise

# async pressKey(data) → {Promise.<void>}

Function to press a key using the ipcRenderer.invoke method.

Parameters:

Name	Type	Description
`data`	`any`	The data to be passed to the 'pressKey' action.

View Source AI/executeActions.tsx, line 62

Returns:

- A Promise that resolves with no value on success, or rejects with an error on failure.

Type: Promise.<void>

# async releaseKey(data) → {Promise.<void>}

Release a key using the provided data.

Parameters:

Name	Type	Description
`data`	`*`	The data required to release the key.

View Source AI/executeActions.tsx, line 78

Returns:

- A promise that resolves when the key is successfully released.

Type: Promise.<void>

# async updateAction(id, action) → {Promise.<void>}

Updates an action with the given id and action attributes.

Parameters:

Name	Type	Description
`id`	`number`	The id of the action to update.
`action`	`ActionCreationAttributes`	The updated attributes of the action.

View Source modelApi/action.ts, line 39

Returns:

- A Promise that resolves when the action is successfully updated.

Type: Promise.<void>

# async updateGesture(id, gesture, actions) → {Promise.<any>}

Updates a gesture with specified id, gesture attributes, and actions.

Parameters:

Name	Type	Description
`id`	`number`	The id of the gesture to be updated.
`gesture`	`GestureCreationAttributes`	The updated attributes for the gesture.
`actions`	`Array.<ActionType>`	The updated actions for the gesture.

View Source modelApi/gesture.ts, line 40

Returns:

- A promise that resolves to the result of the update operation.

Type: Promise.<any>

Type Definitions

Type: Object

# ActionsDataContextType

Represents a data context type for actions.

Properties:

Name	Type	Description
`actionData`	`Array.<TriggerData>` \| `undefined`	The action data.
`setActionData`	`React.Dispatch.<React.SetStateAction.<(Array.<TriggerData>\|undefined)>>` \| `undefined`	A function to set the action data.
`gestureData`	`Array.<any>` \| `undefined`	The gesture data.
`setGestureData`	`React.Dispatch.<React.SetStateAction.<(Array.<any>\|undefined)>>` \| `undefined`	A function to set the gesture data.
`forceRender`	`any`	Used to trigger a re-render of the component.
`actionData`	`Array` \| `undefined`
`setActionData`	`React.Dispatch.<React.SetStateAction.<(Array.<TriggerData>\|undefined)>>` \| `undefined`
`gestureData`	`Array` \| `undefined`
`setGestureData`	`React.Dispatch.<React.SetStateAction.<(Array.<any>\|undefined)>>` \| `undefined`
`forceRender`	`any`

View Source App.tsx, line 151

Type: Object

# ActionsDataContextType

Properties:

Name	Type	Description
`actionData`	`*`	The action data.
`setActionData`	`function`	A function to set the action data.
`gestureData`	`*`	The gesture data.
`setGestureData`	`function`	A function to set the gesture data.
`forceRender`	`function`	A function to force render.

View Source App.tsx, line 7

Type: Object

# FaceDetectionContext

Represents the context for face detection.

Properties:

Name	Type	Description
`faceDetection`	`boolean`	determines if face detection is enabled or disabled.
`setFaceDetection`	`function`	function to set the value of faceDetection.

View Source App.tsx, line 84

Type: Object

# FaceDetectionContextType

Represents the context type for face detection feature.

Properties:

Name	Type	Description
`faceDetection`	`boolean`	Indicates whether face detection is enabled or not.
`setFaceDetection`	`React.Dispatch.<React.SetStateAction.<boolean>>`	A function to update the state of face detection.
`faceDetection`	`boolean`
`setFaceDetection`	`React.Dispatch.<React.SetStateAction.<boolean>>`

View Source App.tsx, line 202

Type: Object

# FaceMeshContextType

Represents the context type for managing the face mesh state.

Properties:

Name	Type	Description
`mesh`	`boolean`	The current face mesh state.
`setMesh`	`React.Dispatch.<React.SetStateAction.<boolean>>`	Function to update the face mesh state.
`mesh`	`boolean`
`setMesh`	`React.Dispatch.<React.SetStateAction.<boolean>>`

View Source App.tsx, line 193

Type: Object

# Gesture

Represents gesture data.

Properties:

Name	Type	Description
`name`	`string`	The name of the gesture.
`value`	`string`	The value associated with the gesture.

View Source staticData/gestureData.tsx, line 2

Type: Object

# InputProps

Represents the input properties for a form field.

Properties:

Name	Type	Attributes	Description
`initial`	`string`	<optional>	The initial value for the input field.
`required`	`boolean`	<optional>	Indicates if the input field is required.
`initial`	`string`	<optional>
`required`	`boolean`	<optional>

View Source Elements/useInputs/useSelectInput.tsx, line 42

Type: Object

# InputProps

Represents the properties for the Input component.

Properties:

Name	Type	Attributes	Description
`initial`	`string`	<optional>	The initial value of the input.
`required`	`boolean`	<optional>	Indicates whether the input is required or not.
`placeholder`	`string`	<optional>	The placeholder text for the input.
`unit`	`string`	<optional>	The unit of measurement for the input value.
`initial`	`string`	<optional>
`required`	`boolean`	<optional>
`placeholder`	`string`	<optional>
`unit`	`string`	<optional>

View Source Elements/useInputs/useStringInput.tsx, line 51

Type: object

# InputTypeInput

Represents an input type

Properties:

Name	Type	Attributes	Description
`element`	`JSX.Element`		The JSX element representing the input
`value`	`any`		The value of the input
`clear`	`function`		Clears the input value
`key`	`string`		The key used to identify the input
`isValid`	`boolean`	<optional>	Optional property indicating if the input is valid
`element`	`React.JSX.Element`
`value`	`any`
`clear`	`function`
`key`	`string`
`isValid`	`boolean`	<optional>

View Source sharedUtilities/inputsToJson.tsx, line 27

Type: Object

# MeshContext

Represents the context for manipulating a face mesh.

Properties:

Name	Type	Description
`value`	`FaceMeshContextType`	The value of the context.
`mesh`	`boolean`	Specifies whether the mesh is active or not.
`setMesh`	`function`	A function to update the mesh value.

View Source App.tsx, line 58

Examples

// Create a new context with mesh set to false
const meshContext = createContext<FaceMeshContextType>({
  mesh: false,
  setMesh: () => {}
});

// Access the mesh context value and update the mesh value
const { mesh, setMesh } = useContext(meshContext);
setMesh(true); // Set the mesh to true
setMesh(false); // Set the mesh to false

Type: Object

# MinimalViewContextType

Properties:

Name	Type	Description
`minimalView`	`boolean`	Indicates if the minimal view is enabled.
`setMinimalView`	`React.Dispatch.<React.SetStateAction.<boolean>>`	Function to set the minimal view.
`minimalView`	`boolean`
`setMinimalView`	`React.Dispatch.<React.SetStateAction.<boolean>>`

View Source App.tsx, line 185

Type: object

# MinimalViewContextType

Creates a context for managing the minimal view state.

Properties:

Name	Type	Description
`minimalView`	`boolean`	The current state of the minimal view.
`setMinimalView`	`function`	A function to update the minimal view state.

View Source App.tsx, line 46

Type: Object

# NotificationManagerContextType

Properties:

Name	Type	Description
`notificationManager`	`any`	The type of the NotificationManager object.
`notificationManager`	`any`

View Source App.tsx, line 211

Type: Object

# NotificationManagerContextType

Represents the context for the NotificationManager.

Properties:

Name	Type	Description
`notificationManager`	`NotificationManager`	An instance of the notification manager.

View Source App.tsx, line 96

Type: Object

# NumberInputProps

Represents the properties for a NumberInput component.

Properties:

Name	Type	Attributes	Description
`initial`	`number`	<optional>	The initial value for the NumberInput.
`required`	`boolean`	<optional>	Specifies if the NumberInput is required.
`placeholder`	`string`	<optional>	The placeholder text for the NumberInput.
`unit`	`string`	<optional>	The unit of measurement for the NumberInput.
`min`	`number`	<optional>	The minimum value allowed for the NumberInput.
`max`	`number`	<optional>	The maximum value allowed for the NumberInput.
`initial`	`number`	<optional>
`required`	`boolean`	<optional>
`placeholder`	`string`	<optional>
`unit`	`string`	<optional>
`min`	`number`	<optional>
`max`	`number`	<optional>

View Source Elements/useInputs/useNumberInput.tsx, line 72

Type: Object

# RecordTimeContextType

Type definition for RecordTimeContextType.

Properties:

Name	Type	Description
`recordedTime`	`number`	The recorded time value.
`setRecordedTime`	`React.Dispatch.<React.SetStateAction.<number>>`	Function to set the recorded time value.
`recordedTime`	`number`
`setRecordedTime`	`React.Dispatch.<React.SetStateAction.<number>>`

View Source App.tsx, line 175

Type: Object

# RecordTimeContextType

Context variable for recording time.

Properties:

Name	Type	Description
`recordedTime`	`number`	The recorded time value.
`setRecordedTime`	`function`	A function to set the recorded time value.

View Source App.tsx, line 34

Type: Object

# RecordingContextType

Represents the type definition for the RecordingContextType.

Properties:

Name	Type	Description
`recording`	`boolean` \| `undefined`	Indicates whether recording is enabled or not.
`setRecording`	`React.Dispatch.<React.SetStateAction.<(boolean\|undefined)>>`	Function that can be used to update the recording state.
`recording`	`boolean` \| `undefined`
`setRecording`	`React.Dispatch.<React.SetStateAction.<(boolean\|undefined)>>`