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.

Sign up for GitHub

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

Jump to bottom

Add Anbox Cloud streaming SDK #48

Merged
merged 2 commits into from
Feb 3, 2020
Merged

Add Anbox Cloud streaming SDK #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cdfe61d
static: add the Anbox Cloud streaming SDK with documentation
Jan 29, 2020
ae76661
fix example in docs
aguadoenzo Feb 3, 2020
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
82 changes: 82 additions & 0 deletions static/js/anbox-stream-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Anbox Stream SDK

The Anbox Stream SDK is a javascript library you can plug in your website
to easily establish a video stream of your Anbox instances.

### Usage

Include the script

```html
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>

<script async src="path/to/anbox-stream-sdk.js"></script>

</head>
<body></body>
</html>
```


Create a node element with an ID

```html
<div id="anbox-stream"></div>
```

and create a stream instance

```javascript
/**
* AnboxStream creates a connection between your client and an Android instance and
* displays its video & audio feed in an HTML5 player
*
* @param options: {object} {
* targetElement: ID of the DOM element to attach the video to. (required)
* url: Address of the service. (required)
* authToken: Authentication token acquired through /1.0/login (required)
* stunServers: List ICE servers (default: [{"urls": ['stun:stun.l.google.com:19302'], username: "", password: ""}])
* session: {
* app: Android application ID or name. (required)
* },
* screen: {
* width: screen width (default: 1280)
* height: screen height (default: 720)
* fps: screen frame rate (default: 60)
* density: screen density (default: 240)
* },
* controls: {
* keyboard: true or false, send keypress events to the Android instance. (default: true)
* mouse: true or false, send mouse and touch events to the Android instance. (default: true)
* gamepad: true or false, send gamepad events to the Android instance. (default: true)
* },
* callbacks: {
* ready: function, called when the video and audio stream are ready to be inserted. (default: none)
* error: function, called on stream error with the message as parameter. (default: none)
* done: function, called when the stream is closed. (default: none)
* }
* }
*/

let stream = new AnboxStream({
targetElement: "anbox-stream",
url: config.backendAddress,
authToken: "abc123",
session: {
app: "some-application-name",
},
screen: {
width: 720,
height: 1080,
},
callbacks: {
ready: () => { console.log('video stream is ready') },
error: (e) => { console.log('an error occurred:', e) },
done: () => { console.log('stream has been closed') },
},
});

stream.connect();
```
Loading