Quick Start for Game Multimedia (AppGallery Connect)

The Game Multimedia Service is a service launched by Huawei Game Center that quickly implements real-time voice intercom and IM chat (Instant Messaging) features in games. You only need to integrate the Game Multimedia Service SDK to provide your games with real-time voice intercom, voice-to-text, instant messaging capabilities, reduce development difficulty, and enhance the player's gaming experience.

Main Features

Operational Mechanism

Clients integrated with the Game Multimedia Service SDK input voice information into the Huawei Game Multimedia Server. The server receives and processes this information, subsequently outputting the voice data to all clients within the room. Simultaneously, the Game Multimedia Service SDK provides an Instant Messaging (IM) feature for message conversations between different clients. By integrating the Game Multimedia Service SDK into your game and conducting simple feature development, you can swiftly build voice chat and instant messaging capabilities for your game.

Version Update Instructions

• Current version:[3.x]1.2.0_14.0.1.300

  • Upgrade the SDK to 14.0.1.300
  • The GameMediaEngine class adds the startDetectAudioFile method, which supports risk control sending of voice message files.

• [3.x]1.1.0_1.13.1.300

  • Upgrade the SDK to 1.13.1.300

• [3.x]1.0.12_1.12.2.300

  • Improve internal implementation
  • Upgrade the SDK to 1.12.2.300

• Version: [3.x] 1.0.7_1.12.1.300

  • Fixed setting microphone callback error

• Version: [3.x] 1.0.6_1.12.1.300

  • Fixed an error reporting the listening channel property change callback
  • Fixed errors when updating other player positions

• Version: [3.x] 0.0.4_1.11.1.300

  • Initial release

Quick Integration of Game Multimedia

Service Activation

• You need to activate the game multimedia feature in the Huawei AGC backend, and turn on the "Voice to Text" and "IM Chat" features. (In addition to manually enabling the IM Chat feature on the AGC console, a secondary application is required, please refer to Service Management).

• Open the project that needs to integrate game multimedia with Cocos Creator.

• Click on the Panel -> Service in the menu bar, open the Service panel, select Game Multimedia in HUAWEI AppGallery Connect, enter the service detail page. Then click the Enable button at the top right to activate the service.

Verify If the Service Is Successfully Activated

• After activation, if you see hwmmsdk related files in the cs-huawei folder under assets in the project, if this folder is not available, please check the log information of the editor console.

• You can refer to the Sample project, initialize, package into "Android" or "HUAWEI AppGallery Connect" platform, run on an Android phone, observe whether the callback can be initialized successfully, if it fails, please check whether the initialization parameters are correct and whether the package name is consistent with the AGC backend.

Sample Project

Developers can quickly experience the online battle service through the Sample project.

• Click the Sample Project button in the analysis service panel, Clone or download HUAWEI Sample Project, and open it in Cocos Creator.

• You need to find the hwmmsdk.ts script and modify the data to the information of the application you created.

• After the Sample project runs on the phone, click the Hwmmsdk button on the homepage to enter the function interface for testing.

Development Guide

All APIs of Game Multimedia are asynchronous callbacks. You can use huawei.game.mmsdk.mmsdkService.once to get a single callback, or use huawei.game.mmsdk.mmsdkService.on to listen to callbacks. You can use huawei.game.mmsdk.mmsdkService.off to remove callbacks.

Request Permissions

requestPermissions(guideUser: boolean, guideUserTipsText?: string, guideUserBtnText?: string): void;

Parameter Description

Code Example:

requestPermissions () {
    huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.requestPermissionsCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
        console.log(result);
    })
    this.mmsdkService.requestPermissions(true, "Permission is required to use this feature", "Go to enable");
}

Initialization (Instance Creation)

Guide

init(info: {
    openId: string;
    agcAppId: string;
    agcClientId: string;
    agcClientSecret: string;
    agcApiKey: string;
    logEnable: boolean;
    logSize: number;
    countryCode: string;
    useSign: boolean;
    sign: string;
    nonce: string;
    timeStamp: string;
}): void;

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.initCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
let info = {
    openId: "",
    agcAppId: "",
    agcClientId: "",
    agcClientSecret: "",
    agcApiKey: "",
    logEnable: true,
    logSize: 10240,
    countryCode: "CN",
    useSign: false,
    sign: "",
    nonce: "",
    timeStamp: "",
}
this.mmsdkService.init(info);

