Skip to content

Register callbacks for receiving chat strings

The remote play chat feature can be implemented in such a way that when a user types a string during remote play, it is sent to the host PC's game chat window.

1) When the user enters a string in the text box dedicated to remote play on the web as shown below and presses the enter key, the string is sent to the host PC game. * The maximum input length for remote play is 150 characters, and the reading directions are LTR (Left to Right) and RTL (Right to Left).

2) In host PC games, strings are received through pre-registered callback functions.

3) In host PC games, the corresponding string is passed to the game chat window.

Registering callback functions

To use the chat feature in Remote Play, you need to register a callback function after importing the Remote Play plugin.

Registering a callback function means that the chat feature is ready to be used during remote play, and the game can apply the strings received from remote play to the chat feature according to each game environment.

The string received through the callback function in the game is encoded data in UTF-8 and converted to Base64. Additionally, it includes reading direction information, allowing for multilingual support.

Register a callback function to HiveRemotePlayManager.RegisterCallback as shown below.

using AOT; // MonoPInvokeCallback 때문에 필요

public class {유저 Game에서 사용하는 클래스} : MonoBehaviour {
#if !UNITY_EDITOR && UNITY_STANDALONE_WIN
    [MonoPInvokeCallback (typeof(HiveRemotePlayManager.RemotePlayCallbackType))]
    public static void RegisterRemoteCallbackFunction(int type, string remotePlayJsonData)
    {
        Debug.Log("REMOTE Callback DATA :" + remotePlayJsonData); // RemoteSDK 에서 보내주는 json data 수신.
    }
#endif

    void Start() {
#if !UNITY_EDITOR && UNITY_STANDALONE_WIN
        HiveRemotePlayManager.RegisterCallback(RegisterRemoteCallbackFunction);
#endif
    }
}

Chat string protocol

The protocol for the chat string received through the callback function in the game is as follows.

Web - Client JSON protocol

Key Value Type Description ETC
version version number Json version information Refer to example
eventType eventType string Event type - only Message item exists Refer to example
eventValue eventValue object Event value object Refer to example
eventValue - value eventValue - value string Event value Refer to example
eventValue - action eventValue - action string Event action Refer to example
etc etc object For extension purposes Refer to example

Chat string data example

The chat string received through the callback function in the game has the following JSON data format.

{
    "version"        : "1.0.2411.0",
    "eventType"       : "Message" ,
    "eventValue"     : {
                            "value"  : "Something Message",
                            "action" : "LTR | RTL"
                       },
    "etc"            : { }
}
// value    : Base64  (UTF-8 문장) 인코딩
// action   : LTR (아랍어를 제외한 문자) | RTL (아랍어)