Skip to content

Commit effbf4b

Browse files
committed
npm 0.0.3
1 parent 56f2144 commit effbf4b

File tree

2 files changed

+37
-23
lines changed

2 files changed

+37
-23
lines changed

README.md

+35-21
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# react-native-osc
1+
# react-native-osc 0.0.3
22

3-
Native Open Sound Control support for React Native (iOS & Android).
3+
Open Sound Control support for sending and receiving OSC messages in React Native (iOS & Android).
44

5+
On the native side:
56
[JavaOSC](https://github.com/hoijui/JavaOSC/) for Android &
67
[SwiftOSC](https://github.com/ExistentialAudio/SwiftOSC) for iOS.
78

8-
99
## Getting started:
1010

1111
`$ npm install react-native-osc --save`
@@ -14,32 +14,25 @@ In ios/Podfile add: `use_frameworks!`
1414

1515
`$ cd ios && pod install`
1616

17-
## Features:
18-
19-
Send OSC messages in iOS.
20-
21-
~~Receive OSC messages in IOS.~~
22-
23-
Send OSC messages in Android.
24-
25-
Receive OSC messages in Android.
26-
27-
2817
## Usage:
2918
```javascript
3019
import osc from 'react-native-osc';
3120

32-
//To send messages:
33-
osc.createClient("localhost", 9090);
21+
var portIn = 9999
22+
var portOut = 9090
23+
24+
//create a client and send a message
25+
osc.createClient("localhost", portOut);
3426
osc.sendMessage("/address/", [1.0, 0.0]);
3527

3628

37-
//To receive messages (Android only):
29+
//suscribe to GotMessage event to receive OSC messages
3830
const eventEmitter = new NativeEventEmitter(osc);
39-
eventEmitter.addListener('GotMessage', (newMessage) => {
40-
console.log("New OSC message: ", newMessage);
31+
eventEmitter.addListener('GotMessage', (oscMessage) => {
32+
console.log("message: ", oscMessage);
4133
});
42-
osc.createServer(9999);
34+
35+
osc.createServer(portIn);
4336
```
4437

4538
## Supported types:
@@ -66,7 +59,28 @@ Xcode:11.3.1 - iOS_SDK: 13 - RN: 0.61.5
6659

6760
## License
6861

69-
MIT
62+
The MIT License (MIT)
63+
64+
Copyright (C) 2020 Luis Fernando Garcia Perez
65+
66+
67+
Permission is hereby granted, free of charge, to any person obtaining a copy
68+
of this software and associated documentation files (the "Software"), to deal
69+
in the Software without restriction, including without limitation the rights
70+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
71+
copies of the Software, and to permit persons to whom the Software is
72+
furnished to do so, subject to the following conditions:
73+
74+
The above copyright notice and this permission notice shall be included in all
75+
copies or substantial portions of the Software.
76+
77+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
78+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
79+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
80+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
81+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
82+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
83+
SOFTWARE.
7084

7185
## JavaOSC
7286

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "react-native-osc",
33
"title": "Open Sound Control for React Native",
4-
"version": "0.0.2",
5-
"description": "Native Open Sound Control support for React Native (iOS & Android).",
4+
"version": "0.0.3",
5+
"description": "Open Sound Control for React Native (iOS & Android).",
66
"main": "index.js",
77
"scripts": {
88
"test": "echo \"Error: no test specified\" && exit 1"

0 commit comments

Comments
 (0)