olly 55d1abaa21 Document usage of the RTMP extension
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=164706135
2017-08-10 13:17:13 +01:00
..
2017-07-19 19:48:17 +01:00
2017-08-10 13:17:13 +01:00

ExoPlayer RTMP extension

Description

The RTMP extension is a DataSource implementation for playing RTMP streams using LibRtmp Client for Android.

Getting the extension

The easiest way to use the extension is to add it as a gradle dependency:

compile 'com.google.android.exoplayer:extension-rtmp:rX.X.X'

where rX.X.X is the version, which must match the version of the ExoPlayer library being used.

Alternatively, you can clone the ExoPlayer repository and depend on the module locally. Instructions for doing this can be found in ExoPlayer's top level README.

Using the extension

ExoPlayer requests data through DataSource instances. These instances are either instantiated and injected from application code, or obtained from instances of DataSource.Factory that are instantiated and injected from application code.

DefaultDataSource will automatically use uses the RTMP extension whenever it's available. Hence if your application is using DefaultDataSource or DefaultDataSourceFactory, adding support for RTMP streams is as simple as adding a dependency to the RTMP extension as described above. No changes to your application code are required. Alternatively, if you know that your application doesn't need to handle any other protocols, you can update any DataSources and DataSource.Factory instantiations in your application code to use RtmpDataSource and RtmpDataSourceFactory directly.