Destroy instance

destroy(): void;

Guide

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onDestroyCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.destroy();

Real-time vocal

Join the Team Room

joinTeamRoom(roomId: string): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onJoinTeamRoomCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.joinTeamRoom("XXX");

Join the National War Room

joinNationalRoom(roomId: string, roleType: number): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onJoinNationalRoomCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.joinNationalRoom("XXX", 1);

Switch Room

switchRoom(roomId: string): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onSwitchRoomCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.switchRoom("XXX");

Transfer Room Owner Identity

transferOwner(roomId: string, ownerId: string): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onTransferOwnerCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.transferOwner("XXX", "XXX");

Get Specific Room Information

getRoom (roomId: string): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.getRoomCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
      console.log(result);
})
huawei.game.mmsdk.mmsdkService.getRoom("XXX");

Leave Room

leaveRoom (roomId: string, ownerId?: string): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onLeaveRoomCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.leaveRoom("XXX", null);

Set Microphone Status

enableMic (isEnabled: boolean): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.enableMicCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.enableMic(true);

Mute/Unmute Specific Player

forbidPlayer (roomId: string, openId: string, isForbidden: boolean): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onForbidPlayerCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
      console.log(result);
  })
huawei.game.mmsdk.mmsdkService.forbidPlayer("XXX", "XXX", true);

Mute/Unmute All Players

forbidAllPlayers (roomId: string, isForbidden: boolean): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onForbidAllPlayersCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
      console.log(result);
  })
huawei.game.mmsdk.mmsdkService.forbidAllPlayers("XXX",true);

Block/Unblock Specific Player's Voice

mutePlayer (roomId: string, openId: string, isMuted: boolean): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onMutePlayerCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.mutePlayer("XXX", "XXX", true);

Block/Unblock Other All Players' Voice

muteAllPlayers (roomId: string, isMuted: boolean): void;

Guide

Parameter Description

Code Example

 huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onMuteAllPlayersCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.muteAllPlayers(this._teamRoomId, true);

Get Current Speaking Players List

Guide

enableSpeakersDetection (roomId: string, interval: number): void;

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.enableSpeakersDetection("XXX", 1000);

Initialize 3D Sound Effect

initSpatialSound (): void;

Guide

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.initSpatialSoundCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.initSpatialSound();

Enable/Disable 3D Sound Effect

enableSpatialSound (roomId: string, enable: boolean): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.enableSpatialSoundCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.enableSpatialSound("XXX", true);

Set Voice Receiving Range

setAudioRecvRange (range: number): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.setAudioRecvRangeCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.setAudioRecvRange(10);

Update Self Position

updateSelfPosition (forward: number, right: number, up: number): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.updateSelfPositionCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.updateSelfPosition(1, 2, 3);

Update Other Player's Position

updateRemotePosition (openId: string, forward: number, right: number, up: number): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.updateRemotePositionCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.updateRemotePosition("XXX", 1, 2, 3);

Clear Other Player's Position

clearRemotePlayerPosition (openId: string): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.clearRemotePlayerPositionCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
      console.log(result);
})
huawei.game.mmsdk.mmsdkService.clearRemotePlayerPosition("XXX");

Clear Other All Players' Position Information

clearAllRemotePositions (): void;

Guide

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.clearAllRemotePositionsCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.clearAllRemotePositions();

Query 3D Sound Effect On State

isEnableSpatialSound (roomId: string): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.isEnableSpatialSoundCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.isEnableSpatialSound("XXX");

Turn on/off voice changes

enableVoiceConversion (roomId: string, voiceType: number): int;

Guide

Parameter Description

Code Example

let result = huawei.game.mmsdk.mmsdkService.enableVoiceConversion(this._teamRoomId, huawei.game.mmsdk.VoiceType.LOLITA);

