README.md

SkyWayClient

SkyWayClient for Kotlin

Install

1. Add SkyWay Module

To get started, download the skyway.aar. Download it from the skyway-android-sdk release page.

Once downloaded, import skyway.aar into your android project to create the skyway module.

How to add an aar file as a module

2. GitHub Packages Setting

Add the maven configuration to the build.gradle of your project.

How to create a personal access token

allprojects {
    repositories {
        ...
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/Takahana/SkyWayClient")
            credentials {
                username = YOUR_GITHUB_USERNAME
                password = YOUR_GITHUB_TOKEN
            }
        }
    }
}

3. Add Dependencies

dependencies {
    ...
    implementation "tech.takahana.skywayclient:skywayclient:1.0.0"
    implementation project(":skyway")
}

Usage

<resources>
    <!-- SkyWay API Key -->
    <string name="skyway_api_key" translatable="false"><!-- YOUR_API_KEY --></string>
    <string name="skyway_domain" translatable="false"><!-- YOUR_DOMAIN --></string>
</resources>

class MainActivity : AppCompatActivity() {
    ...
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        if (!::skyWayClient.isInitialized) skyWayClient =
            SkyWayClient(this).initialize()

        start_btn.setOnClickListener {
            startConnection()
        }
    }

    private fun startConnection() {
        lifecycleScope.launchWhenResumed {
            skyWayClient.connect()
                .catch { error ->
                    // handle exception: ex) permission denied
                    Log.e("_ERROR_", "${error.message}")
                }
                .collect {
                    when (it) {
                        SkyWayEvent.PeerEvent.OPEN -> joinRoom(listenOnly = true)
                    }
                }
        }
    }

    private fun joinRoom(listenOnly: Boolean) {
        lifecycleScope.launchWhenResumed {
            skyWayClient.joinRoom(ROOM_ID, listenOnly).collect { event ->
                if (event == SkyWayEvent.RoomEvent.OPEN) {
                    // connection complete
                }
            }
        }
    }
    ...
}