bboxapi-stb

Bbox Miami API library for Kotlin/Java/Android

License

License

GroupId

GroupId

fr.bmartel
ArtifactId

ArtifactId

bboxapi-stb
Last Version

Last Version

1.2.7
Release Date

Release Date

Type

Type

jar
Description

Description

bboxapi-stb
Bbox Miami API library for Kotlin/Java/Android
Project URL

Project URL

https://github.com/bertrandmartel/bboxapi-stb
Source Code Management

Source Code Management

https://github.com/bertrandmartel/bboxapi-stb

Download bboxapi-stb

How to add to project

<!-- https://jarcasting.com/artifacts/fr.bmartel/bboxapi-stb/ -->
<dependency>
    <groupId>fr.bmartel</groupId>
    <artifactId>bboxapi-stb</artifactId>
    <version>1.2.7</version>
</dependency>
// https://jarcasting.com/artifacts/fr.bmartel/bboxapi-stb/
implementation 'fr.bmartel:bboxapi-stb:1.2.7'
// https://jarcasting.com/artifacts/fr.bmartel/bboxapi-stb/
implementation ("fr.bmartel:bboxapi-stb:1.2.7")
'fr.bmartel:bboxapi-stb:jar:1.2.7'
<dependency org="fr.bmartel" name="bboxapi-stb" rev="1.2.7">
  <artifact name="bboxapi-stb" type="jar" />
</dependency>
@Grapes(
@Grab(group='fr.bmartel', module='bboxapi-stb', version='1.2.7')
)
libraryDependencies += "fr.bmartel" % "bboxapi-stb" % "1.2.7"
[fr.bmartel/bboxapi-stb "1.2.7"]

Dependencies

runtime (4)

Group / Artifact Type Version
de.mannodermaus.rxjava2 » rxbonjour jar 2.0.0-RC1
de.mannodermaus.rxjava2 » rxbonjour-platform-desktop jar 2.0.0-RC1
com.github.kittinunf.fuel : fuel-gson jar 2.0.1
com.squareup.okhttp3 : okhttp jar 3.10.0

Project Modules

There are no modules declared in this project.

BboxApi STB client library

Build Status Download Maven Central Javadoc codecov License

Bbox Miami API client library for Kotlin/Java/Android

Go to Documentation

Features

MDNS

  • discover Rest API service
  • discover Websocket API service (only for next version)

REST

Actions & Resources

  • get channel list (GET /media/tvchannellist)
  • get list of Android apps installed (GET /applications)
  • get information about a specific installed Android app (GET /applications/$packageName)
  • get application icon (GET /applications/$packageName/image)
  • get current channel (GET /media)
  • get volume (GET /userinterface/volume)
  • start application (POST /applications/$packageName)
  • display toast (POST /userinterface/toast)
  • set volume (POST /userinterface/volume)
  • get VOD catalog (GET /media/vod) (cloud)
  • get EPG catalog (GET /media/live) (cloud)

Notifications

  • register application for notifications (POST /applications/register)
  • get all opened notification channels (GET /notification)
  • subscribe notification with specific resource type (POST /notification)
  • unsubscribe notification channel (DELETE /notification/$channelId)
  • create a notification on a specific channel (POST /notification/$channelId)

Websocket

  • open websocket stream for receiving notifications
  • parse notification messages : channel change, application state, error message

Tests

Run test on mockserver :

./gradlew test

External Library

  • Fuel: Http client for REST API
  • Gson : deserialize JSON objects
  • RxBonjour : MDNS discovery
  • OkHttp : websocket client

API documentation

https://api.bbox.fr/doc/#API%20Box

License

The MIT License (MIT) Copyright (c) 2018 Bertrand Martel

Versions

Version
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.1.10
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.3
1.0.1