Android UI SDK integration

Integration options

The UI library is integrated mainly by importing its source code. You can integrate it as a whole, or by module/component. GitHub source code: https://github.com/seastart/meeting-andriod-demo

Whole integration

Add the Maven repository to the build.gradle in the root directory

allprojects {
    repositories {
        maven { url 'https://maven.open.seastart.cn/repository/maven-vcs/' }
    }
}

Import the StmLink library
Add the dependency to the build.gradle in the app directory

dependencies {
    implementation project(path: ':StmLink')
}

Module/component integration

Add the Maven repository to the build.gradle in the root directory

allprojects {
    repositories {
        maven { url 'https://maven.open.seastart.cn/repository/maven-vcs/' }
    }
}

Add the dependency to the build.gradle in the app directory

	dependencies {
    implementation 'cn.seastart.meeting:meeting:xxx'
	}

Copy the modules or components you need from the StmLink library into your project

Whole integration

Create a new project and import the StmLink library as described in Whole integration
Create MyApplication and implement the following code in it

override fun onCreate() {
    super.onCreate()
    // Initialize the library
    SeaStarClient.instance.SSC_Init(this)
    // Register a listener for activity lifecycle changes
    registerActivityLifecycleCallbacks(MyLifecycleCallback())
}

In MainActivity, navigate to a screen in the StmLink library

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
        ...
    Handler().postDelayed(
        {
            SeaStarClient.instance.SSC_StartHomeActivity(this@MainActivity)
            finish()
        }, 1000)
}

Implement the activity lifecycle listener. The LifecycleListener class comes from StmLink

class MyLifecycleCallback: Application.ActivityLifecycleCallbacks {

    private val lifecycleListener = LifecycleListener()

    override fun onActivityCreated(activity: Activity, savedInstanceState: Bundle?) {
        lifecycleListener.onActivityCreated(activity, savedInstanceState)
    }

    override fun onActivityStarted(activity: Activity) {
        lifecycleListener.onActivityStarted(activity)
    }

    override fun onActivityResumed(activity: Activity) {
        lifecycleListener.onActivityResumed(activity)
    }

    override fun onActivityPaused(activity: Activity) {
        lifecycleListener.onActivityPaused(activity)
    }

    override fun onActivityStopped(activity: Activity) {
        lifecycleListener.onActivityStopped(activity)
    }

    override fun onActivitySaveInstanceState(activity: Activity, outState: Bundle) {
        lifecycleListener.onActivitySaveInstanceState(activity, outState)
    }

    override fun onActivityDestroyed(activity: Activity) {
        lifecycleListener.onActivityDestroyed(activity)
    }
}

Module/component integration

Project structure

Modules: base module, login module, out-of-meeting info module, meeting entry module, and in-meeting module

stmlink/
├── aboutUs/                # About us
├── activity/               # Activity package
├── authorize/              # Login and registration module
│   └── login/                # Login
│   └── register/             # Registration
├── base/                   # BaseActivity and BaseFragment
├── contactDetail/          # Contact details
├── history/                # Meeting history
├── home/                   # Home page
│   └── contact/              # Contact list page
│   └── meet/                 # Upcoming meetings list page
│   └── mine/                 # "Me" page
├── http/                   # HTTP module
├── inviteMember/           # Member invitation module
├── meetDetail/             # Meeting details
├── meeting/                # In-meeting module
│   └── chat/                 # Chat page
│   └── member/               # In-meeting members page
│   └── room/                 # In-meeting main page
├── preMeetingRoom/         # Meeting entry module
├── service/                # Services
├── ui/                     # Custom UI
├── utils/                  # Utilities
└── webPage/                # Web pages

Base module

The base module includes the SDK entry class, the network request package, the custom UI package, and the utilities package.

Import

Copy the MeetingEngineHelper file and the http, ui, and utils folders under the cn.seastart.stmlink path into your project directory, and they are ready to use.

stmlink/
├── http/                   # HTTP module
├── ui/                     # Custom UI
├── utils/                  # Utilities
└── MeetingEngineHelper     # Unified SDK helper class

Usage

Using the SDK entry file

/**
 * Create the SDK
 */
MeetingEngineHelper.instance.createSDK(application)

/**
 * Initialize the SDK
 */
MeetingEngineHelper.instance.initSDK(token, null,
            object : MeetingResultCallback {
                override fun onFail(code: Int, errorMsg: String?, showMsg: String?) {
                    // Your handling
                }

                override fun onSuccess() {
                    // Your handling
                }
            }
        )

/**
 * Release resources
 */
MeetingEngineHelper.instance.release()


/**
 * Other API calls
 */

Using the network request module

/**
 * Call this at app startup to initialize the network request module
 * url: host address
 */
ApiHelper.instance.init(url)

/**
 * Reset the host address; the reset address is stored in the DOMAIN_URL field of KvUtil
 */
ApiHelper.instance.resetHost()

/**
 * Release resources
 */
ApiHelper.instance.release()


/**
 * Various network request APIs
 */

Using the custom UI package

It contains the custom components used in the project, which you can use by referencing them in XML layout files

Using the utilities package

It contains the utility classes used in the project, mostly static methods or singletons. The login and registration module mainly includes the login page, the registration page, and the member profile editing page This is an important module: without login, none of the subsequent operations can run correctly. This module implements app login authorization, Meet authorization, SDK initialization, and IM initialization. After app login authorization completes, you get an app-layer user token. Every app-layer network request must include this token in its request headers

Import

Copy the authorize folder under the cn.seastart.stmlink path into your project directory, and it is ready to use

stmlink/
├── authorize/              # Login and registration module
│   └── login/                # Login
│   └── register/             # Registration

Usage

