tencent cloud

Game Multimedia Engine

Release Notes
Product Introduction
Overview
Strengths
Features
Scenarios
Compliance
User Tutorial
Billing
Free Plan
Purchase Guide
SDK Download Guide
Product Feature Demo
Basic Feature Demo
Scenario-Specific Demo
Console Guide
Usage Querying
Activating Services
Getting Started
Quick Integration of SDK
Quick Integration of Sample Project
Basic Feature Development Guide
Authentication Key
Voice Chat Role Configuration
Sound Quality
Advanced Feature Development Guide
Server-Side Recording
Range Voice
3D Sound Effect
Sound Effect and Accompaniment
Network Audio Stream Forwarding Routing
Custom Message Channel
How to deal with the restrictions of corporate firewall
Language Parameter Reference List
Integrating GME Chat Room Management
Client API
SDK for Unity
SDK for Unreal Engine
Cocos2D SDK
SDK for Windows
SDK for iOS
SDK for Android
SDK for macOS
H5 SDK
Electron SDK
SDK for Flutter
SDK Version Upgrade Guide
Error Codes
Toolchain
Server APIs
History
Introduction
API Category
Usage APIs
Recording APIs
Making API Requests
Voice Chat APIs
Application APIs
Data Types
Error Codes
FAQ
Product Features
Troubleshooting Guide
Billing
Sample Project Usage
General
Authentication
Voice Chat Room Entry Failure
Sound and Audio
Network
Speech-to-text Conversion
Program Export
Service Agreement
Service Level Agreement
Contact Us
Glossary
GME Policy
Data Privacy and Security Agreement
Privacy Policy
DocumentationGame Multimedia Engine Client API Electron SDKIntegrating SDK

Integrating SDK

PDF
Focus Mode
Font Size
Last updated: 2024-01-18 15:15:48
This document describes how to configure an Electron project for the GME APIs for Electron.

Supported Platforms

Windows

Importing the SDK

Step 1: Install Node.js

1. Download the latest version of the Node.js installation package Windows Installer (.msi) 64-bit for Windows.
2. Open Node.js command prompt in the application list and open a terminal window.

Step 2. Install Electron

Run the following command in the terminal to install Electron. V4.0.0 or later is recommended.
$ npm install electron -g


Step 3. Install the GME SDK for Electron

1. Use the following npm command in your Electron project to install the GME SDK:
$ npm install gme-electron-sdk@latest --save

2. In the project script, import and use the module:
const { GmeContext } = require('gme-electron-sdk');
// import gmesdk from 'gme-electron-sdk';
gmeContext = new GmeContext();
// Get the SDK version number
gmeContext.GetSDKVersion();


Step 4. Create an executable program

Install the packaging tool. We recommend you use Electron Forge. You can run the following command:
1. Add Electron Forge to your application's development dependencies and run the import command to set the scaffold of Forge:
npm install --save-dev @electron-forge/cli
npx electron-forge import
2. Run the make command of Forge to create a distributable application:
npm run make

Previous Topic: API DocumentationNext Topic: Voice Chat

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback