Github SDK Examples
Looking for code examples? We've got some Github repos showing how to use the Whereby Embedded API to create and embed Whereby rooms in your own app/website.
Last updated
# Telehealth Example App
This is a simple example app that demonstrates how to use the Whereby browser SDK to create a telehealth application.
Created with [Create React App](https://create-react-app.dev/) and Whereby's [browser SDK](https://www.npmjs.com/package/@whereby.com/browser-sdk).
## Usage
Replace the `ROOM_URL` constant in `src/App.tsx` with your own Whereby room URL.
```bash
yarn install # or npm install
```
```bash
yarn start # or npm start
```
# Whereby Browser SDK Hackday Demo
This was a hackathon project orientated around using Whereby's public [Browser SDK](https://github.com/whereby/browser-sdk). We created a Jackbox-esque quiz game with working audio and video tiles for the players.
## Setup
```
yarn
yarn start
```
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
> ð One player will need to be the quiz master (or party leader) to start the game. They can join using the query parameter [http://localhost:3000?quizMaster=true](http://localhost:3000?quizMaster=true)
### Libraries
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), using the [Redux](https://redux.js.org/) and [Redux Toolkit](https://redux-toolkit.js.org/) TS template.
The project also uses [ChakraUI](https://chakra-ui.com/) components and [Framer](https://www.framer.com/motion/) for animation.
## Configuration
Currently, there is a single Whereby room which hosts this game. This could be expanded to generate transient rooms like Jackbox does, for example. For now - Putting your own Whereby room in the [config](./frontend/src/config/room.ts) will allow the sdk to connect with your own parameters.
## Architecture
We decided to experiment and see if a many-to-many game connection was possible, using Whereby's socketIO connection, rather than deploying a separate game server and frontend.
The game state (questions, answers, scores etc.) are sent via JSON in the underlying Whereby room's chat functionality (and abstracted from this game).
Therefore no server was required. The static frontend was deployed to\
https://hackday-sdk-demo.netlify.app/
# Whereby iOS SDK demo
This repository contains a sample app in Swift using the [Whereby iOS SDK](https://github.com/whereby/ios-sdk).
Other platforms:
- [Android SDK](https://github.com/whereby/android-sdk)
- [Browser SDK](https://github.com/whereby/browser-sdk)
## Prerequisites
- The latest stable version of [Xcode](https://apps.apple.com/us/app/xcode/id497799835)
- The latest stable version of [cocoapods](https://cocoapods.org/)
- Sign up to [Whereby Embedded](https://whereby.com/information/embedded/) account
- [Create a room](https://docs.whereby.com/creating-and-deleting-rooms) in your Whereby Embedded account
## Using the app with Cocoapods
1. Install WherebySDK dependency using cocoapods. Starting at the root folder of this repo:
```
cd [project root path]/Demo-CocoaPods
pod install
```
2. Open `WherebySDKDemo.xcworkspace` in Xcode.
3. In `DemoViewController.swift` provide your room URL to open in the demo app.
4. Run the project.
## Using the app with Swift Package Manager
1. Navigate to the Demo-SwiftPM folder:
```
cd [project root path]/Demo-SwiftPM
```
2. Open `WherebySDKDemo.xcodeproj` in Xcode.
3. Select **File > Add Packages...**
4. In the Search or Enter Package URL text field, enter the repository URL
```
https://github.com/whereby/ios-sdk.git
```
5. In `DemoViewController.swift` provide your room URL to open in the demo app.
6. Run the project.
## Disclaimer
Whereby publishes these packages to help the developer community understand how the Whereby Embedded product can be implemented.
Whereby does not recommend using such examples in a production environment without a prior assessment and appropriate testing relevant to the production setup targeted which can be of operational, technical, security or legal (e.g. library licenses assessment) nature. You expressly agree that the use of these packages is at your sole risk.
Whereby, its affiliates, suppliers, or licensors, whether express or implied, do not make any representation, warranties, contractual commitments, conditions, or assurances by the operation of these examples, or the information, content, materials, therein.
# Whereby Android SDK demo
[Whereby](https://whereby.com/) is the easiest way to embed video calls into your web page or mobile app.
This repository contains two sample apps in Java and Kotlin using the [Whereby Android SDK](https://github.com/whereby/android-sdk). Follow the [instructions](https://github.com/whereby/android-sdk/blob/main/README.md) to fetch and start using the framework within your own app.
Other platforms:
- [iOS SDK](https://github.com/whereby/ios-sdk)
- [Browser SDK](https://github.com/whereby/browser-sdk)
## Usage
1. In Android Studio, open one of the two projects: Java or Kotlin
2. In the `MainActivity` source file, set the `mRoomUrlString` property
3. Run the app
4. Start the meeting using embedded or full screen presentation
5. In embedded, you can use the custom media buttons to toggle the camera and microphone
## Disclaimer
Whereby publishes these packages to help the developer community understand how the Whereby Embedded product can be implemented.
Whereby does not recommend using such examples in a production environment without a prior assessment and appropriate testing relevant to the production setup targeted which can be of operational, technical, security or legal (e.g. library licenses assessment) nature. You expressly agree that the use of these packages is at your sole risk.
Whereby, its affiliates, suppliers, or licensors, whether express or implied, do not make any representation, warranties, contractual commitments, conditions, or assurances by the operation of these examples, or the information, content, materials, therein.