Navigation

/**
 * Navigate to the login screen
 */
LoginActivity.startActivity(this)

SdkLoginHelper

This class implements login in one place. The main steps are: authorization -> SDK login -> IM login. It depends on MeetingEngineHelper (the SDK entry class wrapped at the app layer), so MeetingEngineHelper must be initialized first
When an app authorization token already exists and the SDK needs to log in automatically, you can use this class to log in from any screen

SdkLoginHelper.instance.login(object : SdkLoginHelper.LoginListener {
            override fun onSuccess() {
                // Your handling
            }

            override fun onFail(code: Int, errorMsg: String?, showMsg: String?) {
                // Your handling
            }
        })

Screenshots

Login page	Registration page	Profile editing page

Out-of-meeting info module

The out-of-meeting info module mainly includes the upcoming meetings page, the meeting history page, the meeting details page, the contact list page, the contact details page, and the “Me” page

Import

Copy the Home, history, meetDetail, and contactDetail packages under the cn.seastart.stmlink path into your project, and they are ready to use

stmlink/
├── contactDetail/          # Contact details
├── history/                # Meeting history
├── home/                   # Home page
│   └── contact/              # Contact list page
│   └── meet/                 # Upcoming meetings list page
│   └── mine/                 # "Me" page
├── meetDetail/             # Meeting details

Usage

/**
 * Navigate to the Home page, which includes the upcoming meetings page, the contact list page, and the "Me" page
 */
HomeActivity.startActivity(this)

/**
 * Navigate to the meeting history page
 */
 HistoryActivity.startHistoryListPage(this)

 /**
  * Navigate to the meeting details page
  * meetId: meeting ID
  */
 MeetDetailActivity.startMeetDetailPage(this, meetId)

 /**
  * Navigate to the contact details page
  * uid: contact uid
  */
 ContactDetailActivity.startContactInfoPage(requireContext(), uid)

Screenshots

Upcoming meetings page	Meeting history page

Meeting details page	Meeting details page

Contacts page	Contact details page	Contact editing page

”Me” page

Meeting entry module

The meeting entry module mainly includes the enter meeting page, the create instant meeting page, the create scheduled meeting page, and the member invitation page The enter meeting and create instant meeting pages go to the in-meeting page by default; the create scheduled meeting page goes to the upcoming meetings page by default

Import

Copy the preMeetingRoom and inviteMember packages under the cn.seastart.stmlink path into your project, and they are ready to use.

stmlink/
├── inviteMember/           # Member invitation module
├── preMeetingRoom/         # Meeting entry module

Usage

/**
 * Navigate to the enter meeting page
 */
PreMeetingActivity.startJoinMeetingPage(this)

/**
 * Navigate to the create instant meeting page
 */
PreMeetingActivity.startCreateImmediateMeetingPage(this)

/**
 * Navigate to the create scheduled meeting page, from which you can go to the member invitation page
 */
PreMeetingActivity.startCreateScheduleMeetingPage(requireContext())

Screenshots

Enter meeting page	Create instant meeting page	Create scheduled meeting page

Invitees page	Add invitees page

In-meeting module

The in-meeting module mainly includes the meeting main page, the member list page, the invite members page, and the chat page The meeting main page includes the single-member view, the multi-member view, the screen sharing view, the composite meeting view, and the quality monitoring data window When you exit the meeting main page, you return to the Home page by default

Import

Copy the inviteMember and Meeting packages under the cn.seastart.stmlink path into your project, and they are ready to use

stmlink/
├── inviteMember/           # Member invitation module
├── meeting/                # In-meeting module
│   └── chat/                 # Chat page
│   └── member/               # In-meeting members page
│   └── room/                 # In-meeting main page

Usage

/**
 * Navigate to the meeting main page
 * roomNo: room number
 * name: your own nickname
 * avatar: your own avatar
 * isOpenCamera: whether to turn on the camera
 * isOpenMic: whether to turn on the mic
 */
MeetingRoomActivity.startMeetingRoomPage(
    this, roomNo, name, avatar, 
    isOpenCamera, isOpenMic
)

Screenshots

Single-member view	Single-member view	Multi-member view

Screen sharing view	Audio routing dialog	Quality monitoring dialog

Member list page (host)	Host actions dialog	Member list page (regular member)

Chat page	File picker page

Overview

Low-code integration

Web SDK

Android SDK

Swift SDK (iOS/macOS)

Server API

Android UI SDK integration

Integration options

Whole integration

Module/component integration

Whole integration

Module/component integration

Project structure

Base module

Import

Usage

Using the SDK entry file

Using the network request module

Using the custom UI package

Using the utilities package

Import

Usage

Navigation

SdkLoginHelper

Screenshots

Out-of-meeting info module

Import

Usage

Screenshots

Meeting entry module

Import

Usage

Screenshots

In-meeting module

Import

Usage

Screenshots

​Integration options

​Whole integration

​Module/component integration

​Whole integration

​Module/component integration

​Project structure

​Base module

​Import

​Usage

Using the SDK entry file

Using the network request module

Using the custom UI package

Using the utilities package

​Login and registration module

​Import

​Usage

Navigation

SdkLoginHelper

​Screenshots

​Out-of-meeting info module

​Import

​Usage

​Screenshots

​Meeting entry module

​Import

​Usage

​Screenshots

​In-meeting module

​Import

​Usage

​Screenshots

Integration options

Whole integration

Module/component integration

Whole integration

Module/component integration

Project structure

Base module

Import

Usage

Login and registration module

Import

Usage

Screenshots

Out-of-meeting info module

Import

Usage

Screenshots

Meeting entry module

Import

Usage

Screenshots

In-meeting module

Import

Usage

Screenshots