gobj_pause()

The gobj_pause() function pauses the execution of a given hgobj instance if it is currently playing. If the object is not playing, a warning is logged.

C

Prototype

int gobj_pause(
    hgobj gobj
);

Parameters

Key	Type	Description
gobj	hgobj	The hgobj instance to be paused.

---

Return Value

Returns 0 on success. If the object is not playing, a warning is logged and -1 is returned.

Notes

If the object is already paused, a warning is logged. If the object has a mt_pause method, it is called.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

Examples

C

// TODO C examples

JS

// TODO JS examples

Python

# TODO Python examples