https://github.com/novustheory/xosms

Cross platform native media service library for node & electron. Currently supporting Windows & Linux
https://github.com/novustheory/xosms

audio cross-platform electron electronjs javascript js linux macos media node nodejs playback rust service windows

Last synced: 3 months ago
JSON representation

Cross platform native media service library for node & electron. Currently supporting Windows & Linux

• Host: GitHub
• URL: https://github.com/novustheory/xosms
• Owner: NovusTheory
• License: apache-2.0
• Created: 2021-03-23T02:17:24.000Z (almost 4 years ago)
• Default Branch: dev
• Last Pushed: 2024-05-29T21:47:33.000Z (8 months ago)
• Last Synced: 2024-10-11T18:05:14.764Z (3 months ago)
• Topics: audio, cross-platform, electron, electronjs, javascript, js, linux, macos, media, node, nodejs, playback, rust, service, windows
• Language: Rust
• Homepage:
• Size: 1.09 MB
• Stars: 7
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Xosms [![build](https://github.com/NovusTheory/xosms/actions/workflows/CI.yml/badge.svg?branch=dev)](https://github.com/NovusTheory/xosms/actions/workflows/CI.yml) [![npm version](https://badge.fury.io/js/xosms.svg)](https://badge.fury.io/js/xosms)

A cross platform media service library made in Rust for Node to easily and seamelessly integrate with the operating systems media service API.

> [!WARNING]  

> Xosms is going under a rewrite and current platforms that were previously supported may no longer be supported. This rewrite is to help more concretely define and stabilize the API along with improving the development workflow.

## Current Platforms Supported

- [x] Windows

- [ ] MacOS

- [x] Linux (via MPRIS)

Even if your platform above isn't currently supported, the beauty of xosms is that it will still compile for it but noop on everything.

# Development

To setup and locally develop and build xosms please ensure you have

- Rust

- Yarn

Once you have all of the above you can clone the repository and run

- `yarn`

- `yarn build` (Compiles the rust natives)

- `yarn build:lib` (Runs tsc)