ak.soundengine.seekOnEvent

Seek inside all playing objects that are referenced in Play Actions of the specified Event. See AK::SoundEngine::SeekOnEvent.

(Required *)

Supported by

Graphical User Interface.

Arguments

Name	Type	Description
event		Either the ID (GUID), name, or short ID of the Event.
gameObject	integer	Associated game object ID; use `AK_INVALID_GAME_OBJECT` to affect all game objects.
position	integer	Desired position where playback should restart, in milliseconds.
percent	number	Desired position where playback should restart, expressed in a percentage of the file's total duration, between 0 and 1.f. See note above about infinite looping sounds.
seekToNearestMarker	boolean	If true, the final seeking position will be made equal to the nearest marker.
playingId	integer	Specify the playing ID for the seek to be applied to. Will result in the seek happening only on active actions of the playing ID. Use `AK_INVALID_PLAYING_ID` or nothing, to seek on all active Actions of this Event ID.

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 : Associated game object ID; use AK_INVALID_GAME_OBJECT to affect all game objects.
type : integer
minimum : 0
maximum : 18446744073709551615

position

description : Desired position where playback should restart, in milliseconds.
type : integer
minimum : -2147483648
maximum : 2147483647

percent

type : number
description : Desired position where playback should restart, expressed in a percentage of the file's total duration, between 0 and 1.f. See note above about infinite looping sounds.

seekToNearestMarker

type : boolean
description : If true, the final seeking position will be made equal to the nearest marker.

playingId

description : Specify the playing ID for the seek to be applied to. Will result in the seek happening only on active actions of the playing ID. Use AK_INVALID_PLAYING_ID or nothing, to seek on all active Actions of this Event ID.
type : integer
minimum : 0
maximum : 4294967295

Examples :

Seeking to position 1 s

Seeks on "gameObject" referenced in the Play Action of "event" at 1 second.

Arguments:

{
    "event": "MyEventName", 
    "gameObject": 1122334, 
    "position": 1000, 
    "seekToNearestMarker": false, 
    "playingId": 0
}

Seeking to 35% of duration

Seeks on "gameObject" referenced in the Play Action of "event" at 35% of the duration.

Arguments:

{
    "event": 5566123, 
    "gameObject": 1122334, 
    "percent": 0.35, 
    "seekToNearestMarker": false, 
    "playingId": 321654
}

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": "Associated game object ID; use <tt>AK_INVALID_GAME_OBJECT</tt> to affect all game objects.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 18446744073709551615
        }, 
        "position": {
            "description": "Desired position where playback should restart, in milliseconds.", 
            "type": "integer", 
            "minimum": -2147483648, 
            "maximum": 2147483647
        }, 
        "percent": {
            "type": "number", 
            "description": "Desired position where playback should restart, expressed in a percentage of the file's total duration, between 0 and 1.f. See note above about infinite looping sounds."
        }, 
        "seekToNearestMarker": {
            "type": "boolean", 
            "description": "If true, the final seeking position will be made equal to the nearest marker."
        }, 
        "playingId": {
            "description": "Specify the playing ID for the seek to be applied to. Will result in the seek happening only on active actions of the playing ID. Use \\c AK_INVALID_PLAYING_ID or nothing, to seek on all active Actions of this Event ID.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 4294967295
        }
    }, 
    "oneOf": [
        {
            "required": [
                "event", 
                "gameObject", 
                "position", 
                "seekToNearestMarker", 
                "playingId"
            ]
        }, 
        {
            "required": [
                "event", 
                "gameObject", 
                "percent", 
                "seekToNearestMarker", 
                "playingId"
            ]
        }
    ], 
    "additionalProperties": false
}

Options :

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

Response :

{
    "type": "object", 
    "properties": {}, 
    "additionalProperties": false
}

Document version : 1

このページはお役に立ちましたか？

サポートは必要ですか？

ご質問や問題、ご不明点はございますか？お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう

Wwise SDK 2017.1.9