@ruc-lib/screen-recorder 2.9.1 → 3.1.0

package/README.md

@@ -1,150 +1 @@
-# ruclib-screen-recorder
-
-This library provides a feature to record and download the screen with and without Audio
-
-## RUC Library Installation Guide
-
-Users can easily install the RUC (Ruxptest Library) from npm. Additionally, they can also choose to install individual components based on their requirements.
-Install RUC Library.
-
-To install the entire RUC library:
-
-`npm install @uxpractice/ruc-lib` 
-
-## Install Individual Components
-If users only need the dialog component, they can install it separately:
-
-`npm install @ruc-lib/screen-recorder`
-
-## Usage
-
-To use the screen recorder component in your project, follow the integration guidelines provided in the documentation. 
-
-## Using Selector
-
-1.	Import `RuclibScreenRecorderModule` from `@ruc-lib/screen-recorder` into `app.module.ts` file. 
-2.	Use the selector in your HTML file.
-
-```
-<uxp-screen-recorder 
-[rucInputData]="recorderOptions"></uxp-screen-recorder>
-
-```
-
-
-### Component Inputs
-
-| Input          | Type                    | Description                                      |
-|----------------|-------------------------|--------------------------------------------------|
-| `rucInputData` | `ScreenRecorderOptions` | The main configuration object for the component. |
-| `customTheme`  | `string`                | An optional CSS class for custom theming.        |
-
-
-### `ScreenRecorderOptions`
-This is the main configuration object for the Screen recording.
-
-| Property                      | Type                             | Description                                          |
-|-------------------------------|----------------------------------|------------------------------------------------------|
-| `position`                    | `'left' \| 'right'` (Optional)   | Position of icon                                     |
-| `displayFormat`               | `'icon' \| 'text'`               | Screen option format like - icpn and text            |
-| `defaultAudioState`           | `boolean`           (Optional)   | true for audio on, false for audio off               |
-| `showAudioToggle`             | `boolean`           (Optional)   | If `true`, displays audio option                     |
-| `icons`                       | `ScreenRecorderIcons` (Optional) | For custom icons (e.g., CSS classes for icon fonts)  |
-| `showTimer`                   | `boolean`            (Optional)  | Show timer                                           |
-| `categoryLabelStyle`          | `'basic' \| 'widget'` (Optional) | The display style for category labels.               |
-| `showCategoryLabels`          | `boolean`            (Optional)  | If `true`, displays the category labels.             |
-| `showPauseResume`             | `boolean`                        | Show pause resume option.                            |
-| `downloadFileName`            | `string`             (Optional)  | Download file name                                   |
-| `showPlaybackControls`        | `boolean`            (Optional)  | To show/hide the video player preview                |
-| `showDownloadButton`          | `boolean`                        | To show download button                              |
-| `useUTCForTimer`              | `boolean`            (Optional)  | If `true`, displays the UTC time labels.             |
-| `allowSpecificAreaSelection`  | `boolean`            (Optional)  | Record specific screen                               |
-| `accessibilityLabels`         | `accessibilityLabels`(Optional)  | Accessibility related texts                          |
-
-
-### `ScreenRecorderIcons`
-This values defines the configuration for screen recorder icons.
-
-| Property             | Type      | Description                                                        |
-|----------------------|-----------|--------------------------------------------------------------------|
-| `record`             | `string`  | Default: '●' (filled circle) or a material icon class              |
-| `recordWithAudio`    | `string`  | Alternative if specific icon for "record with audio" is needed     |
-| `recordWithoutAudio` | `number`  | Alternative if specific icon for "record without audio" is needed  |
-| `stop`               | `string`  | Default: '■ ' (filled square) or a material icon class             | 
-| `pause`              | `string`  | Default: '❚❚' or a material icon class                              |  
-| `resume`             | `string`  | Default: '►' (play symbol) or a material icon class                |
-| `play`               | `string`  | Default: '►' (play symbol) or a material icon class                |
-| `download`           | `number`  | Default: '💾' (floppy disk) or a material icon class               |
-| `audioOn`            | `string`  | Default: '🔊' (speaker high volume) or a material icon class       |
-| `audioOff`           | `string`  | Default: '🔇' (muted speaker) or a material icon class             |
-
-### `accessibilityLabels`
-This values defines the configuration for screen recorder accessibilityLabels.
-
-| Property           | Type      | Description     |
-|--------------------|-----------|-----------------|
-| `recordButton`     | `string`  | label text      |
-| `stopButton`       | `string`  | label text      |
-| `pauseButton`      | `number`  | label text      |
-| `resumeButton`     | `string`  | label text      | 
-| `audioToggleButton`| `string`  | label text      |  
-| `downloadButton`   | `string`  | label text      |
-| `playbackVideo`    | `string`  | label text      |
-
-## Example Configuration
-
-Here's an example of how to configure the Metered Progress Bar in your component's TypeScript file.
-
-```typescript
-import { Component } from '@angular/core';
-import { ScreenRecorderOptions, ScreenRecorderPosition, DisplayFormat } from '@ruclib/screen-recorder'; // Adjust import path
-
-
-@Component({
-  selector: 'app-root',
-  templateUrl: './app.component.html',
-})
-export class AppComponent {
-  recorderOptions: {
-    position: 'Left',
-    displayFormat: 'icon',
-    showAudioToggle: true,
-    defaultAudioState: true,
-    downloadFileName: 'screen-recording.webm',
-    showTimer: true,
-    showPauseResume: true,
-    showPlaybackControls: true,
-    showDownloadButton: true,
-    useUTCForTimer: false,
-    allowSpecificAreaSelection: true,
-    icons: {
-      record: 'fiber_manual_record',
-      stop: 'stop',
-      pause: 'pause',
-      resume: 'play_arrow',
-      play: 'play_circle_filled',
-      download: 'download',
-      audioOn: 'volume_up',
-      audioOff: 'volume_off',
-    },
-    accessibilityLabels: {
-      recordButton: 'Start Recording',
-      stopButton: 'Stop Recording',
-      pauseButton: 'Pause Recording',
-      resumeButton: 'Resume Recording',
-      audioToggleButton: 'Toggle Audio',
-      downloadButton: 'Download Recording',
-      playbackVideo: 'Screen Recording Playback',
-    },
-  };
-}
-```
-
-## Contribution
-
-Contributions are welcome! Feel free to open issues or pull requests for any enhancements or fixes.
-
-## Acknowledgements
-
-Thank you for choosing the Screen Recorder Component Library. If you have any feedback or suggestions, please let us know!
-
+utf8