audio-orchestration-cloud-sync-client 0.1.0-dev.3
Install from the command line:
Learn more about npm packages
$ npm install @bbc/audio-orchestration-cloud-sync-client@0.1.0-dev.3
Install via package.json:
"@bbc/audio-orchestration-cloud-sync-client": "0.1.0-dev.3"
About this version
This is a fork of 2-IMMERSE/cloud-sync to provide a self-contained and slightly modernised build of the client only. The original repository still contains the server software.
- All server-side code has been removed.
- Third-party dependencies have been upgraded where possible.
- The
grunt
build system has been replaced with usingwebpack
directly. - A number of changes were made to the source code for use in the audio orchestration libraries.
- Add
ApplicationBroadcast
message type and send/receive methods (ApplicationBroadcast.js
,CloudSynchroniser.js
). - Emit a
DeviceStatus
event on device status messages (CloudSynchroniser.js
). - Use a provided
sysClock
instead of always creating a newDateNowClock
(CloudSynchroniser.js
). - Change
keepalive
parameter inmqttmessagingadapter
to 60s. - Make
timelineUpdateChannel
field optional inTimelineRegistrationRESP
message (TimelineRegistrationRESP.js
). - Disable verbose logs (
CloudSynchroniser.js
). - Replace the paths in most
require
calls throughout to be relative or use defined aliases, instead of relying on adding each source folder to a search path. - Move the URL parsing for the wall clock connection from
CloudSynchroniser.js
toWallClockSynchroniser.js
and use thepathname
component if provided. - Explicitly import the
buffer
module instead of relying on a global definition (util/b64.js
).
- Add
The documentation for the API and usage instructions for the client library can be found in client-api.md
If you wish to build it into a single JS file suitable for the browser (i.e. for including in a webpage) then do this:
npm run build
The resulting JS client library is placed in dist/browser/CloudSyncKit.js
.
@bbc/audio-orchestration-cloud-sync-client Copyright (C) 2022 BBC R&D
See the LICENSE file for terms applicable to this package, and the top-level Readme file for further information.
All code and documentation is licensed by the original author and contributors under the Apache License v2.0:
- British Broadcasting Corporation (original author)
- Centrum Wiskunde & Informatica
See AUTHORS.md file for a full list of individuals and organisations that have contributed to this code.
Details
- audio-orchestration-cloud-sync-client
- bbc
- over 2 years ago
- Apache-2.0
- 10 dependencies
Assets
- audio-orchestration-cloud-sync-client-0.1.0-dev.3-npm.tgz
Download activity
- Total downloads 1
- Last 30 days 0
- Last week 0
- Today 0