# raop-server

**Repository Path**: mirrors_watson/raop-server

## Basic Information

- **Project Name**: raop-server
- **Description**: A simple RAOP server
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-26
- **Last Updated**: 2026-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# raop-server

A RAOP server.

**Warning: This is very much work-in-progress :)** For something more
useful for now, check out either
[raop-rtsp-server](https://github.com/watson/raop-rtsp-server) or the
more low level [rtsp-server](https://github.com/watson/rtsp-server).

[![Build status](https://travis-ci.org/watson/raop-server.svg?branch=master)](https://travis-ci.org/watson/raop-server)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

## Installation

```
git clone https://github.com/watson/raop-server.git
cd raop-server
npm install
```

## Example usage

```js
var raop = require('raop-server')('My RAOP Server')

raop.on('request', function (c) {
  // do your stuff
})

raop.listen(7000) // start server on port 7000
```

## API

### Constructor

Get the constructor by requireing the `raop-server` node module and call
it. It takes the optional arguments `name`, `options` and `onRequest`.
Either of them can be left out, so calling with only `options` or only
`name` and `onRequest` is ok:

```js
require('raop-server')(name, options, onRequest)
```

Constructor arguments:

- `name` - name of the AirPlay server (default: 'Node.js')
- `options` - custom configuration of the raop server:
  - `txt` - object used to replace stock TXT record
  - `mac` - spoof the MAC address
- `onRequest` - callback function called upon each request (default: No listener is added. Remember to manually listen on the `request` event)

### Server

The constructor returns a basic Node.js TCP server, so remember to call
`.listen()` and optionally add a `request` event listener if one hasn't
been provided as an argument to the constructor.

## License

MIT