Kickflip SDK for Android

The Kickflip Android SDK manages all the plumbing for your cloud video application. With this SDK you can broadcast Live, High Definition HTTP-HLS video, associate these broadcasts with users, and query broadcasts made by your users. All you need is a Kickflip.io account.

The Kickflip Android SDK requires Android 4.3+ (API 18+).

Check out our Android example application to see how to easily put this SDK to work.

Also check out our slick iOS SDK and iOS Example application

Features

High Definition HTTP Live Streaming
Background recording
OpenGL Video Effects

Quickstart

Make a kickflip.io account to register an Application and receive your Client Key and Client Secret. You'll need these later.

Ensure the minSdkVersion of your application is 18 (Android 4.3) and the compileSdkVersion is 19 (Android 4.4).

android {
    compileSdkVersion 19
    ...
    defaultConfig {
        minSdkVersion 18
        targetSdkVersion 19
        ...
    }
    ...
}

Add Kickflip to your app's build.gradle:

Dependencies:
```
dependencies {
	compile 'io.kickflip:sdk:1.0'
}
```

Add the following to your app's AndroidManifest.xml:

Permissions:

<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:

<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).

<activity
        android:name="io.kickflip.sdk.activity.MediaPlayerActivity"
        android:screenOrientation="landscape" >
</activity>

Provide your Kickflip keys and start BroadcastActivity when appropriate:

Kickflip.setup(this, CLIENT_ID, CLIENT_SECRET);
Kickflip.startBroadcastActivity(this, new BroadcastListener() {
    @Override
    public void onBroadcastStart() {
    
    }

    @Override
    public void onBroadcastLive(String watchUrl) { 
    	Log.i("Kickflip", "This phone is live at " + watchUrl);       
    }

    @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

Define the Android SDK root location as $ANDROID_HOME in your environment.
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 and Android API Reference. We also have some tutorials to help you get started.

License

Apache 2.0