kickflip-android-sdk - GitLite

KO | EN

gitlite — search

#javascript #python #ai #typescript #go #machine-learning #rust #deep-learning #macos #awesome-list #vue #security #ios #openai

kickflip-android-sdk

(★ 655)

Kickflip Android SDK - Live Video Streaming to the Cloud

File Explorer

Download Latest Version (.zip)

- - gradle-wrapper.jar
  - gradle-wrapper.properties
- - m3u8parser-0.2.jar
- - javadoc-overview.html
- .gitignore
- build.gradle
- proguard-google-api-client.txt
- proguard-rules.txt
.gitignore
build.gradle
DEVELOPMENT.md
gradlew
gradlew.bat
LICENSE
README.md
RELEASING.md
settings.gradle

# Installation Guide

1. Get the code

git clone https://github.com/Kickflip/kickflip-android-sdk

Downloads the entire project code from GitHub to your computer.

cd kickflip-android-sdk

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

//build.gradle

Builds the project using Gradle.

//settings.gradle

Builds the project using Gradle.

//your app module's build.gradle

Builds the project using Gradle.

Next, add the submodule as a gradle dependency

Builds the project using Gradle.

$ ./gradlew assembleDebug

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Kickflip SDK for Android  [ ![Download](https://api.bintray.com/packages/onlyinamerica/Kickflip/io.kickflip%3Asdk/images/download.svg) ](https://bintray.com/onlyinamerica/Kickflip/io.kickflip%3Asdk/_latestVersion)

![kickflip live broadcast screenshot](http://i.imgur.com/ELljE1a.jpg)

**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).
[![Google Play link](http://steverichey.github.io/google-play-badge-svg/img/en_get.svg)](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	       
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.CAMERA"/>
    <uses-permission android:name="android.permission.RECORD_AUDIO"/>
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
	```
	
	**BroadcastActivity**
	
	```xml
    <activity
         android:name="io.kickflip.sdk.activity.BroadcastActivity"
         android:screenOrientation="landscape">
    </activity>
	```

**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
	<activity
            android:name="io.kickflip.sdk.activity.MediaPlayerActivity"
            android:screenOrientation="landscape" >
    </activity>
	```
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.