From a16b36a1473f66a38a474f1e92211bc67719be33 Mon Sep 17 00:00:00 2001 From: ThibaultBee <37510686+ThibaultBee@users.noreply.github.com> Date: Mon, 30 Mar 2020 19:32:34 +0200 Subject: [PATCH] build(*): prepare for version 0.8.0 --- README.md | 31 +++++++++++++++++++++++++++---- chat/build.gradle | 2 +- lib/build.gradle | 2 +- 3 files changed, 29 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 462dcd00..5ebbeca2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,27 @@ +[![](https://jitpack.io/v/ThibaultBee/SRTWrapper.svg)](https://jitpack.io/#ThibaultBee/SRTWrapper) + # Android SRT Wrapper Low level API for SRT library on Android. SRT is an open source transport technology that optimizes streaming performance across unpredictable networks. More information on https://github.com/Haivision/srt. -## Repository +## Setup Get SRT Wrapper lastest artifacts on [jitpack.io](https://jitpack.io/#ThibaultBee/SRTWrapper) +```gradle +allprojects { + repositories { + ... + maven { url 'https://jitpack.io' } + } +} + +dependencies { + implementation 'com.github.ThibaultBee:SRTWrapper:0.8.0' +} +``` + + ## Samples To test Android SR Wrapper, you will need 2 Android devices: one client and one server. @@ -29,14 +45,21 @@ Chat is an SRT utility to send and receive messages. It provides both a client a As Android SRT Wrapper is a wrapper (obvioulsy) for API documentation refers to [SRT API documentation](https://github.com/Haivision/srt/blob/master/docs/API.md). You must create a [Srt object](https://github.com/ThibaultBee/SRTWrapper/blob/master/lib/src/main/java/com/github/thibaultbee/srtwrapper/Srt.kt) before calling any other API. It will load SRT, ssl and crypto libraries. -## Permission +## Permissions You need to add the INTERNET permission in your AndroidManifest.xml: ```xml ``` +To use, sendFile and recvFile, you might also add READ_EXTERNAL_STORAGE and WRITE_EXTERNAL_STORAGE +```xml + + +``` +For Android > 6.0, you have to request permissions at runtime. + ## Build -As it downloads and builds SRT, OpenSSK (ssl and crypto) libraries, first compilation will take a while. -Android SRT Wrapper builds on a Linux. As OpenSSL requires GNU make, it might be tricky to build this project on Windows. +As it downloads and builds SRT, OpenSSL (ssl and crypto) libraries, first compilation will take a while. +Android SRT Wrapper is designed to build on a Linux platform. As OpenSSL is really tricky to cross-compile on Windows, you can't build on Windows. diff --git a/chat/build.gradle b/chat/build.gradle index 1bf6cd4f..595e609b 100644 --- a/chat/build.gradle +++ b/chat/build.gradle @@ -13,7 +13,7 @@ android { minSdkVersion 21 targetSdkVersion 29 versionCode 1 - versionName "1.0" + versionName "0.8.0" testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" } buildTypes { diff --git a/lib/build.gradle b/lib/build.gradle index 19421eb5..7821246d 100644 --- a/lib/build.gradle +++ b/lib/build.gradle @@ -14,7 +14,7 @@ android { minSdkVersion 21 targetSdkVersion 29 versionCode 1 - versionName "1.0" + versionName "0.8.0" testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" consumerProguardFiles 'consumer-rules.pro'