Query the type of sound change

getVoiceConversionType (roomId: string): int;

Guide

Parameter Description

Code Example

let result = huawei.game.mmsdk.mmsdkService.getVoiceConversionType(this._teamRoomId);

Test the sound effect

enableEarsBack (enable: boolean): int;

Guide

Parameter Description

Code Example

let result = huawei.game.mmsdk.mmsdkService.enableEarsBack(true);

Check the status of the in-ear monitors

isEarsBackEnable (): boolean;

Guide

Code Example

let result = huawei.game.mmsdk.mmsdkService.isEarsBackEnable();

Join Range Voice Room

joinRangeRoom (roomId: string): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onJoinRangeRoomCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.joinRangeRoom("XXX");

Real-time Signaling

Peer-to-peer Send Message

publishRtmPeerMessage ({peerId: string, type: number, messageString: string, messageByte: Uint8Array}): void

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onPublishRtmPeerMessageCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.publishRtmPeerMessage(this._selfOpenId == "A" ? "B" : "A", 1, "xxxxx");

Subscribe Channel

subscribeRtmChannel (channelId: string, playerProperties: {}): void

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onSubscribeRtmChannelCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.subscribeRtmChannel("123", {name: "xxxxx", age: "18"});

Cancel Channel

unSubscribeRtmChannel (channelId: string): void

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onUnSubscribeRtmChannelCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.unSubscribeRtmChannel("123");

Publish Channel Message

