Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #41

Merged
merged 8 commits into from
May 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# 5GMS-Aware Applications
<h1 align="center">5GMS-Aware Applications</h1>

## Introduction

This repository holds applications that can be used to test and demonstrate other 5G-MAG Reference Tools related to 5GMS.

Expand All @@ -7,5 +9,4 @@ This repository holds applications that can be used to test and demonstrate othe
Each folder within the repository contains a different application with its own code, documentation and license file.
This is a list of the current applications available:
* [5GMSd-Aware Application](https://github.com/5G-MAG/rt-5gms-application/tree/development/fivegmag_5GMSdAwareApplication) (5G-MAG Public License v1.0): The 5GMSd Aware Application is an Android application that serves as a reference implementation for 5GMS downlink media streaming. It uses the Media Stream Handler for playback and communication with the Media Session Handler.
* [Exo DVB-I Player](https://github.com/5G-MAG/rt-5gms-application/tree/development/fivegmag_ExoDvbi_player) (5G-MAG Public License v1.0): This project uses the Android ExoPlayer and the DVB-I Reference Client functionality to provide the capabilities to select and play back media content.
* [Sample 5G-MAG Player](https://github.com/5G-MAG/rt-5gms-application/tree/main/fivegmag_sampleplayer) (5G-MAG Public License v1.0): an application for initial testing purposes which integrates an instance of Exoplayer and a hard-coded URL
* [Exo DVB-I Player](https://github.com/5G-MAG/rt-5gms-application/tree/development/fivegmag_ExoDvbi_player) (5G-MAG Public License v1.0 and MIT): This project uses the Android ExoPlayer and the DVB-I Reference Client functionality to provide the capabilities to select and play back media content.
17 changes: 8 additions & 9 deletions fivegmag_5GMSdAwareApplication/Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# 5GMSd-Aware Application

This repository holds the 5GMSd-Aware Application implementation of the 5G-MAG Reference Tools.
<h1 align="center">5GMSd-Aware Application</h1>
<p align="center">
<img src="https://img.shields.io/badge/Status-Under_Development-yellow" alt="Under Development">
<img src="https://img.shields.io/github/v/tag/5G-MAG/rt-5gms-application?label=version" alt="Version">
<img src="https://img.shields.io/badge/License-5G--MAG%20Public%20License%20(v1.0)-blue" alt="License">
</p>

## Introduction

Expand All @@ -13,6 +16,8 @@ web browser or via Inter Process Communication (IPC) for native Android applicat
5GMSd-Aware Application controls the Media Player via a UE-internal API defined at reference point
M7.

Additional information can be found at: https://5g-mag.github.io/Getting-Started/pages/5g-media-streaming/

### About the implementation

The 5GMSd-Aware Application is an Android application that serves as a reference implementation for
Expand All @@ -21,12 +26,6 @@ the [Media Stream Handler](https://github.com/5G-MAG/rt-5gms-media-stream-handle
communication with
the [Media Session Handler](https://github.com/5G-MAG/rt-5gms-media-session-handler).

### Specifications

A list of specification related to this repository is available in
the [Standards Wiki](https://github.com/5G-MAG/Standards/wiki/5G-Downlink-Media-Streaming-Architecture-(5GMSd):-Relevant-Specifications)
.

## Downloading

Release versions can be downloaded from
Expand Down
52 changes: 27 additions & 25 deletions fivegmag_ExoDvbi_player/README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,33 @@
# 5G MAG - Media Client for 5G media broadband/broadcast

<h1 align="center">Media Client for 5G Media Streaming / 5G Broadcast</h1>
<p align="center">
<img src="https://img.shields.io/badge/Status-Under_Development-yellow" alt="Under Development">
<img src="https://img.shields.io/github/v/tag/5G-MAG/rt-5gms-application-provider?label=version" alt="Version">
<img src="https://img.shields.io/badge/License-5G--MAG%20Public%20License%20(v1.0)-blue" alt="License">
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License">
</p>

## Introduction
This project uses the Android ExoPlayer and the DVB-I Reference Client functionality to provide the capabilities to select and play
back media content.

## ExoPlayer
### ExoPlayer

ExoPlayer is an application level media player for Android. It provides an
alternative to Android’s MediaPlayer API for playing audio and video both
locally and over the Internet. ExoPlayer supports features not currently
supported by Android’s MediaPlayer API, including DASH and SmoothStreaming
adaptive playbacks. Unlike the MediaPlayer API, ExoPlayer is easy to customize
and extend, and can be updated through Play Store application updates.
adaptive playbacks.

## DVB-I Reference Application

The DVB-I Reference Application project consists of a backend and frontend parts.
The backend allows generation and editing of DVB-I service lists.
A DVB-I backend is not an ingredient of this project but is expected to exist as an accessible service.
This project curently references the backend provided in scope of the DVB-I project:
http://stage.sofiadigital.fi/dvb/dvb-i-reference-application/backend/
The frontend referenced in this project is a DVB-I compatible PWA client for use with a browser.
https://stage.sofiadigital.fi/dvb/dvb-i-reference-application/frontend/android/player.html
This project is using Android WebView to display the DVB-I frontend to the user,
allowing the selection of available test streams.
WebView is part of the Android WebKit package. Required classes are listed below in the clause on dependencies.
The ExoPlayer instance within this project is called via WebView generated intents.
Unlike the MediaPlayer API, ExoPlayer is easy to customize
and extend, and can be updated through Play Store application updates.

## License notes
### DVB-I Reference Application

Please note that (1)ExoPlayer, (2)DVB-I client front end, (3)and the code managing the DVB-I frontend in scope of ExoPlayer, are distributed under their individual license.
Please note that the ExoPlayer code referenced by this project is licensed under Apache 2.0 license,
using this project also requires including of Android WebView classes.
The DVB-I frontend referenced by this project uses the MIT license.
The code managing the DVB-I frontend in scope of ExoPlayer is contributed under 5G-MAG Public License (v1.0).# DVBI App
The DVB-I Reference Application project consists of a backend and frontend parts:
* The backend allows generation and editing of DVB-I service lists. A DVB-I backend is not an ingredient of this project but is expected to exist as an accessible service. This project currently references the backend provided in scope of the DVB-I project: http://stage.sofiadigital.fi/dvb/dvb-i-reference-application/backend/
* The frontend referenced in this project is a DVB-I compatible PWA client for use with a browser: https://stage.sofiadigital.fi/dvb/dvb-i-reference-application/frontend/android/player.html. This project is using Android WebView to display the DVB-I frontend to the user, allowing the selection of available test streams. WebView is part of the Android WebKit package. Required classes are listed below in the clause on dependencies. The ExoPlayer instance within this project is called via WebView generated intents.

## How to build
## Building

Clone the repository, including submodules

Expand Down Expand Up @@ -65,8 +58,17 @@ In case of an error ```SDK location not found```, add a ```local.properties``` f
```
sdk.dir=/Users/<username>/Library/Android/sdk
```
## Installing

To install the APK on a device run:
```
adb -s <deviceID> install -r noDecoderExtensionsDvbiapp/release/demo-noDecoderExtensions-dvbiapp-release.apk
```

## License

Please note that (1)ExoPlayer, (2)DVB-I client front end, (3)and the code managing the DVB-I frontend in scope of ExoPlayer, are distributed under their individual license.
Please note that the ExoPlayer code referenced by this project is licensed under Apache 2.0 license,
using this project also requires including of Android WebView classes.
The DVB-I frontend referenced by this project uses the MIT license.
The code managing the DVB-I frontend in scope of ExoPlayer is contributed under 5G-MAG Public License (v1.0).# DVBI App
5 changes: 0 additions & 5 deletions fivegmag_sampleplayer/ATTRIBUTION_NOTICE

This file was deleted.