SkyWay SDK Documentation

The SkyWay Channel API allows server-side creation and retrieval of SkyWay Channels. It is compliant with the JSON-RPC 2.0 specification.

Deprecation Notice: This API is deprecated. Users are encouraged to migrate to the SkyWay Room API.

SkyWay Recording allows you to record audio and video transmitted via an SFU and upload the generated files to a specified cloud storage. To use this feature, you must interact with the Recording API (REST API) from your own server.

Key Technical Specifications:

• Base URL: https://recording.skyway.ntt.com
• Supported File Format: WebM
• Supported Codecs: VP8, H264, OPUS (DTX is enabled by default).
• Communication Mode: Supports communication where media data passes through an SFU. For P2P Room calls, a recording-specific SFU Room must be used simultaneously.

The SkyWay JavaScript SDK for web applications consists of two primary libraries:

• Room Library: Provides access to all SkyWay features for real-time communication.
• Token Library: A utility library used to generate authentication and authorization tokens. Note: This library uses secret keys and should be handled with caution when used in frontend environments.

skyway_ros_bridge is an open-source reference implementation of a ROS node using the SkyWay Linux SDK. It enables real-time bidirectional communication between SkyWay and ROS topics:

• SkyWay VideoStream $\leftrightarrow$ ROS sensor_msgs/Image or sensor_msgs/CompressedImage topics
• SkyWay DataStream $\leftrightarrow$ ROS std_msgs/String topics

SkyWay STT allows developers to transcribe voice calls in real-time using a dedicated library. Key features include:

• Real-time processing: Low-latency transcription delivered at the end of each speech segment.
• Speaker Identification: Transcription results are linked to the specific speaker.
• Translation: Ability to obtain both the original transcription and a translation into a specified language.
• Archiving: Session transcriptions can be saved as JSONL files to cloud storage after the session ends.

For users on the Free plan, this feature must be requested via the project details in the SkyWay Console. Note that end-user consent is required for transcription per SkyWay Terms of Service Article 36.

SkyWay uses token-based authentication and authorization to ensure end-users can only perform permitted operations. The typical flow is:

1. The end-user sends authentication credentials (e.g., session token, password) to the application's backend server.
2. The backend server authenticates the user.
3. The backend server generates a SkyWay Auth Token with permissions appropriate for that user.
4. The backend server sends the token to the frontend application.
5. The frontend application configures the SkyWay SDK with the token for subsequent requests.

To prevent tampering, tokens must be signed using a secret key obtained from the SkyWay Console application list screen.

SkyWay Webhooks allow users to receive real-time event notifications via HTTP requests sent from SkyWay to a user-specified server. This eliminates the need for polling APIs to track state changes. Supported events include:

• Room events: Room creation, member joining/leaving, Stream publishing, and Publication subscribing.
• Recording events: Start and end of audio/video recording sessions.