Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kickflip/kickflip-android-sdk
Kickflip Android SDK - Live Video Streaming to the Cloud
https://github.com/Kickflip/kickflip-android-sdk
Last synced: 3 months ago
JSON representation
Kickflip Android SDK - Live Video Streaming to the Cloud
- Host: GitHub
- URL: https://github.com/Kickflip/kickflip-android-sdk
- Owner: Kickflip
- License: apache-2.0
- Created: 2014-01-21T21:58:27.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2020-10-01T16:08:42.000Z (over 4 years ago)
- Last Synced: 2024-04-16T11:47:44.255Z (9 months ago)
- Language: Java
- Homepage: https://kickflip.io
- Size: 37.2 MB
- Stars: 659
- Watchers: 79
- Forks: 213
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - kickflip-android-sdk - Kickflip Android SDK - Live Video Streaming to the Cloud (etc)
- awesome - kickflip-android-sdk - Kickflip Android SDK - Live Video Streaming to the Cloud (etc)
README
# Kickflip SDK for Android [  ](https://bintray.com/onlyinamerica/Kickflip/io.kickflip%3Asdk/_latestVersion)
**The Kickflip Android SDK manages all the plumbing for your cloud video application**. With this SDK you can broadcast Live, High Definition [HTTP-HLS](http://en.wikipedia.org/wiki/HTTP_Live_Streaming) video, associate these broadcasts with users, and query broadcasts made by your users. All you need is a [Kickflip.io](https://kickflip.io) account.
The Kickflip Android SDK requires Android 4.3+ (API 18+).
Check out our Android example application on [Github](https://github.com/Kickflip/kickflip-android-example) or Google Play (below).
[](https://play.google.com/store/apps/details?id=io.kickflip.sample)
Also check out our slick [iOS SDK](https://github.com/Kickflip/kickflip-ios-sdk) and [iOS Example application](https://github.com/Kickflip/kickflip-ios-example)
## Features
+ **High Definition [HTTP Live Streaming](http://en.wikipedia.org/wiki/HTTP_Live_Streaming)**
+ **Background recording**
+ **OpenGL video effects**
+ **Pinch Zoom**
+ **Blazing fast, geo-aware upstreams**
+ **Global cloud-based Content Distribution Network**
## Quickstart
0. Make a [kickflip.io](https://kickflip.io) account to register an Application and receive your **Client Key** and **Client Secret**. You'll need these later.
1. Ensure the `minSdkVersion` of your application is **18** (Android 4.3) and the `compileSdkVersion` is **19** (Android 4.4).
```groovy
android {
compileSdkVersion 19
...
defaultConfig {
minSdkVersion 18
targetSdkVersion 19
...
}
...
}
```
2. Add Kickflip to your app as a Maven artifact or, if you plan to modify Kickflip, as a submodule. `build.gradle`:
**Maven Artifact:**
```groovy
//build.gradle
...
dependencies {
compile 'io.kickflip:sdk:1.3.1'
}
```
**Git Submodule:**
First add Kickflip as a submodule with git.
```bash
$ cd ./path/to/project
$ git submodule add https://github.com/Kickflip/kickflip-android-sdk.git ./submodules/kickflip-android-sdk/
```
Next, add the submodule as a gradle dependency
```groovy
//settings.gradle
include ':app'
include ':submodules:kickflip-android-sdk:sdk'
```
```groovy
//your app module's build.gradle
...
dependencies {
...
compile project(':submodules:kickflip-android-sdk:sdk')
}
```
3. Add the following to your app's `AndroidManifest.xml`:
**Permissions** (Optional: These will be automatically merged into your AndroidManifest.xml)
```xml
```
**BroadcastActivity**
```xml
```
**MediaPlayerActivity** (Optional)
MediaPlayerActivity handles playing HLS streams with some additional features over Android's MediaPlayer (like indicating when a stream is "Live" and more accurately inferring the stream duration).
```xml
```
4. Provide your Kickflip keys and start `BroadcastActivity` when appropriate:
```java
Kickflip.setup(this, CLIENT_ID, CLIENT_SECRET);
Kickflip.startBroadcastActivity(this, new BroadcastListener() {
@Override
public void onBroadcastStart() {
}
@Override
public void onBroadcastLive(Stream stream) {
Log.i(TAG, "BroadcastLive @ " + stream.getKickflipUrl());
}
@Override
public void onBroadcastStop() {
}
@Override
public void onBroadcastError() {
}
});
```
`BroadcastActivity` provides a pre-built UI including a camera preview and controls for starting, stopping, and sharing the broadcast.
## Building
1. Define the Android SDK root location as $ANDROID_HOME in your environment. It's also a good idea to add the `platform-tools` and `tools` directories to your path so you can easily access common Android utilities, like adb.
An example on Mac OS X using Android Studio:
```
# ~/.bash_profile
# Android
export ANDROID_HOME="/Applications/Android Studio.app/sdk"
export PATH=$ANDROID_HOME"/tools":$ANDROID_HOME"/platform-tools":$PATH
```
2. From this directory run:
$ ./gradlew assembleDebug
The Kickflip SDK .aar will be in `./sdk/build/libs`.
You may also import this project into Android Studio for easy development.
## Documentation
For a closer look at what you do with Kickflip, check out our [Android Documentation](https://github.com/Kickflip/kickflip-docs/tree/master/android) and [Android API Reference](http://kickflip.github.io/kickflip-android-sdk/reference/packages.html). We also have some [tutorials](https://github.com/Kickflip/kickflip-docs/tree/master/tutorials) to help you get started.
## License
Apache 2.0
Copyright 2014 OpenWatch, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.