Version: 5.3

Overview of data and message functions

PlanetKit provides various functions for sending and receiving data and messages other than media streams. The characteristics of the data and message functions provided by PlanetKit are as follows. For more information on each function, refer to the linked documents.

Function	Supported call types and user types	Point of time for usage	Usage examples
App server data	1-to-1 call (caller), group call	During call setup	App server data is data sent from the client to the application server. It can be used primarily for call-related monitoring in the application. For example, if you want to analyze the number of group call participants by application version, you can design the application to include the application version in the app server data and send it.
Sending short data	1-to-1 call (caller, callee), group call	After call setup completion	Using short data transmission, the application can send short messages to call participants with simple steps. If you want to send messages or data at low cost sporadically (for example, at least every 30 seconds) or under specific conditions, use short data transmission. For example, it can be useful in situations where you want to periodically notify participants of a user's status message (away/busy) in a predefined format during a group call. However, since there are restrictions on message length, it is recommended to use data sessions if you need to send long messages. Although internal transactions are managed and several retransmission attempts are made after checking the data transmission result, data transmission reliability is basically not provided.
Contents sharing	1-to-1 call (caller, callee), group call	After call setup completion	Contents sharing is used when a user wants to share data that changes over time with call participants. When data shared using contents sharing changes, an event occurs for the recipients. The shared data can either be individually possessed by each recipient (normal sharing) or exist as a single instance in the room (exclusive sharing, room scope sharing). In the case of exclusive sharing, only the user who requested the contents sharing can modify the data, and in the case of room scope sharing, all group room participants can modify the data. Contents sharing provides information on the time elapsed after the data was updated. The application can utilize this when it needs data based on time changes. For example, if a participant shares video playback (for example, a feature to watch YouTube together) and another participant enters the room later, you can use the elapsed time information provided by the content sharing function to determine what part of the video other participants are currently watching and start playback from that point of time.

Function

Supported call types and user types

Point of time for usage

Usage examples

App server data

1-to-1 call (caller), group call

During call setup

App server data is data sent from the client to the application server. It can be used primarily for call-related monitoring in the application. For example, if you want to analyze the number of group call participants by application version, you can design the application to include the application version in the app server data and send it.

Sending short data

1-to-1 call (caller, callee), group call

After call setup completion

Using short data transmission, the application can send short messages to call participants with simple steps. If you want to send messages or data at low cost sporadically (for example, at least every 30 seconds) or under specific conditions, use short data transmission. For example, it can be useful in situations where you want to periodically notify participants of a user's status message (away/busy) in a predefined format during a group call.

However, since there are restrictions on message length, it is recommended to use data sessions if you need to send long messages. Although internal transactions are managed and several retransmission attempts are made after checking the data transmission result, data transmission reliability is basically not provided.

Contents sharing

1-to-1 call (caller, callee), group call

After call setup completion

Contents sharing is used when a user wants to share data that changes over time with call participants.

When data shared using contents sharing changes, an event occurs for the recipients. The shared data can either be individually possessed by each recipient (normal sharing) or exist as a single instance in the room (exclusive sharing, room scope sharing). In the case of exclusive sharing, only the user who requested the contents sharing can modify the data, and in the case of room scope sharing, all group room participants can modify the data.

Contents sharing provides information on the time elapsed after the data was updated. The application can utilize this when it needs data based on time changes. For example, if a participant shares video playback (for example, a feature to watch YouTube together) and another participant enters the room later, you can use the elapsed time information provided by the content sharing function to determine what part of the video other participants are currently watching and start playback from that point of time.