menu
 
버전
2017.1.9.6501

2024.1.3.8749

2023.1.11.8682

2022.1.18.8567

2021.1.14.8108

2019.2.15.7667

2019.1.11.7296

2018.1.11.6987

2017.2.10.6745

2017.1.9.6501

2016.2.6.6153

2015.1.9.5624


menu_open

ak.soundengine.postEvent


Asynchronously post an Event to the sound engine (by event ID). See AK::SoundEngine::PostEvent.

(Required *)

Supported by

Graphical User Interface.

Arguments

Name Type Description
event *   Either the ID (GUID), name, or short ID of the Event.
gameObject * integer The unique ID of the game object.


Arguments Details


event

description : Either the ID (GUID), name, or short ID of the Event.
Possibilities, one of the following :

1) type : string
pattern : ^[a-zA-Z_]+[a-zA-Z_0-9]*$

2) type : string
pattern : ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

3) type : integer
minimum : 0
maximum : 4294967295

gameObject

description : The unique ID of the game object.
type : integer
minimum : 0
maximum : 18446744073709551615


Result

Name Type Description
return * integer The playing ID of the Event launched, or AK_INVALID_PLAYING_ID if posting the event failed.


Result Details


return

description : The playing ID of the Event launched, or AK_INVALID_PLAYING_ID if posting the event failed.
type : integer
minimum : 0
maximum : 4294967295


Examples :

Posting an Event by name

Posts an Event to the sound engine using the Event's name.

Arguments:

{
    "event": "Play_Music", 
    "gameObject": 1122334
}

Result:

{
    "return": 8
}

Posting an Event by short ID

Posts an Event to the sound engine using the Event's short ID.

Arguments:

{
    "event": 2932040671, 
    "gameObject": 1122334
}

Result:

{
    "return": 8
}

Posting an Event by object GUID

Posts an Event to the sound engine using the Event's GUID.

Arguments:

{
    "event": "{FF59687C-48CF-4385-B1C5-CE84B0A63880}", 
    "gameObject": 1122334
}

Result:

{
    "return": 8
}


Detailed JSON Schema


Arguments :

{
    "type": "object", 
    "properties": {
        "event": {
            "description": "Either the ID (GUID), name, or short ID of the Event.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": "^[a-zA-Z_]+[a-zA-Z_0-9]*$"
                }, 
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "integer", 
                    "minimum": 0, 
                    "maximum": 4294967295
                }
            ]
        }, 
        "gameObject": {
            "description": "The unique ID of the game object. ", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 18446744073709551615
        }
    }, 
    "required": [
        "event", 
        "gameObject"
    ], 
    "additionalProperties": false
}


Options :

{
    "type": "object", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}


Response :

{
    "type": "object", 
    "properties": {
        "return": {
            "description": "The playing ID of the Event launched, or \\c AK_INVALID_PLAYING_ID if posting the event failed.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 4294967295
        }
    }, 
    "required": [
        "return"
    ], 
    "additionalProperties": false
}

Document version : 1


이 페이지가 도움이 되었나요?

지원이 필요하신가요?

질문이 있으신가요? 문제를 겪고 계신가요? 더 많은 정보가 필요하신가요? 저희에게 문의해주시면 도와드리겠습니다!

지원 페이지를 방문해 주세요

작업하는 프로젝트에 대해 알려주세요. 언제든지 도와드릴 준비가 되어 있습니다.

프로젝트를 등록하세요. 아무런 조건이나 의무 사항 없이 빠른 시작을 도와드리겠습니다.

Wwise를 시작해 보세요