Skip to main content

Glossary

A

Access token

A short-lived token required by an application to use PlanetKit SDK.

Acoustic echo canceller (AEC)

A filter that removes only the echo from the sound picked up by the microphone.

API key

A key to call LINE Planet APIs (both PlanetKit SDK API and LINE Planet Cloud API). An application requires the API key to integrate LINE Planet. The format of API key must be as follows:

  • Allowed characters: Letters (a-z, A-Z), digits (0-9), hyphens ('-'), and underscores ('_')
  • Minimum length: 128 bytes

API secret

A value paired with the API key. API secret is issued along with the API key. Applications must store API secret in a secure location and keep it from being exposed. The format of API secret must be as follows:

  • Allowed characters: Lowercase letters from a to f (a-f) and digits (0-9)
  • Length: 64 bytes

App client

A client application integrating PlanetKit SDK. Users will use the app client developed by application development teams.

App server

A server application that has connectivity to LINE Planet servers. Application development teams will develop and maintain the app server.

Application

A client application and a server application that use LINE Planet Cloud.

Audio quality

The level of audio quality can be classified by the representable frequency range, as follows:

Audio qualityRepresentable frequency range
Narrowband (NB)4 kHz
High-definition (HD)8 kHz
High-definition+ (HD+)12–16 kHz
Full high-definition (FHD)22.05–24 kHz

Automatic gain controller (AGC)

A filter that maintains fluctuating voice volumes at a constant level.

C

Callee (Responder)

A counterpart of a caller. A caller makes a call to a callee.

Caller (Initiator)

A terminal device or end user that makes a new call.

Cellular call

A general phone call through cellular networks.

Cellular network

A mobile network. For example, 2G, 3G, 4G, or 5G.

E

Event and Event parameters

An event means a notification sent from PlanetKit to an application. In general, two events are involved when an application calls one PlanetKit API - a local event and a remote event. The local event reports the result of the called PlanetKit API, and the remote event informs what has been triggered by its peer.

Event parameters are event-related data generated by PlanetKit when an event occurs.

G

Group call (Conference)

A call involving three or more users. When three or more users want to communicate, they can hold a group call (conference). Creating a group call means that a room is created. See also: Room.

L

LINE Planet

LINE's VoIP platform. Often LINE Planet refers to LINE Planet Cloud.

LINE Planet Call

The name of the LINE Planet demo app.

M

Meeting ID

A numeric room identifier that can be used to make a group call (conference) with an application that integrates PlanetKit SDK. Users can use this identifier to join meetings from SIP terminal devices such as video conferencing devices.

N

Noise suppressor (NS)

A noise removal filter that classifies all signals except voice as noise and removes them.

P

Participant

A member who joined a group call.

PlanetKit

A client SDK to access LINE Planet servers. Integrating LINE Planet means integrating PlanetKit.

PlanetKit call

A VoIP call through PlanetKit. This call may use a Wi-Fi network or data of mobile network. The data plan that users subscribed to can affect the quality of PlanetKit calls.

R

Room

A virtual venue for a group call.

Room ID

An identifier for a group call (conference) instance. Applications must join with the same room ID to communicate with each other. The formatting rule of room ID is the same as that of user ID.

S

Service ID

A service identifier. LINE Planet can identify services with a service ID. Every application must define its own service ID, which must be formatted as follows:

  • Allowed characters: Letters (a-z, A-Z), digits (0-9), hyphens ('-'), and periods ('.')
  • Maximum length: 64 bytes

Session

A call identification.

SLA key

A key to call LINE Planet APIs (both PlanetKit SDK API and LINE Planet Cloud API). SLA key is not used anymore and has been replaced by API key.

U

User ID

A service subscriber identifier. All user IDs must be unique within the service they belong to. A user ID of LINE Planet must be formatted as follows:

  • Allowed characters: Letters (a-z, A-Z), digits (0-9), hyphens ('-'), and underscores ('_')
  • Maximum length: 64 bytes

V

Voice Quality Enhancement (VQE)

A collection of modules for improving voice quality. Representative modules are AEC, NS, and AGC.

VPIO

Voice processing IO (input/output). VQE module provided by iOS/macOS.

W

WebPlanetKit

PlanetKit for Web