Android Player SDK

Uiza Documentation
Search…
Uiza Documentation
2020-07-01
Android Player SDK
​​
​​
​​
​​
Link to the Source code here: https://github.com/uizaio/uiza-android-player-sdk​
Welcome to UIZA Android Player SDK
Simple Streaming at scale.
Uiza is the complete toolkit for building a powerful video streaming application with unlimited scalability. We design Uiza so simple that you only need a few lines of codes to start streaming, but sophisticated enough for you to build complex products on top of it.
Read CHANGELOG here.
Importing the Library
Step 1. Add the JitPack repository to your build.gradle file
1
    allprojects {
2
          repositories {
3
             maven { url 'https://jitpack.io' }
4
          }
5
    }
Copied!
Step 2. Add the dependency
1
    implementation 'com.github.uizaio:uiza-android-player-sdk:1.1.x'
Copied!
For Android Support Compat (Support until January 2021)
1
    implementation 'com.github.uizaio:uiza-android-player-sdk:1.0.x'
Copied!
Get latest release number HERE.
Additionally, if you want to use the Chromecast feature, add the following dependencies to your project:
1
        // for ChromeCast
2
        implementation 'androidx.mediarouter:mediarouter:1.0.0'
3
        implementation 'com.google.android.gms:play-services-cast-framework:18.1.0'
Copied!
if you use android support compat
1
        // for ChromeCast
2
        implementation 'com.android.support:mediarouter-v7:28.0.0'
3
        implementation 'com.google.android.gms:play-services-cast-framework:16.2.0' // from 17.x support androidx only
Copied!
If advertising support should be enabled, also add the following dependencies to your project:
1
        // for IMA Ads
2
        implementation 'com.google.android.exoplayer:extension-ima:2.10.8'
3
        implementation 'com.google.android.gms:play-services-ads:19.0.1' // from 18.x support androidx only
Copied!
Note:
The version of the ExoPlayer Extension IMA must match the version of the ExoPlayer library being used.
If you are using both ChromeCast and IMA Ads dependencies, we recommend using dependency com.google.android.gms:play-services-cast-framework:$version with version >= 18.1.0 or version=16.2.0 (support compat) to avoid dependency version conflicts
Check example here.
Turn on Java 8 support
If not enabled already, you need to turn on Java 8 support in all build.gradle files depending on ExoPlayer, by adding the following to the android section:
1
compileOptions {
2
  targetCompatibility JavaVersion.VERSION_1_8
3
}
Copied!
Node, Inside v1:
Use androidx​
Use Timber for logger
Init SDK
1.Init UZPlayer
1
public class App extends MultiDexApplication {
2
       @Override
3
       public void onCreate() {
4
           super.onCreate();
5
           UZPlayer.init();
6
       }
7
}
Copied!
2.If you want show log, install any Tree instances you want in the onCreate of your application class
1
	if (BuildConfig.DEBUG) {
2
            Timber.plant(new Timber.DebugTree());
3
        }
Copied!
Manifest
1
    <application
2
      android:name=".App"
3
    >
Copied!
How to play the video?:
XML
1
    <com.uiza.sdk.view.UZVideoView
2
      android:id="@id/uiza_video"
3
      android:layout_width="match_parent"
4
      android:layout_height="wrap_content" />
Copied!
JAVA
1
Create java file MainActivity:
2
​
3
    public class MainActivity extends AppCompatActivity implements UZCallback {
4
       ...
5
    }
Copied!
Manifest
1
    <activity
2
      android:name=".MainActivity "
3
      android:configChanges="keyboard|keyboardHidden|orientation|screenSize|screenLayout|smallestScreenSize|uiMode" />
Copied!
In your activity or fragment
Play with entity:
1
uzVideo = (UZVideoView) findViewById(R.id.uiza_video);
2
uzVideo.setUZCallback(this);
3
uzVideo.play(UZPlayback playback);
4
// or 
5
UZPlayer.setCurrentPlayback(UZPlayback playback);
6
uzVideo.play();
7
// or playlist
8
uzVideo.play(List<UZPlayback> playlist);
Copied!
Don't forget to add in activity life cycle event:
1
    @Override
2
    public void onDestroy() {
3
        uzVideo.onDestroy();
4
        super.onDestroy();
5
    }
6
​
7
    @Override
8
    public void onResume() {
9
        uzVideo.onResume();
10
        super.onResume();
11
    }
12
​
13
    @Override
14
    public void onPause() {
15
        uzVideo.onPause();
16
        super.onPause();
17
    }
18
​
19
    @Override
