Skip to content

Latest commit

 

History

History
252 lines (175 loc) · 8.27 KB

README.md

File metadata and controls

252 lines (175 loc) · 8.27 KB
Raw

hyconet4j

Hybridcast-Connect reference SDK for Java

Japanese

Overview

"hyconet4j" is the java based reference implementation SDK of the "Hybridcast-Connect" that was standardized at Sep.2018 in IPTV Forum Japan. Hybridcast-Connect can realize to control some parts of the functions of a tuner on a TV Set from a application outside of the tuner , and communicate with text message between the TV Set and some applications. The OSS, "hyconet4j" is the part of the test tool that has been utilized as conformance test tool of the "Hybridcast-Connect" protocol in IPTV Forum Japan.

For more detail, see Hybridcast-Connect instruction. For use of "hyconet4j", see LICENSE and NOTICE.

Hybridcast-Connect Overview

Environment

  • Java8-SE(JDK8-191+)互換JDK
    • OpenJDK 8+
    • Amazon Corretto 8+
  • Android0S 8+ に組込ライブラリとして動作
  • gradle(4.10+)でのコンパイル

Build

run gradle commmand as follows.

# gradleでビルド
$ ./gradlew
# buildフォルダにjarを生成
$ ls ./build/libs
>> hyconet4j-x.y.z.jar

Directories

./sample

  • Test*.java (sample code)
  • build.gradle (build setting)
  • test.sh (script for running sample code)
  • build_run.sh (Gradle build of sample code, and running test.sh)

./libs

Libraries copied from build directory after building "hyconet4j" from source.

  • Jar package as SDK Library

    • hyconet4j-x.y.z.jar

  • Dependencies

    • commons-codec-1.10.jar
    • netty-buffer-4.1.48.Final.jar
    • netty-codec-4.1.48.Final.jar
    • netty-codec-http-4.1.48.Final.jar
    • netty-common-4.1.48.Final.jar
    • netty-resolver-4.1.48.Final.jar
    • netty-transport-4.1.48.Final.jar
    • cybergarage-upnp-core-2.1.1.jar (NOTICE: see License)
    • JSON-java-20170220.jar (NOTICE: see License)

./build

directory generated when building "hyconet4j" from source.

./docs

Reference documents.

  • apidocs.md

    Simple API reference of "hyconet4j" and examples of these APIs. For more detail, see javadoc generated when building "hyconet4j" from source.

HowToUse

Example

import jp.or.nhk.rd.hyconet4j.TVRCMan;
import jp.or.nhk.rd.hyconet4j.TVRCStatus;
import jp.or.nhk.rd.hyconet4j.TVRCDevinfo;

//機器サーチと発見時のコールバック処理指定
TVRCMan tvrcman = new TVRCMan() {
        int devcount = 0;
        public void onDeviceRegistered(TVRCDevinfo devinfo) {
            System.out.print("Device Found[" + devcount++ + "]: " );
        }
}
// 7秒毎の機器サーチ実行。機器が見つかったら終了。
while(true){
    tvrcman.searchStart();
    try{
        Thread.sleep(7000);
    }catch(InterruptedException e){ }
    tvrcman.searchStop();
    // 機器が見つかったらサーチ終了。
    if (tvrcman.getTVRCDevList().size() >= 1){
        break;
    }
}

// サーチした機器からデバイスのオブジェクトを取得
ListTVRCDevinfo devlist = TVRCMan.getTVRCDevList();

// 実行対象のデバイスのオブジェクトを選択
TVRCDevinfo tvdev = TVRCMan.getTVRCDevinfo(int index);


///////////////// Hybridcast-Connect APIs //////////////////////
//
//////// 外部起動API
//
// 利用可能メディア(TD:地上波、BS、CS, ABS, ACS, NCS)
status = tvdev.getAvailableMedia();
// 受信機が選局可能な地上波のチャンネル（編成チャンネル）一覧
status = tvdev.getChannelInfo("TD"); 

// 選局・ハイブリッドキャスト起動のためのオブジェクト作成
JSONObject appInfo =
    new JSONObject()
        .put("resource", new JSONObject()  // 編成チャンネルリソースオブジェクト: 放送局とサービスメディアを特定
            .put("original_network_id", 32736)
            .put("transport_stream_id", 32736)
            .put("service_id", 1024))
        .put("hybridcast", new JSONObject()  // Hybridcastオブジェクト: 外部起動するHCアプリのリソース情報
            .put("orgid", 16)  // Hybridcastアプリに割り当てられたorgid
            .put("appid", 1)   // Hybridcastアプリに割り当てられたappid
            .put("aiturl", "http://example.com/ait/sample.ait")  // 起動したいHCアプリのAIT(ApplicationInformationTable)のURL--AITファイルにwebアプリのURLが記述されている
        );
// 選局要求のみ
status = tvdev.startAITControlledApp( "tune", appInfo.toString() );
// 選局+Hybridacst起動要求
status = tvdev.startAITControlledApp( "app", appInfo.toString() );
// BroadcastIndependentApp起動
status = tvdev.startAITControlledApp( "bia", appInfo.toString() );

// 起動要求成否取得
status = tvdev.getTaskStatus();

// 受信機状態（ブラウザ起動状態など）取得
status = tvdev.getReceiverStatus();



//////// 連携端末プロトコルAPI

// websocketメッセージ受信用Listener -- 以下のcallback用Interfaceを実装してHCListenerにセット、
tvdev.setHCListener(new HCListener() {
    @Override
    public void wsDataReceived(String str) {
        System.out.println( "*** TestTVRC::wsDataReceived" );
        System.out.println( "websocketReceivedMessage=" + str );
    }
   }
});

// 端末連携のwebsocket接続
tvdev.connWebsocket();

// websocketでのメッセージ送信
tvdev.sendWebsocket("---message string---");

// 端末連携のwebsocket接続
tvdev.disconnWebsocket();

For more informatin, see APIDOCS or sample source code.

Sample Code Package

Sample

The sample shows how to run the APIs of "hyconet4j" SDK.

Discovery -> Get the list of devices -> select device -> call APIs of "hybridcast-Connect" as a client.

.
├── TestHCEX.java              -- sample source.
├── build.gradle               -- gradle setting file.
├── test.sh                    -- runner of the sample.
  • run the sample as like command-line tool

The sample can run by inputting command as like command-line tool.

The input command can be interpreted as follows.

- "VK_X" or "X" are interpreted as the same command.
- Available commands are listed in sample source. Typing "help" command can also shows the breif list of the commands.

# Waiting for user input.

--)  1
（It is equivalent to the command "VK_1".

--) getchannels
（It is equivalent to the command "VK_getchannels".

How to run the sample

The sample runs as follows.

$ cd sample
$ ./gradlew
$ ./test.sh

License

See LICENSE.txt and NOTICE.txt.

And see additional side information: "hyconet4j" repository includes third party's oss jar packages themselves below in some reason: