README

AI-powered screen recording and automation for seamless documentation and training.

Installation

Install the makeshot-sdk package using your preferred package manager: bash npm install makeshot-sdk

or

yarn add makeshot-sdk

or

pnpm install makeshot-sdk

Core API/Feature Overview

The makeshot-sdk provides the following core functionalities:

• Automated Screen Recording: Programmatically initiate and control screen recordings with customizable parameters.
• Contextual Metadata Injection: Embed relevant metadata (e.g., user ID, session ID) directly into recordings for enhanced analysis.
• AI-Powered Transcription: Automatically transcribe recorded content into text, facilitating search and accessibility.
• Event-Driven Triggering: Define custom events that trigger recording start/stop actions, enabling targeted documentation.
• Secure Storage and Sharing: Securely store recordings and easily share them with team members or external stakeholders.

Usage Examples

Here are some basic usage examples demonstrating the core functionalities of the makeshot-sdk.

Starting a Recording: javascript const makeshot = require('makeshot-sdk');

makeshot.startRecording({ sessionId: 'user123-session456', metadata: { feature: 'new-dashboard', }, });

Stopping a Recording: javascript const makeshot = require('makeshot-sdk');

makeshot.stopRecording();

Adding Custom Annotations: javascript const makeshot = require('makeshot-sdk');

makeshot.addAnnotation({ timestamp: Date.now(), text: 'User clicked the submit button.', });

Getting Transcription of recording: javascript const makeshot = require('makeshot-sdk');

makeshot.getTranscription().then(transcription => { console.log(transcription); });

Creating and Downloading a short clip: javascript const makeshot = require('makeshot-sdk');

makeshot.createClip({startTime: 10, endTime:20}).then(clip => { makeshot.downloadClip(clip.url); });

Enterprise Solutions

For advanced features, including custom integrations, priority support, and enterprise-grade security, explore our enterprise solutions at https://makeshot.ai/. Discover how makeshot.ai can transform your documentation and training workflows. Our platform offers robust capabilities beyond the basic SDK, enabling seamless integration with your existing systems. Learn more about the full potential of makeshot.ai by visiting our website.

License

MIT License

Copyright (c) 2024 makeshot.ai

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.