Velocee/velocee_android_sdk

Velocee android sdk beta

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.Velocee:velocee_android_sdk_beta:'
	}

	dependencies {
		implementation("com.github.Velocee:velocee_android_sdk_beta:")
	}

	<dependency>
	    <groupId>com.github.Velocee</groupId>
	    <artifactId>velocee_android_sdk_beta</artifactId>
	    <version></version>
	</dependency>


                            
    libraryDependencies += "com.github.Velocee" % "velocee_android_sdk_beta" % ""


                            
    :dependencies [[com.github.Velocee/velocee_android_sdk_beta ""]]

Readme

SDK Integration

Project Integration

The descriptions below include details and elaboration from the Quick Start section above. Download vlc-android-sdk as a zip file and extract it. Copy the veloceeSDK.aar (optional: veloceeSDK_UI.aar - see InstantRadio section) folder to the project libs folder

Add to the application gradle file in the dependency section: dependencies { compile (name:'veloceeSDK', ext:'aar') } repositories { flatDir { dirs 'libs' } }

optional link against veloceeSDK_UI.aar as well in the same manner

The SDK uses the following third party libraries GSON https://sites.google.com/site/gson/gson-user-guide JS https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino OkHTTP http://square.github.io/okhttp/ Retrofit http://square.github.io/retrofit/

Add dependencies to your application gradle file: dependencies { compile 'com.android.support:appcompat-v7:23.1.1' compile 'com.google.code.gson:gson:2.3' compile 'com.google.android.gms:play-services-location:8.1.0' compile 'com.squareup.retrofit:retrofit:1.9.0' compile 'com.squareup.okio:okio:1.4.0' compile 'com.squareup.okhttp:okhttp:2.4.0' }

Code Integration

Usage Get the sdk instance by calling VlcSdk.getObj() which returns an IVlcSDK inteface Initializing The library requires a one time initialization upon application startup. You should call the method VlcSdk.getObj().start preferably in your application.onCreate() method VlcSdk.getObj().start(getApplicationContext(),"sdk-key");

Getting Cached items From Within a Native View

In order to use Velocee’s cache from non-webview view the application must change the relevant image & video urls to serve the content locally. The SDK provides several conversion methods for convenience: String getCachedResourceUrl(String originalUrl) receives the URL (as string) and returns the resource-from-cache URL. URL getCachedResourceUrlUrl(URL originalUrl) is similar to the above but receives and returns a URL instead of string. Both methods returns the input unchanged in case the input URL cannot be found in the cache. Bitmap getCachedResourceData(String originalUrl) the URL (as string) and returns an image bitmap info in case the resource can be found in cache, null otherwise

Using Within a WebView

The Velocee SDK provides a WebView delegate for the application’s WebView to use. In order to use Velocee’s WebView delegate you should use the SDK’s setDelegate method instead of the web view one. In case the application has a webview delegate it will be chained. WebViewClient vlcClient = VlcSdk.getObj().setDelegate(new MyWebViewClient()); myWebView.setWebViewClient(vlcClient);

Add Labels

Your application data needs to be labeled in order to fine tune Velocee's recommendation algorithm. Any text can be used as a label. In order to set the current label use the setTag method – void setTag(String tag) tag. Once a label is set it affects all resources until a new label is set or the application is idle for a period of time.

InstantRadio Integration

The Velocee InstantRadio module plays user adapted audio content to the user. In order to use the prebuilt InstantRadio UI player in conjunction with InstantRadio module copy veloceeSDK_UI.aar library to the libs folder of your project

In order to be notified when a new playlist is dowloaded (so it may be played), call registerPlaybackEvents(IPlaybackEvents rcv) supplying an instance implementing OnPlaylistLoaded(List<String> trackNames)

When the event fires, play() may be called in order for the playlist to start playing sequentially

Interfaces

IVlcPlaybackEvents interface definition of callback invoked when the player loads a new playlist or a new media file started playing. use audioRegisterPlaybackEvents/audioUnregisterPlaybackEvents methods to register for playback notifications

void OnTrackStart(String title, String author, int lengthInMillis) A new media track has started playing void OnPlaylistLoaded(List<String> trackNames) A new playlist has downloaded listing its track titles

Public methods

void startAudio() Opens a sample Velocee branded audio player activity

void audioPlay() Starts / resumes playback

void audioPrev() Starts playback of the previous track in the playlist

void audioNext() Starts playback of the next track in the playlist

void audioPause() Pauses playback

void audioPlayAtIndex(int index) Starts playback of a specific track

void startAudio(); Opens velocee sample audio player screen

boolean audioRegisterPlaybackEvents(IVlcPlaybackEvents rcv) void audioUnregisterPlaybackEvents(IVlcPlaybackEvents rcv) methods for (un)registering for playback events

void audioReleasePlayer() Releases resources associated with media player object

boolean audioIsPlaying() Checks whether the media player is playing

int audioGetProgress() Gets the current playback position in millisecods

VlcMediaInfo audioGetMediaInfo() returns track information. also see VlcMediaInfo definition

internal Classes

VlcMediaInfo basic track information String mTitle track title String mAuthor track author int mLengthInMillis track duration in milliseconds String mPlaylistUrl track’s played is part of the given playlist URL