publishRtmChannelMessage (jsonInfo: {
    channelId: string,
    messageType: number,
    allowCacheMsg: boolean,
    contentIdentify: boolean,
    adsIdentify: boolean,
    messageString: string,
    messageBytes: Uint8Array,
    receivers: string[],
}): void`

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onPublishRtmChannelMessageCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.publishRtmChannelMessage({
    channelId: "123",
    messageType: 1,
    allowCacheMsg: true,
    contentIdentify: true,
    adsIdentify: true,
    messageString: "xxxxx",
    receivers: ["A", "B"]
});

Establish Player Properties

setRtmChannelPlayerProperties (channelId: string, playerProperties: {}): void

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onSetRtmChannelPlayerPropertiesCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.setRtmChannelPlayerProperties("123", {name: "xxxxx", age: "18"});

Query Player Properties

getRtmChannelPlayerProperties (channelId: string, openIds: string[])

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onGetRtmChannelPlayerPropertiesCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.getRtmChannelPlayerProperties("123", ["A"]);

Delete Player Properties

deleteRtmChannelPlayerProperties (channelId: string, keys: string[]): void

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onDeleteRtmChannelPlayerPropertiesCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.deleteRtmChannelPlayerProperties("123", ["name", "age"]);

Establish Channel Properties

setRtmChannelPlayerProperties (channelId: string, playerProperties: {}): void

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onSetRtmChannelPropertiesCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.setRtmChannelProperties("123", {name: "xxxxx", age: "18"});

Query Channel Properties

getRtmChannelProperties (channelId: string): void

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onGetRtmChannelPropertiesCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.getRtmChannelProperties("123");

Delete Channel Properties

deleteRtmChannelProperties (channelId: string, keys: string[])

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onDeleteRtmChannelPropertiesCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.deleteRtmChannelProperties("123", ["name", "age"]);

Query Channel Details

getRtmChannelInfo (channelId: string, returnMembers: boolean): void

Guide

Parameter Description

Code Example

 huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onGetRtmChannelInfoCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.getRtmChannelInfo("123", true);

Query Subscribed Channel List

getRtmSubscribedChannelInfo ():void

Guide

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onGetRtmSubscribedChannelInfoCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.getRtmSubscribedChannelInfo();

Query Channel Historical Messages

getRtmChannelHistoryMessages (channelId: string, startTime: number, count: number): void

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onGetRtmChannelHistoryMessagesCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
});
huawei.game.mmsdk.mmsdkService.getRtmChannelHistoryMessages("123", 1700119845015, 10);

Voice Messages

Record Voice

startRecordAudioMsg (): void;

Guide

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.startRecordAudioMsgCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
})
huawei.game.mmsdk.mmsdkService.startRecordAudioMsg();

Stop Recording Voice

stopRecordAudioMsg (): void;

Guide

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onRecordAudioMsgCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    this.console.log(result);
})
huawei.game.mmsdk.mmsdkService.stopRecordAudioMsg();

Upload Audio File to Game Multimedia Server

uploadAudioMsgFile (filePath: string, msTimeOut: number): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onUploadAudioMsgFileCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.uploadAudioMsgFile("XXX", 5000);

Download Audio File

downloadAudioMsgFile (fileId: string, filePath: string, msTimeOut: number): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onDownloadAudioMsgFileCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.downloadAudioMsgFile("XXX", "XXX", 3000);

Detect Audio File

startDetectAudioFile (fileId: string): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onStartDetectAudioFileCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.startDetectAudioFile("XXX");

Play Voice Message

playAudioMsg (filePath: string): void;

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onPlayAudioMsgCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.playAudioMsg("XXX");

Stop Playing Voice Message

stopPlayAudioMsg (): void;

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onPlayAudioMsgCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.stopPlayAudioMsg();

Obtain Audio File Information

getAudioMsgFileInfo (filePath: string): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.getAudioMsgFileInfoCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.getAudioMsgFileInfo(filePath);

Initiation of sound effect playback.

Play

playLocalAudioClip (soundId: number, volume: number, filePath: string, loop: number): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.playLocalAudioClip(1, 100, "http://music.163.com/song/media/outer/url?id=25906124.mp3", 1);

Pause

pauseLocalAudioClip (soundId: number): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.pauseLocalAudioClip(1);

Pause all local audio clips

pauseAllLocalAudioClips (): void;

Guide

Code Example

huawei.game.mmsdk.mmsdkService.pauseAllLocalAudioClips();

Resume

resumeLocalAudioClip (soundId: number): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.resumeLocalAudioClip(1);

Resume all local audio clips

resumeAllLocalAudioClips (): void;

Guide

Code Example

huawei.game.mmsdk.mmsdkService.resumeAllLocalAudioClips();

Stop

stopLocalAudioClip (soundId: number): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.stopLocalAudioClip(1);

Stop all local audio clips

stopAllLocalAudioClips (): void;

Guide

Code Example

huawei.game.mmsdk.mmsdkService.stopAllLocalAudioClips();

Designate the volume coefficient for a specific sound effect or for all sound effects.

setVolumeOfLocalAudioClip (soundId: number, volume: number): void;

Guide

Parameter Description

Code Example

    huawei.game.mmsdk.mmsdkService.setVolumeOfLocalAudioClip(1, 50);

Establish the volume coefficient for all local sound effects

setVolumeOfLocalAudioClip (volume: number): void;

Guide

Parameter Description

Code Example

huawei.game.mmsdk.mmsdkService.setLocalAudioClipsVolume(80);

Procure the volume coefficient of a specified sound effect or all sound effects.

getVolumeOfLocalAudioClip (soundId: number): void;

Guide

Parameter Description

Code Example

    huawei.game.mmsdk.mmsdkService.getVolumeOfLocalAudioClip(1);

Acquire the volume coefficient of all local sound effects.

getLocalAudioClipsVolume (): void;

Guide

Code Example

huawei.game.mmsdk.mmsdkService.getLocalAudioClipsVolume();

Speech to Text

Speech to Text - Start Recording

startRecordAudioToText (language: string): void;

Parameter explanation

Code example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.startRecordAudioToTextCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log("Recording, please speak...")
})
huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onVoiceToTextCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.startRecordAudioToText("zh");

Speech to Text - Stop Recording

stopRecordAudioToText (): void;

Code example

huawei.game.mmsdk.mmsdkService.once(huawei.game.mmsdk.API_EVENT_LIST.onVoiceToTextCallback, (result: huawei.game.mmsdk.ApiCbResult) => {
    console.log(result);
})
huawei.game.mmsdk.mmsdkService.stopRecordAudioToText();

Others

For a detailed function description, please refer to Game Multimedia - Guide.