Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inplayer-org/inplayer-android-sdk
InPlayer's Android API Client Wrapper
https://github.com/inplayer-org/inplayer-android-sdk
Last synced: about 2 months ago
JSON representation
InPlayer's Android API Client Wrapper
- Host: GitHub
- URL: https://github.com/inplayer-org/inplayer-android-sdk
- Owner: inplayer-org
- License: mit
- Created: 2018-12-12T11:15:34.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2022-08-22T11:34:54.000Z (over 2 years ago)
- Last Synced: 2023-03-02T10:05:37.472Z (almost 2 years ago)
- Language: Kotlin
- Homepage: https://inplayer-org.github.io/inplayer-android-sdk/
- Size: 2.48 MB
- Stars: 5
- Watchers: 16
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
InPlayer's Android SDK
InPlayer's Android API Client Wrapper
## Requirements
* Android Studio
* Min Sdk Version 17
## Dependency
Add this in your root build.gradle file (not your module build.gradle file):
Add this in your root `build.gradle` file (**not** your module `build.gradle` file):
```gradle
allprojects {
repositories {
maven { url "https://jitpack.io" }
}
}
```
Then, add the library to your project `build.gradle`
```gradle
dependencies {
implementation 'com.github.inplayer-org.inplayer-android-sdk:InPlayer:${latest_version_here}'
}
```
replacing `latest_version_here` with the latest released version (see JitPack badge above)
## Usage
### Setup
Initialize InPlayer in a custom class that extends `Application`:
```java
import android.app.Application;
public class App extends Application {
@Override
public void onCreate() {
super.onCreate();
InPlayer.initialize(new InPlayer.Configuration.Builder(this, "YOUR_MERCHANT_UUID_HERE")
//Optional
.withReferrer("YOUR_REFERRER_STRING_HERE")
//Optional -Default is set to Production
.withEnvironment(InPlayer.EnvironmentType.STAGING)
.build());
}
}
```
The custom `Application` class must be registered in `AndroidManifest.xml`:
```xml
...
```
### Services
InPlayerSDK consists out of four services:
`Account`, `Asset`, `Payment` and `Notification`.
#### Account
Account related methods.
##### Kotlin Example
```kotlin
import com.sdk.inplayer.configuration.InPlayer
InPlayer.Account.authenticate("YOUR_USERNAME_HERE", "YOUR_PASSWORD_HERE", InPlayerCallback { inPlayerUser, error ->
if (error == null) {
//SUCCESS - Handle InPlayerUser
} else {
//Handle Error
}
})
```
#### Java Example
```java
import com.sdk.inplayer.configuration.InPlayer
InPlayer.Account.authenticate("YOUR_USERNAME_HERE", "YOUR_PASSWORD_HERE", new InPlayerCallback() {
@Override
public void done(InPlayerAuthorizationModel value, InPlayerException exception) { }
});
```
##### Asset
Asset related methods
###### Example
Get item details:
#### Kotlin Example
```kotlin
import com.sdk.inplayer.configuration.InPlayer
InPlayer.Assets.getItemDetails(ITEM_ID_HERE, InPlayerCallback { inPlayerItem, error ->
if (error == null) {
//SUCCESS - Handle InPlayerItem
} else {
//Handle Error
}
})
```
#### Java Example
```java
import com.sdk.inplayer.configuration.InPlayer;
InPlayer.Assets.getItemDetails(ITEM_ID_HERE, new InPlayerCallback() {
@Override
public void done(InPlayerItem value, InPlayerException exception) { }
});
```
##### Payment
Payment related methods
###### Example
Validates an In App purchase from Google Play store services:
#### Kotlin Example
```kotlin
import com.sdk.inplayer.configuration.InPlayer
/**
* Validates an In App purchase from Google Play store services
*
*
* @param receipt String The Purchase object from Google Play response after a successful purchase
* @param productName String Product Name
* @param callback InPlayerCallback
*/
InPlayer.Payment.validate(receipt, productName, brandingId, InPlayerCallback { _, error ->
if (error == null) {
//SUCCESS - Handle Payment Receipt
} else {
//Handle Error
}
})
```
#### Java Example
```java
import com.sdk.inplayer.configuration.InPlayer;
/**
* Validates an In App purchase from Google Play store services
*
*
* @param receipt String The Purchase object from Google Play response after a successful purchase
* @param productName String Product Name
* @param callback InPlayerCallback
*/
InPlayer.Payment.validate(receipt, productName, brandingId, new InPlayerCallback() {
@Override
public void done(String value, InPlayerException exception) { }
});
```
Additionally when checking access for asset, in itemAccess.item there is content that can be plain string or json string.
In order to parse the model accordingly and have access to its properties (every type has different properties)
All class types are under the sealed class ```kotlin InPlayerItem.InPlayerAsset ```
If we know for certain what type we should get back in response we can directly cast the InPlayerAsset like:
```java
InPlayer.Assets.checkAccessForAsset(ASSET_ID, InPlayerCallback { itemAccess, error ->
if (error == null) {
val sportsRadar = itemAccess.itemEntity.content as InPlayerItem.InPlayerAsset.SportRadar
} else {
//Handle Error
}
})
```
We can also use the kotlin when function for this case:
```java
when(itemAccess.itemEntity.content){
is InPlayerItem.InPlayerAsset.Accedo -> // Continue working with your object
is InPlayerItem.InPlayerAsset.Brightcove -> // Continue working with your object
is InPlayerItem.InPlayerAsset.Cloudfront -> // Continue working with your object
is InPlayerItem.InPlayerAsset.DaCast -> // Continue working with your object
is InPlayerItem.InPlayerAsset.JwPlayer -> // Continue working with your object
is InPlayerItem.InPlayerAsset.Laola -> // Continue working with your object
is InPlayerItem.InPlayerAsset.Kaltura -> // Continue working with your object
is InPlayerItem.InPlayerAsset.Livestream -> // Continue working with your object
is InPlayerItem.InPlayerAsset.Qbrick -> // Continue working with your object
is InPlayerItem.InPlayerAsset.SportOne -> // Continue working with your object
is InPlayerItem.InPlayerAsset.SportRadar -> // Continue working with your object
is InPlayerItem.InPlayerAsset.StreamAMG -> // Continue working with your object
is InPlayerItem.InPlayerAsset.Wistia -> // Continue working with your object
is InPlayerItem.InPlayerAsset.Wowza -> // Continue working with your object
is InPlayerItem.InPlayerAsset.UnkownType -> // Unkown type, the response is returned as string value
}
```
##### Notification
Notification service has two methods:
Used for subscribtion, For best practice please subscribe for the notifications on your Activity/Fragment `onResume()` and call `dissconect()` on `onPause()` so we don't introduce memory leaks.
#### Kotlin Example
```kotlin
import com.sdk.inplayer.configuration.InPlayer
override fun onResume() {
super.onResume()
InPlayer.Notification.subscribe(object : InPlayerNotificationCallback {
override fun onStatusChanged(status: InPlayerNotificationStatus) { }
override fun onMessageReceived(message: InPlayerNotification) { }
override fun onError(t: InPlayerException) { }
})
}
```
#### Java Example
```java
@Override
protected void onResume() {
super.onResume();
InPlayer.Notification.subscribe(new InPlayerNotificationCallback() {
@Override
public void onStatusChanged(@NotNull InPlayerNotificationStatus status) {
}
@Override
public void onMessageReceived(@NotNull InPlayerNotification message) {
}
@Override
public void onError(@NotNull InPlayerException t) {
}
});
}
```
For disconnect
```java
@Override
protected void onPause() {
super.onPause();
InPlayer.Notification.disconnect();
}
```
## Contributing
We are thankful for any contributions made by the community. By contributing you agree to abide by
the Code of Conduct in the [Contributing Guidelines](https://github.com/inplayer-org/inplayer-ui/blob/master/.github/CONTRIBUTING.md).
## License
Licensed under the MIT License, Copyright © 2018-present InPlayer.
See [LICENSE](https://github.com/inplayer-org/inplayer-android-sdk/blob/master/LICENSE) for more information.