Giter Club home page Giter Club logo

kyouko.nvim's Introduction

๐ŸŽค Kyouko

Pre-alpha plugin to record lectures from within Neovim.

This plugin allows you to record audio from your microphone from within Neovim and also insert the current timestamp of the recording inside a buffer. A typical use-case is for taking notes for a lecture: maybe you want to record the lecture but you don't want to guess where a passage is in the audio file. With Kyouko you can annotate where exactly a phrase in the lecture was said, so it's easier to find later on.

Requirements

Right now only works with Linux (Pipewire) and with opus-tools installed (needs opusenc).

This plugin uses Plenary's Job API, so you need plenary.nvim installed.

Installation

For lazy.nvim:

{
    'andry-dev/kyouko.nvim',
    dependencies = {
        'nvim-lua/plenary.nvim'
    }
}

For Packer:

use {
    'andry-dev/kyouko.nvim',
    requires = {
        'nvim-lua/plenary.nvim'
    }
}

And you're done! Just use one of the subcommands of :Kyouko:

  • :Kyouko start starts recording from your main microphone. The recording is saved inside a .recordings/ directory in the current working directory. The name of the file is generated from the current ISO date and time and its extension is OGG (Opus/Vorbis).

    A buffer will be created with URI kyouko:// where you can see some info about the recording.

    From Lua: require('kyouko'):new_recording().

  • :Kyouko annotate adds the current timestamp at the cursor position. This is useful when taking lecture notes to know where in the recording a passage was said.

    From Lua: require('kyouko'):annotate().

  • :Kyouko stop stops the current recording.

    This does not close the kyouko:// buffer.

    From Lua: require('kyouko'):stop_recording().

TODO

  • Make it customizable.
  • Support other sound servers.
  • Support other operating systems.
  • Keep track of the various recordings.

kyouko.nvim's People

Contributors

andry-dev avatar

Stargazers

Luca avatar Yuta Katayama avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.