20
    public void onActivityResult(int requestCode, int resultCode, Intent data) {
21
        uzVideo.onActivityResult(resultCode, resultCode, data);
22
        super.onActivityResult(requestCode, resultCode, data);
23
    }
Copied!
How to customize your skin?
Only 3 steps, you can customize everything about player skin.
Step 1: Create layout uzplayer_skin_custom.xml like THIS:
Please note app:controller_layout_id="@layout/uz_controller_custom_layout"
Step 2: Create layout uz_controller_custom_layout.xml like THIS:
In this xml file, you can edit anything you like: position, color, drawable resouces...
You can add more view (TextView, Button, ImageView...).
You can remove any component which you dont like.
Please note: Don't change any view ids if you are using it.
Step 3: On function onCreate() of Activity, put this code:
1
    UZPlayer.setUZPlayerSkinLayoutId(R.layout.uzplayer_skin_custom);
Copied!
Ex:
1
    @Override
2
    protected void onCreate(@Nullable Bundle savedState) {
3
		UZPlayer.setUZPlayerSkinLayoutId(R.layout.uzplayer_skin_custom);
4
        super.onCreate(savedState);
5
    }
Copied!
Note: If you are using Chromecast, please use UZPlayer.setCasty(Activity activity) on function onCreate() of Activity
1
    @Override
2
    protected void onCreate(@Nullable Bundle savedState) {
3
        UZPlayer.setCasty(this);
4
        UZPlayer.setUZPlayerSkinLayoutId(R.layout.uzplayer_skin_custom);
5
        super.onCreate(savedState);
6
    }
Copied!
Ex: findView from your custom layout:
1
    TextView tvSample = uzVideo.findViewById(R.id.tv_sample);
Copied!
That's enough! This code above will change the player's skin quickly. You can build and run your app now.
But if you wanna change the player's skin when the player is playing, please you this function:
1
    uzVideo.changeSkin(R.layout.uzplayer_skin_custom);
Copied!
Note:
You should not change the id of the view. Ex: android:id="@id/player_view" Do not change android:id="@id/player_view_0" or android:id="@+id/player_view_0" ...
Picture In Picture (PIP)
1.You can use UZDragView, review PlayerActivity​
2.From Android Nougat (Android SDK >= 24) Google supported PIP. To implement, in AndroidManifest.xml add android:supportsPictureInPicture="true" inside Your Activity and review PIPPlayerActivity.
R8 / ProGuard
Do not support R8
1
    buildTypes {
2
    release {
3
        minifyEnabled true
4
        shrinkResources true
5
        useProguard true
6
        proguardFiles = [
7
            getDefaultProguardFile('proguard-android.txt'),
8
            'proguard-rules.pro'
9
        ]
10
    }
11
    }
Copied!
For contributors
Uiza Checkstyle configuration is based on the Google coding conventions from Google Java Style that can be found at here.
Your code must be followed the rules that defined in our uiza_style.xml rules​
You can setting the rules after import project to Android Studio follow below steps:
1.File > Settings > Editor > Code Style
2.Right on the Scheme, select the setting icon > Import Scheme > Intellij IDEA code style XML
3.Select the uiza_style.xml file path
4.Click Apply > OK, then ready to go
For apply check style, install CheckStyle-IDEA plugin, then
1.File > Settings > Other Settings > Checkstyle
2.In Configuration file, select the + icon
3.Check Use local checkstyle file & select path to uiza_check.xml file
4.Select OK & you're ready to go
To run checkstyle for project
1.Right click on project
2.Select Analyze > Inspect Code
Reference
​API Reference​
Supported devices
Support all devices which have Android 5.0 (API level 21) above. For a given use case, we aim to support UizaSDK on all Android devices that satisfy the minimum version requirement.
Note: Some Android emulators do not properly implement components of Android’s media stack, and as a result do not support UizaSDK. This is an issue with the emulator, not with UizaSDK. Android’s official emulator (“Virtual Devices” in Android Studio) supports UizaSDK provided the system image has an API level of at least 23. System images with earlier API levels do not support UizaSDK. The level of support provided by third party emulators varies. Issues running UizaSDK on third party emulators should be reported to the developer of the emulator rather than to the UizaSDK team. Where possible, we recommend testing media applications on physical devices rather than emulators.
Error message
Check this class you can know error code and error message when use UZPlayer.
Support
If you've found an error in this sample, please file an issue​
Patches are encouraged, and may be submitted by forking this project and submitting a pull request through GitHub. Please feel free to contact me anytime: [email protected] for more details.
Address: 33 Ubi Avenue 3 #08- 13, Vertex Tower B, Singapore 408868 Email: [email protected] Website: uiza.io​
License
UizaSDK is released under the BSD license. See LICENSE for details.