Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove makerbox links and update links to AO documentation #69

Merged
merged 4 commits into from
Jan 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 11 additions & 15 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

**Create immersive and interactive audio experiences for multiple synchronised devices.**

Audio device orchestration is the concept of using multiple connected devices to play back an audio experience. This repository holds an open source template application and libraries that handle the key components of an orchestrated audio system (pairing, synchronisation, and audio playback).
Audio device orchestration is the concept of using multiple connected devices to play back an audio experience. This repository holds a template application and libraries that handle the key components of an orchestrated audio system (pairing, synchronisation, and audio playback).

## The _Audio Orchestrator_ production tool

Our _Audio Orchestrator_ production tool is now available through the open-source [Audio Orchestrator repository](https://github.com/bbc/audio-orchestrator). This tool is used for authoring metadata, and packaging media for use with the template and core library.

The [_Audio Orchestrator_ documentation](https://bbc.github.io/audio-orchestrator/) includes a [list of experiences made with these tools](https://bbc.github.io/audio-orchestrator/productions/) and [instructions for using a custom template](https://bbc.github.io/audio-orchestrator/custom-template) built using this repository. Note that most BBC productions shown there received significant additional development to extend the default template.

## Components

Expand All @@ -17,19 +23,13 @@ The [**Cloud-Sync** server](https://github.com/2-IMMERSE/cloud-sync) source code
* [`@bbc/audio-orchestration-bbcat-js`](packages/bbcat-js)
* [`@bbc/audio-orchestration-cloud-sync-client`](packages/cloud-sync-client)

## The _Audio Orchestrator_ production tool

Our _Audio Orchestrator_ production tool for authoring metadata and packaging media for use with the template and core library is [freely available on request from BBC MakerBox](https://www.bbc.co.uk/makerbox/tools/audio-orchestrator).

The [_Audio Orchestrator_ documentation](https://bbc.github.io/bbcat-orchestration-docs/) includes a [list of experiences made with these tools](https://bbc.github.io/bbcat-orchestration-docs/productions/) and [instructions for using a custom template](https://bbc.github.io/bbcat-orchestration-docs/custom-template) built using this repository.

# Usage

Ensure you have [Node.js](https://nodejs.org/en/) installed, including `npm` version 7 or higher (earlier versions of `npm` do not have the workspaces functionality used in this repository).
Ensure you have [Node.js](https://nodejs.org/en/) installed, with a recent version of NPM.

```
node -v # e.g. v16.13.0
npm -v # e.g. 8.1.0
node -v # e.g. v20.9.0
npm -v # e.g. 10.4.0
```

Start your project by downloading a copy of this repository, either by using the `Download as ZIP` button on GitHub, or by using `degit`.
Expand Down Expand Up @@ -71,8 +71,4 @@ The majority of our components (`template`, `core`, and `bbcat-js`) are licensed

If you are modifying the software to create your experience you may have to make your source code modifications available under the terms of the GPL license.

You may [contact BBC R&D](https://www.bbc.co.uk/rd/contacts) to discuss alternative licensing options. (Please note, the BBC is under no obligation to offer alternative terms.)

# Contributing

Please contact the authors by [raising a GitHub issue](https://github.com/bbc/audio-orchestration/issues/new). A contributor licence agreement may be applicable.
You may [contact BBC R&D](https://www.bbc.co.uk/rd/contacts) to discuss alternative licensing options. (Please note, the BBC is under no obligation to offer alternative terms.)
20 changes: 10 additions & 10 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/bbcat-js/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/audio-orchestration-bbcat-js",
"version": "0.1.1",
"version": "0.1.2",
"description": "WebAudio DASH player components for audio orchestration framework",
"main": "dist/bbcat.js",
"files": [
Expand Down
2 changes: 1 addition & 1 deletion packages/cloud-sync-client/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/audio-orchestration-cloud-sync-client",
"version": "0.1.1",
"version": "0.1.2",
"description": "Library implementing client code for cloud synchronisation",
"main": "dist/browser/CloudSyncKit.js",
"files": [
Expand Down
6 changes: 3 additions & 3 deletions packages/core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/audio-orchestration-core",
"version": "0.1.1",
"version": "0.1.2",
"description": "Components for synchronised object based audio experiences.",
"main": "dist/light.js",
"exports": {
Expand All @@ -17,8 +17,8 @@
"dist"
],
"dependencies": {
"@bbc/audio-orchestration-bbcat-js": "^0.1.1",
"@bbc/audio-orchestration-cloud-sync-client": "^0.1.1",
"@bbc/audio-orchestration-bbcat-js": "^0.1.2",
"@bbc/audio-orchestration-cloud-sync-client": "^0.1.2",
"dvbcss-clocks": "^0.0.4",
"dvbcss-protocols": "^0.0.4",
"events": "^3.0.0",
Expand Down
4 changes: 2 additions & 2 deletions packages/template/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/audio-orchestration-template",
"version": "0.1.1",
"version": "0.1.2",
"description": "A user interface template showing how to integrate the bbcat-orchestration toolkit for orchestrated personal audio devices with React components.",
"repository": {
"type": "git",
Expand All @@ -12,7 +12,7 @@
"dist"
],
"dependencies": {
"@bbc/audio-orchestration-core": "^0.1.1",
"@bbc/audio-orchestration-core": "^0.1.2",
"@hot-loader/react-dom": "^16.11.0",
"bowser": "^2.9.0",
"classnames": "^2.2.6",
Expand Down
9 changes: 1 addition & 8 deletions packages/template/src/components/footer/Footer.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,11 @@
* This source code is licensed under the GPL license found in the LICENSE file in this repository.
*/
import React from 'react';
import Icon from 'components/icon/Icon';

const Footer = () => (
<div className="footer">
<p className="logo">
<Icon title="BBC Research & Development" padded name="bbcrd" />
</p>
<p className="small">
<a href="https://www.bbc.co.uk/makerbox/tools/audio-orchestrator" target="_blank" rel="noopener noreferrer">Created with Audio Orchestrator</a>
</p>
<p className="small">
&copy; BBC R&amp;D 2022
<a href="https://bbc.github.io/audio-orchestrator" target="_blank" rel="noopener noreferrer">Audio Orchestrator</a>
</p>
</div>
);
Expand Down
Loading